alfresco-ng2-components/docs/process-services-cloud/task-header-cloud.component.md
davidcanonieto f2b5300705 [ADF-3769] Task Header Cloud Component for APS 2 (#4140)
* [ADF-3769] Task Header Cloud Component for APS 2

* [ADF-3796] Add error catch to affected-libs.sh

* [ADF-3769] Add readOnly mode and remove selectFirstRow in Task List Cloud component
2019-01-16 13:43:05 +00:00

53 lines
1.7 KiB
Markdown

# [Task Header component](../../lib/process-services-cloud/task-header/components/task-header-cloud.component.ts "Defined in task-header.component.ts")
Shows all the information related to a task.
![adf-task-header](../docassets/images/adf-task-header.png)
## Basic Usage
```html
<adf-cloud-task-header
[appName]="applicationName"
[taskId]="taskId">
</adf-cloud-task-header>
```
## Class members
### Properties
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| appName | `string` | | (required) The name of the application. |
| taskId | `string` | | (required) The id of the Task. |
| readOnly | `boolean` | false | Flag to set the component in Read Only Mode. This mode makes all the cells not clickable and not editable. |
### Events
| Name | Type | Description |
| ---- | ---- | ----------- |
| claim | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the task is claimed. |
| unclaim | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the task is unclaimed (ie, requeued). |
## Details
The component populates an internal array of
[CardViewModel](../core/card-view.component.md) with the information that we want to display.
By default all properties are displayed:
**_assignee_**, **_status_**, **_priority_**, **_dueDate_**, **_category_**, **_parentName_**, **_created_**, **_id_**, **_description_**, **_formName_**.
However, you can also choose which properties to show using a configuration in `app.config.json`:
```json
"adf-cloud-task-header": {
"presets": {
"properties" : [ "assignee", "status", "priority", "parentName"]
}
}
```
With this configuration, only the four listed properties will be shown.