mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-05-12 17:04:57 +00:00
5a4cc4edda
* Release Note for 4.2 - Initial draft. * update dep * documentation * fix * remove script * lint Co-authored-by: Eugenio Romano <eugenio.romano@alfresco.com> Co-authored-by: Eugenio Romano <eromano@users.noreply.github.com>
108 lines
3.5 KiB
Markdown
108 lines
3.5 KiB
Markdown
---
|
|
Title: People Component
|
|
Added: v2.0.0
|
|
Status: Active
|
|
Last reviewed: 2018-11-19
|
|
---
|
|
|
|
# [People Component](../../../lib/process-services/src/lib/people/components/people/people.component.ts "Defined in people.component.ts")
|
|
|
|
Displays users involved with a specified task
|
|
|
|
|
|
|
|
## Contents
|
|
|
|
* [Basic Usage](#basic-usage)
|
|
* [Class members](#class-members)
|
|
* [Properties](#properties)
|
|
* [Details](#details)
|
|
* [How to customize the people component behavior](#how-to-customize-the-people-component-behavior)
|
|
* [Involve People single click and close search](#involve-people-single-click-and-close-search)
|
|
* [Involve People single click without close search](#involve-people-single-click-without-close-search)
|
|
* [Involve People double click and close search](#involve-people-double-click-and-close-search)
|
|
* [Involve People double double without close search](#involve-people-double-double-without-close-search)
|
|
|
|
## Basic Usage
|
|
|
|
```html
|
|
<adf-people
|
|
[people]="YOUR_INVOLVED_PEOPLE_LIST"
|
|
[taskId]="YOUR_TASK_ID"
|
|
[readOnly]="YOUR_READ_ONLY_FLAG">
|
|
</adf-people>
|
|
```
|
|
|
|
## Class members
|
|
|
|
### Properties
|
|
|
|
| Name | Type | Default value | Description |
|
|
| --- | --- | --- | --- |
|
|
| people | [`UserProcessModel`](../../core/models/user-process.model.md)`[]` | \[] | The array of [`User`](../../../lib/core/pipes/user-initial.pipe.ts) objects to display. |
|
|
| readOnly | `boolean` | false | Should the data be read-only? |
|
|
| taskId | `string` | "" | The numeric ID of the task. |
|
|
|
|
## Details
|
|
|
|
### How to customize the people component behavior
|
|
|
|
The [people component](people.component.md) provides two options to customize its behavior:
|
|
|
|
* *involveUserAndCloseSearch*: The selected user gets added and then the search section is closed
|
|
* *involveUserWithoutCloseSearch*: The selected user gets added without closing the search section
|
|
|
|
This makes it easy to customize the [people component](people.component.md) to involve the user via a single or double click event:
|
|
|
|
### Involve People single click and close search
|
|
|
|
```html
|
|
<adf-people #people
|
|
(row-click)="people.involveUserAndCloseSearch()"
|
|
[people]="YOUR_INVOLVED_PEOPLE_LIST"
|
|
[taskId]="YOUR_TASK_ID"
|
|
[readOnly]="YOUR_READ_ONLY_FLAG">
|
|
</adf-people>
|
|
```
|
|
|
|
|
|
|
|
### Involve People single click without close search
|
|
|
|
```html
|
|
<adf-people #people
|
|
(row-click)="people.involveUserWithoutCloseSearch()"
|
|
[people]="YOUR_INVOLVED_PEOPLE_LIST"
|
|
[taskId]="YOUR_TASK_ID"
|
|
[readOnly]="YOUR_READ_ONLY_FLAG">
|
|
</adf-people>
|
|
```
|
|
|
|
|
|
|
|
### Involve People double click and close search
|
|
|
|
```html
|
|
<adf-people #people
|
|
(row-dblclick)="people.involveUserAndCloseSearch()"
|
|
[people]="YOUR_INVOLVED_PEOPLE_LIST"
|
|
[taskId]="YOUR_TASK_ID"
|
|
[readOnly]="YOUR_READ_ONLY_FLAG">
|
|
</adf-people>
|
|
```
|
|
|
|
|
|
|
|
### Involve People double double without close search
|
|
|
|
```html
|
|
<adf-people #people
|
|
(row-dblclick)="people.involveUserWithoutCloseSearch()"
|
|
[people]="YOUR_INVOLVED_PEOPLE_LIST"
|
|
[taskId]="YOUR_TASK_ID"
|
|
[readOnly]="YOUR_READ_ONLY_FLAG">
|
|
</adf-people>
|
|
```
|
|
|
|
|