mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
[ADF-1549] Added doc files for Processlist library (#2353)
This commit is contained in:
committed by
Eugenio Romano
parent
a41afe0dbd
commit
99f12b18a4
37
docs/process-instance-tasks.component.md
Normal file
37
docs/process-instance-tasks.component.md
Normal file
@@ -0,0 +1,37 @@
|
||||
# Process Instance Tasks component
|
||||
|
||||
Lists both the active and completed tasks associated with a particular process instance
|
||||
|
||||
<!-- markdown-toc start - Don't edit this section. npm run toc to generate it-->
|
||||
|
||||
<!-- toc -->
|
||||
|
||||
- [Basic Usage](#basic-usage)
|
||||
* [Properties](#properties)
|
||||
* [Events](#events)
|
||||
|
||||
<!-- tocstop -->
|
||||
|
||||
<!-- markdown-toc end -->
|
||||
|
||||
## Basic Usage
|
||||
|
||||
```html
|
||||
<adf-process-instance-tasks
|
||||
processInstanceId="YOUR_PROCESS_INSTANCE_ID"
|
||||
showRefreshButton="true">
|
||||
</adf-process-instance-tasks>
|
||||
```
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| processInstanceId | string | (**required**): The ID of the process instance to display tasks for |
|
||||
| showRefreshButton | boolean | (default: `true`): Whether to show a refresh button next to the list of tasks to allow this to be updated from the server |
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Description |
|
||||
| --- | --- |
|
||||
| taskFormCompletedEmitter | Raised when the form associated with an active task is completed from within the component |
|
Reference in New Issue
Block a user