[ADF-1549] Added doc files for Processlist library (#2353)

This commit is contained in:
Andy Stark
2017-09-19 20:42:53 +01:00
committed by Eugenio Romano
parent a41afe0dbd
commit 99f12b18a4
15 changed files with 471 additions and 11 deletions

View File

@@ -0,0 +1,35 @@
# Process Instance Details Header component
Sub-component of the process details component, which renders some general information about the selected process.
![adf-process-instance-header](../docassets/images/adf-process-instance-header-attachment.png)
<!-- 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-header
processInstance="localProcessDetails">
</adf-process-instance-details>
```
### Properties
| Name | Type| Description |
| --- | --- | --- |
| processInstance | [ProcessInstanceModel](https://github.com/Alfresco/alfresco-ng2-components/blob/master/ng2-components/ng2-activiti-processlist/src/models/process-instance.model.ts) | (**required**): Full details of the process instance to display information about |
#### Events
This component does not define any events.