Task header basic documentation (#1985)

This commit is contained in:
Maurizio Vitale
2017-06-19 16:15:47 +01:00
committed by Eugenio Romano
parent 4e7c5bfdbf
commit 4de13305b1

View File

@@ -32,6 +32,9 @@
- [Create Task Attachment Component](#create-task-attachment-component) - [Create Task Attachment Component](#create-task-attachment-component)
* [Properties](#properties-6) * [Properties](#properties-6)
+ [Events](#events-5) + [Events](#events-5)
- [Activiti Task Header](#activiti-task-header)
* [Properties](#properties-7)
* [Events](#events-6)
- [Build from sources](#build-from-sources) - [Build from sources](#build-from-sources)
- [NPM scripts](#npm-scripts) - [NPM scripts](#npm-scripts)
- [Demo](#demo) - [Demo](#demo)
@@ -388,6 +391,41 @@ This component displays Upload Component(Drag and Click) to upload the attachmen
| error | Raised when the error occured while creating/uploading the attachment by the user from within the component | | error | Raised when the error occured while creating/uploading the attachment by the user from within the component |
| success | Raised when the attachement created/uploaded successfully from within the component | | success | Raised when the attachement created/uploaded successfully from within the component |
## Activiti Task Header
The component shows all the information related to a task.
The purpose of the component is populate the local variable called `properties` (array of CardViewModel), with all the information that we want display.
```html
<activiti-task-header
[taskDetails]="taskDetails">
</activiti-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. |
## TaskDetailsModel
```json
{
"id": "string",
"assignee": "User",
"dueDate": "data",
"endDate": "string",
"description": "string"
}
```
## Build from sources ## Build from sources
You can build component from sources with the following commands: You can build component from sources with the following commands: