alfresco-ng2-components/docs/people-search.component.md

51 lines
1.1 KiB
Markdown

# People Search component
Searches users/people.
<!-- markdown-toc start - Don't edit this section. npm run toc to generate it-->
<!-- toc -->
- [Basic Usage](#basic-usage)
* [Properties](#properties)
* [Events](#events)
- [Details](#details)
<!-- tocstop -->
<!-- markdown-toc end -->
## Basic Usage
```html
<adf-people-search></adf-people-search>
```
### Properties
| Name | Type | Description |
| --- | --- | --- |
| results | Observable<User[]> | The params to show people list |
### Events
| Name | Description |
| --- | --- |
| searchPeople | Raised when the search people with new keyword |
| success | Raised when select the user and click action button |
| closeSearch | Raised when click the clse button |
## Details
```html
<adf-people-search
(searchPeople)="searchUser($event)"
(success)="involveUser($event)"
(closeSearch)="onCloseSearch()"
[results]="peopleSearch$">
<header-title>{{ 'TASK_DETAILS.LABELS.ADD_PEOPLE' | translate }}</header-title>
<action-button-label>{{ 'PEOPLE.ADD_USER' | translate }}</action-button-label>
</adf-people-search>
```