[ADF-2463] Moved doc files to subfolders (#3073)

2026-09-09 18:03:21 +00:00 · 2018-03-13 17:29:07 +00:00
parent 766bb082f5
commit 6dc758889f
34 changed files with 103 additions and 105 deletions
@@ -0,0 +1,104 @@
+---
+Added: v2.0.0
+Status: Active
+---
+# People Component
+
+Displays users involved with a specified task
+
+## Contents
+
+-   [Basic Usage](#basic-usage)
+
+    -   [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>
+```
+
+![activiti-people](../docassets/images/activiti_people.png)
+
+### Properties
+
+| Name | Type | Default value | Description |
+| ---- | ---- | ------------- | ----------- |
+| people | `any[]` | `[]` | The array of User objects to display.  |
+| taskId | `string` | `''` | The numeric ID of the task.  |
+| readOnly | `boolean` | `false` | Should the data be read-only?  |
+
+## Details
+
+### How to customize the people component behavior
+
+The people component provide two methods to customize the behavior:
+
+-   involveUserAndCloseSearch: The selected user is going to be added and the search section closed
+-   involveUserWithoutCloseSearch: The selected user is going to be added without close the search section
+
+In this way will be easy customize the people component to involve the user with the 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-and-close-search](../docassets/images/involve-people-single-click-and-close-search.gif)
+
+### 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-single-click-without-close-search](../docassets/images/involve-people-single-click-without-close-search.gif)
+
+### 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-click-and-close-search](../docassets/images/involve-people-double-click-and-close-search.gif)
+
+### 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>
+```
+
+![involve-people-double-click-without-close-search](../docassets/images/involve-people-double-click-without-close-search.gif)