PeoplePicker

Shows a people picker who suggests people as you write.

Interface

interface IPeoplePickerField extends IBaseField {
  value?: IPerson | IPerson[];
  allowDuplicate?: boolean;
  principalTypeUser?: boolean;
  principalTypeSharePointGroup?: boolean;
  principalTypeSecurityGroup?: boolean;
  principalTypeDistributionList?: boolean;
  numberOfItems?: number;
  minLengthKeyPress?: number;
}

Example

{
  "name": "owners",
  "type": "PeoplePicker",
  "label": {
    "t": "forms.owners"
  },
  "description": {
    "t": "forms.ownersDescription"
  },
  "minLengthKeyPress": 0,
  "principalTypeDistributionList": false,
  "principalTypeSecurityGroup": true,
  "principalTypeSharePointGroup": false
}

Properties

type

Must be “PeoplePicker”.

• Type: "PeoplePicker"

• Required: Yes

value

Default value of the person.

• Type: IPerson|IPerson[]

• Required: No

allowDuplicate

If true, the same person or group can be selected more than once.

• Type: boolean

• Required: No

• Default value: false

principalTypeUser

If true, allows you to select people.

• Type: boolean

• Required: No

• Default value: true

principalTypeSharePointGroup

If true, allows you to select SharePoint Group.

• Type: boolean

• Required: No

• Default value: false

principalTypeSecurityGroup

If true, allows you to select Security Group.

• Type: boolean

• Required: No

• Default value: false

numberOfItems

Maximum number of people or groups that can be selected.

• Type: number

• Required: No

• Default value: 10

minLengthKeyPress

Minimum number of characters to type for the control to start suggesting people or groups.

• Type: number

• Required: No

• Default value: 2