alfresco-ng2-components/docs/checklist.component.md
Andy Stark 900fd70d63 [ADF-1769] Added prop tables and fixed script (#2896)
* [ADF-1769] Added prop tables and fixed script

* [ADF-1769] Corrected JSDoc formatting errors

* [ADF-1769] Restored default column to prop tables
2018-01-31 09:22:05 +00:00

967 B

Checklist Component

Shows the checklist task functionality.

Basic Usage

<adf-checklist 
    [readOnly]="false" 
    [taskId]="taskId" 
    [assignee]="taskAssignee.id" 
</adf-checklist>

Properties

Name Type Default value Description
taskId string (required) The id of the parent task to which subtasks are attached.
readOnly boolean false Toggle readonly state of the form. All form widgets will render as readonly if enabled.
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.