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

[ADF-2764] Updated process services docs with latest features (#3390)

Browse Source
This commit is contained in:
Andy Stark
2018-05-24 17:10:35 +01:00
committed by Eugenio Romano
parent a2581417bd
commit 04e50eeabd
33 changed files with 576 additions and 455 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -2,10 +2,28 @@
Added: v2.0.0
Status: Active
---
# 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
@@ -17,19 +35,19 @@ Shows all available filters.
### Properties
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| filterParam | `FilterParamsModel` | | Parameters to use for the task filter. If there is no match then the default filter (the first one the list) is selected. |
| appId | `number` | | Display filters available to the current user for the application with the specified ID. |
| appName | `string` | | Display filters available to the current user for the application with the specified name. |
| hasIcon | `boolean` | `true` | Toggles display of the filter's icon. |
| -- | -- | -- | -- |
| appId | `number` | | Display filters available to the current user for the application with the specified ID. |
| appName | `string` | | Display filters available to the current user for the application with the specified name. |
| filterParam | [`FilterParamsModel`](../../lib/process-services/task-list/models/filter.model.ts) | | Parameters to use for the task filter. If there is no match then the default filter (the first one the list) is selected. |
| hasIcon | `boolean` | true | Toggles display of the filter's icon. |
### Events
| Name | Type | Description |
| ---- | ---- | ----------- |
| filterClick | `EventEmitter<FilterRepresentationModel>` | Emitted when a filter in the list is clicked. |
| success | `EventEmitter<any>` | Emitted when the list is loaded. |
| -- | -- | -- |
| error | `EventEmitter<any>` | Emitted when an error occurs during loading. |
| filterClick | [`EventEmitter<FilterRepresentationModel>`](../../lib/process-services/task-list/models/filter.model.ts) | Emitted when a filter in the list is clicked. |
| success | `EventEmitter<any>` | Emitted when the list is loaded. |
## Details
@@ -41,7 +59,7 @@ Shows all available filters.
</adf-task-filters>
```
You can use inside the filterParam one of the properties from [FilterParamsModel](#filterparamsmodel) (see below).
You can use inside the filterParam one of the properties from [`FilterParamsModel`](../../lib/process-services/task-list/models/filter.model.ts) (see below).
### FilterParamsModel