mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-05-19 17:14:57 +00:00
c9a3b048b4
* [ADF-1769] Added JSDocs and updated prop table script * [ADF-1769] Fixed lint error in JSDoc
30 lines
947 B
Markdown
30 lines
947 B
Markdown
# Checklist Component
|
|
|
|
Shows the checklist task functionality.
|
|
|
|
## Basic Usage
|
|
|
|
```html
|
|
<adf-checklist
|
|
[readOnly]="false"
|
|
[taskId]="taskId"
|
|
[assignee]="taskAssignee.id"
|
|
</adf-checklist>
|
|
```
|
|
|
|
### Properties
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| taskId | `string` | (required) The id of the parent task to which subtasks are attached. |
|
|
| readOnly | `boolean` | Toggle readonly state of the form. All form widgets will render as readonly if enabled.<br/> Default value: `false` |
|
|
| assignee | `string` | (required) The assignee id that the subtasks are assigned to. |
|
|
|
|
### Events
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| checklistTaskCreated | `EventEmitter<TaskDetailsModel>` | Emitted when a new checklist task is created. |
|
|
| checklistTaskDeleted | `EventEmitter<string>` | Emitted when a checklist task is deleted. |
|
|
| error | `EventEmitter<any>` | Emitted when an error occurs. |
|