mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
[ACS-7427] Process Services improvements and cleanup (#9664)
This commit is contained in:
@@ -5,7 +5,7 @@ Status: Active
|
||||
Last reviewed: 2018-11-14
|
||||
---
|
||||
|
||||
# [People Search component](../../../lib/process-services/src/lib/people/components/people-search/people-search.component.ts "Defined in people-search.component.ts")
|
||||
# People Search Component
|
||||
|
||||
Searches users/people.
|
||||
|
||||
@@ -18,10 +18,10 @@ Searches users/people.
|
||||
### [Transclusions](../../user-guide/transclusion.md)
|
||||
|
||||
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:
|
||||
special subcomponents in the body of the `<adf-people-search>` element:
|
||||
|
||||
```html
|
||||
<adf-people-search ...>
|
||||
<adf-people-search>
|
||||
<header-title>Custom title</header-title>
|
||||
<action-button-label>Custom label</action-button-label>
|
||||
</adf-people-search>
|
||||
@@ -31,24 +31,22 @@ special sub-components in the body of the `<adf-people-search>` element:
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| results | [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`UserProcessModel`](../../core/models/user-process.model.md)`[]>` | | Parameters for displaying the list. |
|
||||
| Name | Type | Default value | Description |
|
||||
|---------|-----------------------------------------|---------------|-------------------------------------|
|
||||
| results | `Observable<LightUserRepresentation[]>` | | Parameters for displaying the list. |
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| closeSearch | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the "close" button is clicked. |
|
||||
| searchPeople | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when a search is performed with a new keyword. |
|
||||
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`UserProcessModel`](../../core/models/user-process.model.md)`>` | Emitted when a user is selected and the action button is clicked. |
|
||||
| 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:
|
||||
|
||||
<!-- {% raw %} -->
|
||||
|
||||
```html
|
||||
<adf-people-search
|
||||
(searchPeople)="searchUser($event)"
|
||||
@@ -59,5 +57,3 @@ Usage example:
|
||||
<action-button-label>{{ 'PEOPLE.ADD_USER' | translate }}</action-button-label>
|
||||
</adf-people-search>
|
||||
```
|
||||
|
||||
<!-- {% endraw %} -->
|
||||
|
Reference in New Issue
Block a user