IListFormComboBoxPeoplePickerProps
@spartanfx/react / spfx / IListFormComboBoxPeoplePickerProps
Interface: IListFormComboBoxPeoplePickerProps
Props for the ListFormComboBoxPeoplePicker component.
Extends IListFormFieldRendererProps to integrate with the SharePoint List Form framework.
Extends
Properties
| Property | Type | Description | Inherited from |
|---|---|---|---|
allowedUsers? | ISiteUserInfo[] | Optional list of users allowed to be selected. If provided, filters the available users. | - |
controlProps? | any | Props passed directly to the underlying field control. | IListFormFieldRendererProps.controlProps |
disabled? | boolean | Whether the field is disabled. Overrides form-level settings. | IListFormFieldRendererProps.disabled |
disabledUsers? | ISiteUserInfo[] | Optional list of users that should be disabled (non-selectable) in the picker UI. | - |
field | IFieldInfo | The SharePoint field definition object. | IListFormFieldRendererProps.field |
formStateKey | string | The key used in the form state object, matching the field's internal name. | IListFormFieldRendererProps.formStateKey |
inlineLabel? | boolean | Whether the field label should be displayed inline with the picker. | - |
listFormContext | IListFormContext | The full list form context for accessing state, validation, etc. | IListFormFieldRendererProps.listFormContext |
onChange? | (newValue, oldValue?) => void | Optional callback triggered when the field value changes. | IListFormFieldRendererProps.onChange |
readonly? | boolean | If true, renders the field in readonly mode without user interaction. | IListFormFieldRendererProps.readonly |
required? | boolean | Whether the field is required. | IListFormFieldRendererProps.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. | - |