@spartanfx/react v1.2.2
@spartanfx/react / spfx / IPeoplePickerProps
Interface: IPeoplePickerProps
Props for the PeoplePicker component.
Properties
Required
| Property | Type | Default | Description |
|---|
selectedUsers | IPeoplePickerUser[] | - | Array of currently selected users. |
setSelectedUsers | (users) => void | - | Callback to update selected users when the picker selection changes. |
sp | SPFI | - | PnPjs SPFI instance for interacting with the SharePoint REST API. |
webPartContext | WebPartContext | - | SPFx web part context used to determine the current site and resolve user photo URLs. |
Options
| Property | Type | Default | Description |
|---|
disabled? | boolean | - | Disables interaction with the picker when set to true. |
filterGroupId? | number | - | Optional SharePoint group ID to filter user results. |
maximumSuggestion? | number | 5 | Maximum number of suggestions to display in the dropdown. |
selectionLimit? | number | 1000 | Maximum number of users that can be selected. |
Appearance & theming
| Property | Type | Default | Description |
|---|
className? | string | - | Optional CSS class to apply to the root picker container. |
Advanced & escape hatches
| Property | Type | Default | Description |
|---|
inputProps? | IInputProps | - | Optional overrides for the input element props (e.g., placeholder, ARIA attributes). |