IListFormComboBoxPeoplePickerProps
@spartanfx/react v1.2.2
@spartanfx/react / spfx / IListFormComboBoxPeoplePickerProps
Interface: IListFormComboBoxPeoplePickerProps
Props for the ListFormComboBoxPeoplePicker component.
Extends IListFormFieldRendererProps to integrate with the SharePoint List Form framework.
Extends
Properties
Required
| Property | Type | Description |
|---|
field | IFieldInfo | The SharePoint field definition object. |
formStateKey | string | The key used in the form state object, matching the field's internal name. |
listFormContext | IListFormContext | The full list form context for accessing state, validation, etc. |
Options
| Property | Type | Description |
|---|
allowedUsers? | ISiteUserInfo[] | Optional list of users allowed to be selected. If provided, filters the available users. |
disabled? | boolean | Whether the field is disabled. Overrides form-level settings. |
disabledUsers? | ISiteUserInfo[] | Optional list of users that should be disabled (non-selectable) in the picker UI. |
inlineLabel? | boolean | Whether the field label should be displayed inline with the picker. |
readonly? | boolean | If true, renders the field in readonly mode without user interaction. |
required? | boolean | Whether the field is required. |
sourceGroups? | string[] | number[] | SharePoint group IDs or names to restrict the user selection source. If specified, only users in these groups can be selected. |
Events & callbacks
| Property | Type | Description |
|---|
onChange? | (newValue, oldValue?) => void | Optional callback triggered when the field value changes. |
Advanced & escape hatches
| Property | Type | Description |
|---|
controlProps? | any | Props passed directly to the underlying field control. |