alfresco-ng2-components/docs/task-header.component.md

45 lines
1.0 KiB
Markdown

# 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. |
| unclaim | Raised when the task is unclaimed (requeued). |
## 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.