IPeoplePickerProps
3p-core / IPeoplePickerProps
Interface: IPeoplePickerProps
Props for the PeoplePicker component.
Properties
| Property | Type | Description |
|---|---|---|
className? | string | Optional CSS class to apply to the root picker container. |
disabled? | boolean | Disables interaction with the picker when set to true. |
filterGroupId? | number | Optional SharePoint group ID to filter user results. |
inputProps? | IInputProps | Optional overrides for the input element props (e.g., placeholder, ARIA attributes). |
maximumSuggestion? | number | Maximum number of suggestions to display in the dropdown. Default 5 |
selectedUsers | IPeoplePickerUser[] | Array of currently selected users. |
selectionLimit? | number | Maximum number of users that can be selected. Default 1000 |
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. |