mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-05-26 17:24:56 +00:00

Andy Stark 2c49de6070 [ADF-3514] Added transclusions sections to doc files (#3756 )

* [ADF-3514] Added transclusion sections and guide page

* [ADF-3514] Updated tables of contents where needed

* [ADF-3514] Updated index files

2018-09-10 11:11:25 +01:00

1.8 KiB

Raw Blame History

Added, Status

Added	Status
v2.0.0	Active

People Search component

Searches users/people.

Basic Usage

<adf-people-search></adf-people-search>

Transclusions

You can provide a title for the search header and a label for the action button using special sub-components in the body of the <adf-people-search> element:

<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<UserProcessModel[]>`		Parameters for displaying the list.

Events

Name	Type	Description
closeSearch	`EventEmitter<Object>`	Emitted when the "close" button is clicked.
searchPeople	`EventEmitter<any>`	Emitted when a search is performed with a new keyword.
success	`EventEmitter<UserProcessModel>`	Emitted when a user is selected and the action button is clicked.

Details

<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>

1.8 KiB Raw Blame History