mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-05-12 17:04:57 +00:00
60 lines
2.0 KiB
Markdown
60 lines
2.0 KiB
Markdown
---
|
|
Title: People Search component
|
|
Added: v2.0.0
|
|
Status: Active
|
|
Last reviewed: 2018-11-14
|
|
---
|
|
|
|
# People Search Component
|
|
|
|
Searches users/people.
|
|
|
|
## Basic Usage
|
|
|
|
```html
|
|
<adf-people-search></adf-people-search>
|
|
```
|
|
|
|
### [Transclusions](../../user-guide/transclusion.md)
|
|
|
|
You can provide a title for the search header and a label for the action button using
|
|
special subcomponents in the body of the `<adf-people-search>` element:
|
|
|
|
```html
|
|
<adf-people-search>
|
|
<header-title>Custom title</header-title>
|
|
<action-button-label>Custom label</action-button-label>
|
|
</adf-people-search>
|
|
```
|
|
|
|
## Class members
|
|
|
|
### Properties
|
|
|
|
| Name | Type | Default value | Description |
|
|
|---------|-----------------------------------------|---------------|-------------------------------------|
|
|
| results | `Observable<LightUserRepresentation[]>` | | Parameters for displaying the list. |
|
|
|
|
### Events
|
|
|
|
| Name | Type | Description |
|
|
|--------------|-----------------------------------------|-------------------------------------------------------------------|
|
|
| closeSearch | `EventEmitter<any>` | Emitted when the "close" button is clicked. |
|
|
| searchPeople | `EventEmitter<any>` | Emitted when a search is performed with a new keyword. |
|
|
| success | `EventEmitter<LightUserRepresentation>` | Emitted when a user is selected and the action button is clicked. |
|
|
|
|
## Details
|
|
|
|
Usage example:
|
|
|
|
```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>
|
|
```
|