Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added defaults to PeoplePicker doc #159

Closed
wants to merge 2 commits into from
Closed

Added defaults to PeoplePicker doc #159

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
adc9f7b
Added defaults to PoeplePicker doc
sympmarc Oct 23, 2018
96cf874
Update PeoplePicker.md
sympmarc Oct 25, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 9 additions & 8 deletions docs/documentation/docs/controls/PeoplePicker.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,25 +52,26 @@ private _getPeoplePickerItems(items: any[]) {

The People picker control can be configured with the following properties:

| Property | Type | Required | Description |
| ---- | ---- | ---- | ---- |
| Property | Type | Required | Description | Default |
| ---- | ---- | ---- | ---- | ---- |
| context | WebPartContext | yes | Context of the current web part. |
| titleText | string | yes | Text to be displayed on the control |
| groupName | string | no | group from which users are fetched. Leave it blank if need to filter all users |
| personSelectionLimit | number | no | Defines the limit of people that can be selected in the control|
| isRequired | boolean | no | Set if the control is required or not |
| disabled | boolean | no | Set if the control is disabled or not |
| personSelectionLimit | number | no | Defines the limit of people that can be selected in the control| 1 |
| isRequired | boolean | no | Set if the control is required or not | false |
| disabled | boolean | no | Set if the control is disabled or not | false |
| errorMessage | string | no | Specify the error message to display |
| errorMessageclassName | string | no | applies custom styling to the error message section|
| showtooltip | boolean | no | Defines if need a tooltip or not |
| showtooltip | boolean | no | Defines if need a tooltip or not | false |
| tooltip | string | no | Specify the tooltip message to display |
| tooltipDirectional | DirectionalHint | no | Direction where the tooltip would be shown |
| selectedItems | function | no | get the selected users in the control |
| peoplePickerWPclassName | string | no | applies custom styling to the people picker element |
| peoplePickerCntrlclassName | string | no | applies custom styling to the people picker control only |
| defaultSelectedUsers | string[] | no | Default selected user emails |
| webAbsoluteUrl | string | no | Specify the site URL on which you want to perform the user query call. Default is the current site URL. |
| showHiddenInUI | boolean | no | Show users which are hidden from the UI. By default these users/groups hidden for the UI will not be shown. |
| webAbsoluteUrl | string | no | Specify the site URL on which you want to perform the user query call. | Current site URL |
| 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 |
| suggestionsLimit | number | no | Maximum number of suggestions to show in the full suggestion list | 5 |
| principleTypes | PrincipleType[] | no | Define which type of data you want to retrieve: User, SharePoint groups, Security groups. Multiple are possible. |

Enum `PrincipalType`
Expand Down