IComboBoxPeoplePickerProps
@spartanfx/react / IComboBoxPeoplePickerProps
Interface: IComboBoxPeoplePickerProps
Props for the ComboBoxPeoplePicker component, which renders a Fluent UI ComboBox
allowing users to select one or more people from SharePoint groups or predefined lists.
Properties
| Property | Type | Description |
|---|---|---|
allowedUsers? | ISiteUserInfo[] | Optional filter: restricts selection to a defined subset of users. |
controlProps? | Partial<IComboBoxProps> | Optional additional ComboBox props passed directly to the Fluent UI component. |
disabledUsers? | ISiteUserInfo[] | Optional filter: disables selection for these users. |
inlineLabel? | boolean | If true, displays the label inline (not currently used). |
label? | string | Optional label to describe the field (not rendered by default in this component). |
multiSelect? | boolean | Enables multi-select behavior in the ComboBox. Default is single-select. |
onChange | (newValue, oldValue) => any | Triggered when the selected users change. |
required? | boolean | Marks the control as required (not currently used in logic). |
selectedPeoples | IComboBoxPeoplePickerUserProps | IComboBoxPeoplePickerUserProps[] | The current selected people. Can be a single user or an array of users. |
sourceGroups? | string[] | number[] | List of SharePoint group IDs or names to pull users from. |
sp | SPFI | SPFI instance from @pnp/sp used for SharePoint data access. |
webPartContext | WebPartContext | Current web part context, used for constructing URLs and resolving user photos. |