mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
[ADF-3745] Updates for doc review (#3989)
This commit is contained in:
Andy Stark
committed by
Eugenio Romano
Eugenio Romano
parent
6e8677a768
commit
383b74151a
@@ -1,6 +1,7 @@
|
||||
---
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
Last reviewed: 2018-11-19
|
||||
---
|
||||
|
||||
# Checklist Component
|
||||
@@ -13,7 +14,7 @@ Shows the checklist task functionality.
|
||||
<adf-checklist
|
||||
[readOnly]="false"
|
||||
[taskId]="taskId"
|
||||
[assignee]="taskAssignee.id"
|
||||
[assignee]="taskAssignee.id">
|
||||
</adf-checklist>
|
||||
```
|
||||
|
||||
|
||||
@@ -1,74 +0,0 @@
|
||||
---
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
---
|
||||
|
||||
# Filter model
|
||||
|
||||
Contains classes related to filters in Process Services.
|
||||
|
||||
## Details
|
||||
|
||||
You can find more information about the usage of these classes in the
|
||||
[APS Rest API docs](https://github.com/Alfresco/alfresco-js-api/tree/master/src/alfresco-activiti-rest-api)
|
||||
and in various ADF docs (see the [See Also](#see-also) section for links).
|
||||
|
||||
```ts
|
||||
class AppDefinitionRepresentationModel {
|
||||
defaultAppId: string;
|
||||
deploymentId: string;
|
||||
name: string;
|
||||
description: string;
|
||||
theme: string;
|
||||
icon: string;
|
||||
id: number;
|
||||
modelId: number;
|
||||
tenantId: number;
|
||||
}
|
||||
|
||||
class FilterParamsModel {
|
||||
id: number;
|
||||
name: string;
|
||||
index: number;
|
||||
}
|
||||
|
||||
class FilterRepresentationModel implements UserTaskFilterRepresentation {
|
||||
id: number;
|
||||
appId: number;
|
||||
name: string;
|
||||
recent: boolean;
|
||||
icon: string;
|
||||
filter: FilterParamRepresentationModel;
|
||||
index: number;
|
||||
}
|
||||
|
||||
class FilterParamRepresentationModel {
|
||||
processDefinitionId: string;
|
||||
processDefinitionKey: string;
|
||||
name: string;
|
||||
state: string;
|
||||
sort: string;
|
||||
assignment: string;
|
||||
dueAfter: Date;
|
||||
dueBefore: Date;
|
||||
}
|
||||
|
||||
class TaskQueryRequestRepresentationModel implements TaskQueryRequestRepresentation {
|
||||
appDefinitionId: string;
|
||||
processInstanceId: string;
|
||||
processDefinitionId: string;
|
||||
text: string;
|
||||
assignment: string;
|
||||
state: string;
|
||||
start: string;
|
||||
sort: string;
|
||||
page: number;
|
||||
size: number;
|
||||
}
|
||||
```
|
||||
|
||||
## See also
|
||||
|
||||
- [Process filters component](process-filters.component.md)
|
||||
- [Task filters component](task-filters.component.md)
|
||||
- [Apps process service](../core/apps-process.service.md)
|
||||
@@ -1,6 +1,7 @@
|
||||
---
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
Last reviewed: 2018-11-19
|
||||
---
|
||||
|
||||
# People Component
|
||||
@@ -45,12 +46,12 @@ Displays users involved with a specified task
|
||||
|
||||
### How to customize the people component behavior
|
||||
|
||||
The [people component](../process-services/people.component.md) provide two methods to customize the behavior:
|
||||
The [people component](../process-services/people.component.md) provides two options to customize its behavior:
|
||||
|
||||
- involveUserAndCloseSearch: The selected user is going to be added and the search section closed
|
||||
- involveUserWithoutCloseSearch: The selected user is going to be added without close the search section
|
||||
- _involveUserAndCloseSearch_: The selected user gets added and then the search section is closed
|
||||
- _involveUserWithoutCloseSearch_: The selected user gets added without closing the search section
|
||||
|
||||
In this way will be easy customize the [people component](../process-services/people.component.md) to involve the user with the single or double click event:
|
||||
This makes it easy to customize the [people component](../process-services/people.component.md) to involve the user via a single or double click event:
|
||||
|
||||
### Involve People single click and close search
|
||||
|
||||
|
||||
@@ -44,9 +44,9 @@ Collection of criteria used to filter process instances, which may be customized
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs. |
|
||||
| filterClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<UserProcessInstanceFilterRepresentation>` | Emitted when the user selects a filter from the list. |
|
||||
| filterSelected | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<ProcessInstanceFilterRepresentation>` | Emitted when a process filter is selected. |
|
||||
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<ProcessInstanceFilterRepresentation[]>` | Emitted when the list of filters has been successfully loaded from the server. |
|
||||
| filterClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`UserProcessInstanceFilterRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/alfresco-activiti-rest-api/docs/UserProcessInstanceFilterRepresentation.md)`>` | Emitted when the user selects a filter from the list. |
|
||||
| filterSelected | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessInstanceFilterRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/alfresco-activiti-rest-api/docs/ProcessInstanceFilterRepresentation.md)`>` | Emitted when a process filter is selected. |
|
||||
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessInstanceFilterRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/alfresco-activiti-rest-api/docs/ProcessInstanceFilterRepresentation.md)`[]>` | Emitted when the list of filters has been successfully loaded from the server. |
|
||||
|
||||
## Details
|
||||
|
||||
@@ -92,4 +92,3 @@ page for an example of how to do set this up.
|
||||
## See also
|
||||
|
||||
- [Process Filter service](process-filter.service.md)
|
||||
- [Filter model](filter.model.md)
|
||||
|
||||
@@ -1,11 +1,12 @@
|
||||
---
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
Last reviewed: 2018-11-19
|
||||
---
|
||||
|
||||
# Process Details component
|
||||
|
||||
Displays detailed information on a specified process instance
|
||||
Displays detailed information about a specified process instance
|
||||
|
||||
## Basic Usage
|
||||
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
---
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
Last reviewed: 2018-11-19
|
||||
---
|
||||
|
||||
# Process Instance Tasks component
|
||||
|
||||
@@ -1,24 +1,13 @@
|
||||
---
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
Last reviewed: 2018-06-07
|
||||
Last reviewed: 2018-11-16
|
||||
---
|
||||
|
||||
# Task Filters component
|
||||
|
||||
Shows all available filters.
|
||||
|
||||
## Contents
|
||||
|
||||
- [Basic Usage](#basic-usage)
|
||||
- [Class members](#class-members)
|
||||
- [Properties](#properties)
|
||||
- [Events](#events)
|
||||
- [Details](#details)
|
||||
- [Filtering APS task filters](#filtering-aps-task-filters)
|
||||
- [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
|
||||
@@ -34,7 +23,7 @@ Shows all available filters.
|
||||
| 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. |
|
||||
| showIcon| `boolean` | true | Toggles display of the filter's icon. |
|
||||
| showIcon | `boolean` | | Toggles display of the filter's icon. |
|
||||
|
||||
### Events
|
||||
|
||||
@@ -70,7 +59,3 @@ as the value of `filterParam` as shown in the table below:
|
||||
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
|
||||
|
||||
- [Filter model](filter.model.md)
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
---
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
Last reviewed: 2018-11-19
|
||||
---
|
||||
|
||||
# Task Standalone component
|
||||
|
||||
Reference in New Issue
Block a user