Interface IPeoplePickerProps

People Picker Properties

Hierarchy

  • IPeoplePickerProps

Properties

allowGroups? assignTo? className? disabled? el? groupId? label? maxResults? minCharSearch? multi? onChange? placeholder? readOnly? searchLocal? searchUrl? value?

Properties

Optional allowGroups

allowGroups?: boolean

True, to include groups in the results.

Optional assignTo

assignTo?: ((obj) => void)

Type declaration

    • (obj): void

    • Assigns the object to the input parameter.

      Parameters

      Returns void

Optional className

className?: string

The class name to apply to the element.

Optional disabled

disabled?: boolean

True to disable the component.

Optional el

el?: HTMLElement

The element to render the form to.

Optional groupId

groupId?: number

The specific SharePoint group id to search within.

Optional label

label?: string

The label.

Optional maxResults

maxResults?: number

Limits the results to a maximum number.

Optional minCharSearch

minCharSearch?: number

The minimum number of characters to enter before search occurs.

Optional multi

multi?: boolean

True to allow multiple users to be selected.

Optional onChange

onChange?: ((obj) => void)

Type declaration

    • (obj): void

    • The change event.

      Parameters

      • obj: IPeoplePickerUser[]

      Returns void

Optional placeholder

placeholder?: string

The placeholder text. (Default value is "Search")

Optional readOnly

readOnly?: boolean

True to make the component read-only.

Optional searchLocal

searchLocal?: boolean

True to search the local users first.

Optional searchUrl

searchUrl?: string

The url to search for for users.

Optional value

value?: string | number | IPeoplePickerUser | (string | number | IPeoplePickerUser)[]

The selected users.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc