inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-10-01 14:41:32 +00:00
Code Issues Packages Projects Releases Wiki Activity

[ADF-1769] Added JSDocs and updated prop table script (#2838)

Browse Source 
* [ADF-1769] Added JSDocs and updated prop table script

* [ADF-1769] Fixed lint error in JSDoc
This commit is contained in:
Andy Stark
2018-01-17 17:11:22 +00:00
committed by Eugenio Romano
parent 3461749dc6
commit c9a3b048b4
25 changed files with 194 additions and 100 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/checklist.component.md
View File

@@ -1,4 +1,4 @@
# Activiti Checklist Component
# Checklist Component
Shows the checklist task functionality.
@@ -15,7 +15,15 @@ Shows the checklist task functionality.
### Properties
| Name | Type | Description |
| --- | --- | --- |
| taskId | string | (**required**) The id of the parent task which sub tasks are attached on. |
| readOnlyForm | boolean | Toggle readonly state of the form. Enforces all form widgets render readonly if enabled. |
| assignee | string | (**required**) The assignee id where the subtasks are assigned to. |
| ---- | ---- | ----------- |
| 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. |