Skip to content

Commit 96da734

Browse files
committed
Merge branch 'AsishP-ap-peoplepicker2611' into dev
2 parents 9cc1559 + 94654e1 commit 96da734

File tree

13 files changed

+17867
-363
lines changed

13 files changed

+17867
-363
lines changed

docs/documentation/docs/controls/PeoplePicker.md

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,8 @@ import { PeoplePicker, PrincipalType } from "@pnp/spfx-controls-react/lib/People
3737
disabled={true}
3838
selectedItems={this._getPeoplePickerItems}
3939
showHiddenInUI={false}
40-
principleTypes={[PrincipalType.User]} />
40+
principalTypes={[PrincipalType.User]}
41+
resolveDelay={1000} />
4142
```
4243

4344
- With the `selectedItems` property you can get the selected People in the Peoplepicker :
@@ -63,26 +64,27 @@ The People picker control can be configured with the following properties:
6364
| errorMessage | string | no | Specify the error message to display | |
6465
| errorMessageClassName | string | no | applies custom styling to the error message section | |
6566
| showtooltip | boolean | no | Defines if need a tooltip or not | false |
66-
| tooltip | string | no | Specify the tooltip message to display | |
67+
| tooltipMessage | string | no | Specify the tooltip message to display | |
6768
| tooltipDirectional | DirectionalHint | no | Direction where the tooltip would be shown | |
68-
| selectedItems | function | no | get the selected users in the control | |
69+
| selectedItems | (items: IPersonaProps[]) => void | no | Get the selected users in the control. | |
6970
| peoplePickerWPclassName | string | no | applies custom styling to the people picker element | |
7071
| peoplePickerCntrlclassName | string | no | applies custom styling to the people picker control only | |
71-
| defaultSelectedUsers | string[] | no | Default selected user emails | |
72-
| webAbsoluteUrl | string | no | Specify the site URL on which you want to perform the user query call. | Current site URL |
72+
| defaultSelectedUsers | string[] | no | Default selected user emails or login names | |
73+
| webAbsoluteUrl | string | no | Specify the site URL on which you want to perform the user query call. If not provided, the people picker will perform a tenant wide people/group search. When provided it will search users/groups on the provided site. | |
7374
| showHiddenInUI | boolean | no | Show users which are hidden from the UI. By default these users/groups hidden for the UI will not be shown. | false |
74-
| principleTypes | PrincipleType[] | no | Define which type of data you want to retrieve: User, SharePoint groups, Security groups. Multiple are possible. | |
75+
| principalTypes | PrincipalType[] | no | Define which type of data you want to retrieve: User, SharePoint groups, Security groups. Multiple are possible. | |
7576
| suggestionsLimit | number | no | Maximum number of suggestions to show in the full suggestion list. | 5 |
77+
| resolveDelay | number | no | Add delay to resolve and search users | 200 |
7678

7779
Enum `PrincipalType`
7880

7981
The `PrincipalType` enum can be used to specify the types of information you want to query: User, Security groups, and/or SharePoint groups.
8082

81-
| Name |
82-
| ---- |
83-
| User |
84-
| DistributionList |
85-
| SecurityGroup |
86-
| SharePointGroup |
83+
| Name | Value |
84+
| ---- | -- -- |
85+
| User | 1 |
86+
| DistributionList | 2 |
87+
| SecurityGroup | 4 |
88+
| SharePointGroup | 8 |
8789

8890
![](https://telemetry.sharepointpnp.com/sp-dev-fx-controls-react/wiki/controls/PeoplePicker)

0 commit comments

Comments
 (0)