alfresco-ng2-components/docs/process-instance-tasks.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

27 lines
897 B
Markdown

# Process Instance Tasks component
Lists both the active and completed tasks associated with a particular process instance
## Basic Usage
```html
<adf-process-instance-tasks
processInstanceId="YOUR_PROCESS_INSTANCE_ID"
showRefreshButton="true">
</adf-process-instance-tasks>
```
### Properties
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| processInstanceDetails | `ProcessInstance` | | (**required**) The ID of the process instance to display tasks for. |
| showRefreshButton | `boolean` | `true` | Toggles whether to show a refresh button next to the list of tasks to allow it to be updated from the server. |
### Events
| Name | Type | Description |
| ---- | ---- | ----------- |
| error | `EventEmitter<any>` | Emitted when an error occurs. |
| taskClick | `EventEmitter<TaskDetailsEvent>` | Emitted when a task is clicked. |