mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-05-12 17:04:57 +00:00
58 lines
1.5 KiB
Markdown
58 lines
1.5 KiB
Markdown
---
|
|
Added: v2.0.0
|
|
Status: Active
|
|
---
|
|
# Task Header component
|
|
|
|
Shows all the information related to a task.
|
|
|
|
|
|
|
|
## Basic Usage
|
|
|
|
```html
|
|
<adf-task-header
|
|
[taskDetails]="taskDetails">
|
|
</adf-task-header>
|
|
```
|
|
|
|
### Properties
|
|
|
|
| Name | Type | Default value | Description |
|
|
| ---- | ---- | ------------- | ----------- |
|
|
| formName | `string` | `null` | The name of the form. |
|
|
| taskDetails | `TaskDetailsModel` | | (required) Details related to the task. |
|
|
|
|
### Events
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| claim | `EventEmitter<any>` | Emitted when the task is claimed. |
|
|
| unclaim | `EventEmitter<any>` | Emitted when the task is unclaimed (ie, 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.
|
|
|
|
## Customise the property showed
|
|
By default all the property are showed :
|
|
***assignee***, ***status***, ***priority***, ***dueDate***, ***category***, ***parentName***, ***created-by***, ***created***, ***id***, ***description***, ***formName***.
|
|
|
|
It is possible to customise the showed property via the "app.config.json".
|
|
This is how the configuration looks like:
|
|
|
|
```json
|
|
|
|
"adf-task-header": {
|
|
"presets": {
|
|
"properties" : [ "assignee", "status", "priority", "parentName"]
|
|
}
|
|
},
|
|
|
|
```
|
|
In this way only the listed property will be showed.
|
|
|
|
## See also
|
|
|
|
- [Task Details model](task-details.model.md)
|