[ADF-1549] Added doc files for Tasklist library (#2350)

This commit is contained in:
Andy Stark
2017-09-19 13:37:31 +01:00
committed by Eugenio Romano
parent 7a31a16178
commit a41afe0dbd
25 changed files with 737 additions and 14 deletions

View File

@@ -0,0 +1,43 @@
# Activiti Task Header component
Shows all the information related to a task.
![adf-task-header](../docassets/images/adf-task-header.png)
<!-- markdown-toc start - Don't edit this section. npm run toc to generate it-->
<!-- toc -->
- [Basic Usage](#basic-usage)
* [Properties](#properties)
* [Events](#events)
- [Details](#details)
<!-- tocstop -->
<!-- markdown-toc end -->
## Basic Usage
```html
<adf-task-header
[taskDetails]="taskDetails">
</adf-task-header>
```
### Properties
| Name | Type | Default | Description |
| --- | --- | --- | --- |
| taskDetails | [TaskDetailsModel](#taskdetailsmodel) | | (**required**) The task details related to the task. |
| formName | string | | The name of the form. |
### Events
| Name | Description |
| --- | --- |
| claim | Raised when the task is claimed. |
## Details
The purpose of the component is to populate the local variable called `properties` (array of CardViewModel), with all the information that we want to display.