mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-05-12 17:04:57 +00:00
c3452a4f62
* move doc dependency in doctools * add ignore link * rebuild doc * version index * put it back some deps
77 lines
4.5 KiB
Markdown
77 lines
4.5 KiB
Markdown
---
|
|
Title: Task Details component
|
|
Added: v2.0.0
|
|
Status: Active
|
|
Last reviewed: 2018-11-13
|
|
---
|
|
|
|
# [Task Details component](../../../lib/process-services/src/lib/task-list/components/task-details.component.ts "Defined in task-details.component.ts")
|
|
|
|
Shows the details of the task ID passed in as input.
|
|
|
|
## Basic Usage
|
|
|
|
```html
|
|
<adf-task-details
|
|
[taskId]="taskId">
|
|
</adf-task-details>
|
|
```
|
|
|
|
## Class members
|
|
|
|
### Properties
|
|
|
|
| Name | Type | Default value | Description |
|
|
| ---- | ---- | ------------- | ----------- |
|
|
| debugMode | `boolean` | false | Toggles debug mode. |
|
|
| fieldValidators | [`FormFieldValidator`](../../../lib/core/form/components/widgets/core/form-field-validator.ts)`[]` | \[] | Field validators for use with the form. |
|
|
| readOnlyForm | `boolean` | false | Toggles read-only state of the form. All form widgets render as read-only if enabled. |
|
|
| showChecklist | `boolean` | true | Toggles `Checklist` feature for the Header component. |
|
|
| showComments | `boolean` | true | Toggles `Comments` feature for the Header component. |
|
|
| showFormCompleteButton | `boolean` | true | Toggles rendering of the `Complete` outcome button. |
|
|
| showFormRefreshButton | `boolean` | true | Toggles rendering of the `Refresh` button. |
|
|
| showFormSaveButton | `boolean` | true | Toggles rendering of the `Save` outcome button. |
|
|
| showFormTitle | `boolean` | false | Toggles rendering of the form title. |
|
|
| showHeader | `boolean` | true | Toggles task details Header component. |
|
|
| showHeaderContent | `boolean` | true | Toggles collapsed/expanded state of the Header component. |
|
|
| showInvolvePeople | `boolean` | true | Toggles `Involve People` feature for the Header component. |
|
|
| showNextTask | `boolean` | true | Automatically renders the next task when the current one is completed. |
|
|
| taskId | `string` | | (**required**) The id of the task whose details we are asking for. |
|
|
|
|
### Events
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| assignTask | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<void>` | Emitted when a task is assigned. |
|
|
| claimedTask | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string>` | Emitted when a task is claimed. |
|
|
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs. |
|
|
| executeOutcome | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormOutcomeEvent`](../../../lib/core/form/components/widgets/core/form-outcome-event.model.ts)`>` | Emitted when any outcome is executed. Default behaviour can be prevented via `event.preventDefault()`. |
|
|
| formCompleted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is submitted with the `Complete` outcome. |
|
|
| formContentClicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ContentLinkModel`](../../../lib/core/form/components/widgets/core/content-link.model.ts)`>` | Emitted when the form field content is clicked. |
|
|
| formLoaded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is loaded or reloaded. |
|
|
| formSaved | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is submitted with the `Save` or custom outcomes. |
|
|
| taskCreated | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`TaskDetailsModel`](../../../lib/process-services/src/lib/task-list/models/task-details.model.ts)`>` | Emitted when a checklist task is created. |
|
|
| taskDeleted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string>` | Emitted when a checklist task is deleted. |
|
|
| unClaimedTask | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string>` | Emitted when a task is unclaimed. |
|
|
|
|
## Details
|
|
|
|
### Custom 'empty Task Details' template
|
|
|
|
By default the [Task Details component](task-details.component.md) shows a simple "No Tasks" message when there are
|
|
no details. You can change this by adding the a custom HTML template as in the following
|
|
example:
|
|
|
|
```html
|
|
<adf-task-details [taskId]="taskId">
|
|
<adf-no-task-details-template>
|
|
<ng-template>
|
|
<h1>Sorry, no tasks here</h1>
|
|
<img src="example.jpg">
|
|
</ng-template>
|
|
</adf-no-task-details-template>
|
|
</adf-task-details>
|
|
```
|
|
|
|
Note that you can use any HTML content in the template, including other Angular components.
|