mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-05-12 17:04:57 +00:00
fa587510bd
* [AAE-9200] - Be able to customise task/process list and header date formats * Update json schema * Revert schema changes * Update task and process name translation values * move task/process header date formats inside header config * Add documentation * Update documentation * Use a fixed timezone for unit tests of core and cloud * Fix e2e due to column rename * More e2e fixes due to column rename, remove test covered by unit test
69 lines
2.1 KiB
Markdown
69 lines
2.1 KiB
Markdown
---
|
|
Title: Task Header Cloud Component
|
|
Added: v3.0.0
|
|
Status: Experimental
|
|
Last reviewed: 2019-03-20
|
|
---
|
|
|
|
# [Task Header Cloud Component](../../../lib/process-services-cloud/src/lib/task/task-header/components/task-header-cloud.component.ts "Defined in task-header-cloud.component.ts")
|
|
|
|
Shows all the information related to a task.
|
|
|
|
|
|
|
|
## Basic Usage
|
|
|
|
```html
|
|
<adf-cloud-task-header
|
|
[appName]="appName"
|
|
[taskId]="taskId">
|
|
</adf-cloud-task-header>
|
|
```
|
|
|
|
## Class members
|
|
|
|
### Properties
|
|
|
|
| Name | Type | Default value | Description |
|
|
| ---- | ---- | ------------- | ----------- |
|
|
| appName | `string` | "" | (Required) The name of the application. |
|
|
| showTitle | `boolean` | true | Show/Hide the task title |
|
|
| taskId | `string` | | (Required) The id of the task. |
|
|
|
|
### Events
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| claim | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the task is claimed. |
|
|
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the given task has errors. |
|
|
| 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/components/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_**, **_candidateUsers_**, **_candidateGroups_**.
|
|
|
|
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.
|
|
|
|
You can also define the date format of the date properties using a configuration in `app.config.json`:
|
|
|
|
```json
|
|
"adf-cloud-task-header": {
|
|
"defaultDateFormat": "full"
|
|
}
|
|
```
|