mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
[ADF-4152] Updated doc folder structure and index tool (#4403)
* [ADF-4152] Initial GraphQL implementation * [ADF-4152] Schema updates * [ADF-4152] Rounded out basic fields * [ADF-4152] Added basic template functionality * [ADF-4152] Added full template generation * [ADF-4152] Moved proc services doc files to new folders * [ADF-4152] Updated README.md with section from new template * [ADF-4152] Fixed another problem with relative URLs * [ADF-4152] Fixed links and some more bugs * [ADF-4152] Removed proc services folder README file
This commit is contained in:
committed by
Eugenio Romano
parent
75b90c5e08
commit
e74f545aa8
@@ -0,0 +1,48 @@
|
||||
---
|
||||
Title: Process Instance Details Header component
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
Last reviewed: 2019-01-14
|
||||
---
|
||||
|
||||
# [Process Instance Details Header component](../../../lib/process-services/process-list/components/process-instance-header.component.ts "Defined in process-instance-header.component.ts")
|
||||
|
||||
Sub-component of the process details component, which renders some general information about the selected process.
|
||||
|
||||

|
||||
|
||||
## Basic Usage
|
||||
|
||||
```html
|
||||
<adf-process-instance-header
|
||||
processInstance="localProcessDetails">
|
||||
</adf-process-instance-details>
|
||||
```
|
||||
|
||||
## Class members
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| processInstance | [`ProcessInstance`](../../../lib/process-services/process-list/models/process-instance.model.ts) | | (**required**) Full details of the process instance to display information about. |
|
||||
|
||||
## Details
|
||||
|
||||
### Choosing which properties are displayed
|
||||
|
||||
By default all the properties are displayed:
|
||||
**_status_**, **_ended_**, **_category_**, **_businessKey_**, **_assignee_**, **_created_**,**_id_**, **_description_**.
|
||||
|
||||
You can customize which properties are displayed using a setting in `app.config.json`.
|
||||
The configuration looks like the following sample:
|
||||
|
||||
```json
|
||||
"adf-process-instance-header": {
|
||||
"presets": {
|
||||
"properties" : [ "status", "ended", "created", "id"]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Only the items in the `properties` array will be displayed.
|
Reference in New Issue
Block a user