inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-07-24 17:32:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

[ADF-2824] Doc review and minor changes to review checker tool (#3466)

Browse Source
This commit is contained in:
Andy Stark
2018-06-11 09:48:02 +01:00
committed by Eugenio Romano
parent 3281891dcd
commit d152c367aa
29 changed files with 336 additions and 320 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
docs/process-services/apps-list.component.md
View File

@@ -1,6 +1,7 @@
---
Added: v2.0.0
Status: Active
Last reviewed: 2018-06-08
---
# Apps List Component
@@ -17,9 +18,7 @@ Shows all available apps.
</adf-apps>
```
## Passing custom no-apps template
If we intend to show a custom template if there are no apps present
You can also show a custom template if there are no apps present:
```html
<adf-apps
@@ -48,24 +47,9 @@ If we intend to show a custom template if there are no apps present
## Details
### How filter the activiti apps
If you want to show some specific apps you can specify them through the filtersAppId parameters
```html
<adf-apps
[filtersAppId]="'[
{defaultAppId: 'tasks'},
{deploymentId: '15037'},
{name : 'my app name'}]'">
</adf-apps>
```
In this specific case only the Tasks app, the app with deploymentId 15037 and the app with "my app name" will be shown.
![how-filter-apps](../docassets/images/how-filter-apps.png)
You can use inside the filter one of the following property
You can specify a restricted list of apps using the `filtersAppId` property. This array
contains a list of objects containing the property values you are interested in. You can
use any of the following properties as filters:
```json
{
@@ -77,3 +61,18 @@ You can use inside the filter one of the following property
"tenantId": "number"
}
```
For example, if you set `filtersAppId` as follows:
```html
<adf-apps
[filtersAppId]="'[
{defaultAppId: 'tasks'},
{deploymentId: '15037'},
{name : 'my app name'}]'">
</adf-apps>
```
...then only the Tasks app, the app with `deploymentId` 15037 and the app with "my app name" will be shown.
![how-filter-apps](../docassets/images/how-filter-apps.png)

13
docs/process-services/process-instance-header.component.md
View File

@@ -1,6 +1,7 @@
---
Added: v2.0.0
Status: Active
Last reviewed: 2018-06-08
---
# Process Instance Details Header component
@@ -25,13 +26,15 @@ Sub-component of the process details component, which renders some general infor
| -- | -- | -- | -- |
| processInstance | [`ProcessInstance`](../../lib/process-services/process-list/models/process-instance.model.ts) | | (**required**) Full details of the process instance to display information about. |
## Customise the properties showed
## Details
By default all the properties are showed :
### Choosing which properties are displayed
By default all the properties are displayed:
**_status_**, **_ended_**, **_category_**, **_businessKey_**, **_assignee_**, **_created_**,**_id_**, **_description_**.
It is possible to customise the showed properties via "app.config.json".
This is how the configuration looks like:
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": {
@@ -41,4 +44,4 @@ This is how the configuration looks like:
}
```
In this way only the listed properties will be showed.
Only the items in the `properties` array will be displayed.

1
docs/process-services/task-filter.service.md
View File

@@ -1,6 +1,7 @@
---
Added: v2.0.0
Status: Active
Last reviewed: 2018-06-07
---
# Task Filter Service

39
docs/process-services/task-filters.component.md
View File

@@ -1,29 +1,13 @@
---
Added: v2.0.0
Status: Active
Last reviewed: 2018-06-07
---
# Task Filters component
Shows all available filters.
## Contents
- [Basic Usage](#basic-usage)
- [Class members](#class-members)
- [Properties](#properties)
- [Events](#events)
- [Details](#details)
- [How filter the activiti task filters](#how-filter-the-activiti-task-filters)
- [FilterParamsModel](#filterparamsmodel)
- [How to create an accordion menu with the task filter](#how-to-create-an-accordion-menu-with-the-task-filter)
- [See also](#see-also)
## Basic Usage
```html
@@ -51,7 +35,9 @@ Shows all available filters.
## Details
### How filter the activiti task filters
### Filtering APS task filters
Use the `filterParam` property to restrict the range of filters that are shown:
```html
<adf-task-filters
@@ -59,17 +45,9 @@ Shows all available filters.
</adf-task-filters>
```
You can use inside the filterParam one of the properties from [`FilterParamsModel`](../../lib/process-services/task-list/models/filter.model.ts) (see below).
You can use properties from [`FilterParamsModel`](../../lib/process-services/task-list/models/filter.model.ts)
as the value of `filterParam` as shown in the table below:
### FilterParamsModel
```json
{
"id": "number",
"name": "string",
"index": "number"
}
```
| Name | Type | Description |
| ---- | ---- | ----------- |
@@ -79,8 +57,9 @@ You can use inside the filterParam one of the properties from [`FilterParamsMode
### How to create an accordion menu with the task filter
The task filter often works well as an item in an accordion menu. See the [Accordion component](../core/accordion.component.md)
page for an example of how to do set this up.
The task filter often works well as an item in an accordion menu. See the
[Accordion component](../core/accordion.component.md)
page for an example of how to set this up.
## See also