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-3782] Fixed doc comments for task list cloud component (#4027)

Browse Source
This commit is contained in:
Andy Stark
2018-11-28 15:57:24 +00:00
committed by Eugenio Romano
parent b5c693fe79
commit 07beec3c08
2 changed files with 45 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
docs/process-services-cloud/task-list-cloud.md → docs/process-services-cloud/task-list-cloud.component.md
View File

@@ -2,7 +2,7 @@
Title: Task List Cloud component Title: Task List Cloud component
Added: v3.0.0 Added: v3.0.0
Status: Active Status: Active
Last reviewed: 2018-04-16 Last reviewed: 2018-11-28
--- ---
# Task List Cloud component # Task List Cloud component
@@ -51,22 +51,21 @@ when the task list is empty:
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- | | ---- | ---- | ------------- | ----------- |
| applicationName | `string` | | The name of the application. | | applicationName | `string` | "" | The name of the application. |
| assignee | `string` | | The assigee of the process. Possible values are: "assignee" (the current user is the assignee), candidate (the current user is a task candidate", "group_x" (the task is assigned to a group where the current user is a member, no value(the current user is involved). | | assignee | `string` | "" | The assignee of the process. Possible values are: "assignee" (the current user is the assignee), "candidate" (the current user is a task candidate", "group_x" (the task is assigned to a group where the current user is a member, no value (the current user is involved). |
| createdDate | `Date` | | filter the tasks for the date when the task should have been created | | createdDate | `string` | "" | Filter the tasks. Display only tasks created on the supplied date. |
| dueDate | `Date` | | Filter the tasks. Display only tasks with dueDate equal to the one insterted. | | dueDate | `string` | "" | Filter the tasks. Display only tasks with dueDate equal to the supplied date. |
| id | `string` | | Filter the tasks. Display only tasks with id equal to the one insterted. | | id | `string` | "" | Filter the tasks. Display only tasks with id equal to the supplied value. |
| name | `string` | | Filter the tasks. Display only tasks with name equal to the one insterted. |
| parentTaskId | `string` | | Filter the tasks. Display only tasks with parentTaskId equal to the one insterted. |
| processDefinitionId | `string` | | Filter the tasks. Display only tasks with processDefinitionId equal to the one insterted. |
| processInstanceId | `string` | | Filter the tasks. Display only tasks with processInstanceId equal to the one insterted. |
| status | `string` | | Filter the tasks. Display only tasks with status equal to the one insterted. |
| processDefinitionId | `string` | | Filter the tasks. Display only tasks with processDefinitionId equal to the one insterted. |
| landingTaskId | `string` | | Define which task id should be selected after reloading. If the task id doesn't exist or nothing is passed then the first task will be selected. | | landingTaskId | `string` | | Define which task id should be selected after reloading. If the task id doesn't exist or nothing is passed then the first task will be selected. |
| selectFirstRow | `boolean` | true | Toggles default selection of the first row | | multiselect | `boolean` | false | Toggles multiple row selection, rendering a checkbox at the beginning of each row. |
| selectionMode | `string` | "single" | Row selection mode. Can be none, `single` or `multiple`. For `multiple` mode, you can use Cmd (macOS) or Ctrl (Win) modifier key to toggle selection for multiple rows. | | name | `string` | "" | Filter the tasks. Display only tasks with the supplied name. |
| multiselect | `boolean` | false | Toggles multiple row selection, renders checkboxes at the beginning of each row | | parentTaskId | `string` | "" | Filter the tasks. Display only tasks with parentTaskId equal to the supplied value. |
| sorting | `[TaskListCloudSortingModel]` | | This array of `TaskListCloudSortingModel` specify how the sorting on our table should be provided. This parameters are for BE sorting. | | processDefinitionId | `string` | "" | Filter the tasks. Display only tasks with processDefinitionId equal to the supplied value. |
| processInstanceId | `string` | "" | Filter the tasks. Display only tasks with processInstanceId equal to the supplied value. |
| selectFirstRow | `boolean` | true | Toggles default selection of the first row. |
| selectionMode | `string` | "single" | Row selection mode. Can be none, `single` or `multiple`. For `multiple` mode, you can use the Cmd (macOS) or Ctrl (Win) modifier key to toggle selection for multiple rows. |
| sorting | [`TaskListCloudSortingModel`](../../lib/process-services-cloud/src/lib/task-list-cloud/models/task-list-sorting.model.ts)`[]` | | Specifies how the table should be sorted. The parameters are for BE sorting. |
| status | `string` | "" | Filter the tasks. Display only tasks with status equal to the supplied value. |
### Events ### Events
@@ -79,7 +78,7 @@ when the task list is empty:
## Details ## Details
This component displays lists of tasks related to the application name insterted. Extra filtering can be provided by applying extra input parameters This component displays lists of tasks related to the application name insterted. Extra filtering can be provided by applying extra input parameters.
### Setting the column schema ### Setting the column schema
@@ -164,7 +163,7 @@ You can use an HTML-based schema and an `app.config.json` custom schema declarat
### Setting Sorting Order for the list ### Setting Sorting Order for the list
you can pass sorting order as shown in the example below: You can specify a sorting order as shown in the example below:
```ts ```ts
let sorting = { orderBy: 'created', direction: 'desc' }; let sorting = { orderBy: 'created', direction: 'desc' };

29
lib/process-services-cloud/src/lib/task-list-cloud/components/task-list-cloud.component.ts
View File

@@ -41,49 +41,76 @@ export class TaskListCloudComponent extends DataTableSchema implements OnChanges
@ContentChild(EmptyCustomContentDirective) @ContentChild(EmptyCustomContentDirective)
emptyCustomContent: EmptyCustomContentDirective; emptyCustomContent: EmptyCustomContentDirective;
/** The name of the application. */
@Input() @Input()
applicationName: string = ''; applicationName: string = '';
/**
* The assignee of the process. Possible values are: "assignee" (the current user is the assignee),
* "candidate" (the current user is a task candidate", "group_x" (the task is assigned to a group
* where the current user is a member, no value (the current user is involved).
*/
@Input() @Input()
assignee: string = ''; assignee: string = '';
/** Filter the tasks. Display only tasks created on the supplied date. */
@Input() @Input()
createdDate: string = ''; createdDate: string = '';
/** Filter the tasks. Display only tasks with dueDate equal to the supplied date. */
@Input() @Input()
dueDate: string = ''; dueDate: string = '';
/** Filter the tasks. Display only tasks with id equal to the supplied value. */
@Input() @Input()
id: string = ''; id: string = '';
/** Filter the tasks. Display only tasks with the supplied name. */
@Input() @Input()
name: string = ''; name: string = '';
/** Filter the tasks. Display only tasks with parentTaskId equal to the supplied value. */
@Input() @Input()
parentTaskId: string = ''; parentTaskId: string = '';
/** Filter the tasks. Display only tasks with processDefinitionId equal to the supplied value. */
@Input() @Input()
processDefinitionId: string = ''; processDefinitionId: string = '';
/** Filter the tasks. Display only tasks with processInstanceId equal to the supplied value. */
@Input() @Input()
processInstanceId: string = ''; processInstanceId: string = '';
/** Filter the tasks. Display only tasks with status equal to the supplied value. */
@Input() @Input()
status: string = ''; status: string = '';
/** Toggles default selection of the first row. */
@Input() @Input()
selectFirstRow: boolean = true; selectFirstRow: boolean = true;
/**
* Define which task id should be selected after reloading. If the task id doesn't
* exist or nothing is passed then the first task will be selected.
*/
@Input() @Input()
landingTaskId: string; landingTaskId: string;
/**
* Row selection mode. Can be none, `single` or `multiple`. For `multiple` mode,
* you can use the Cmd (macOS) or Ctrl (Win) modifier key to toggle selection for
* multiple rows.
*/
@Input() @Input()
selectionMode: string = 'single'; // none|single|multiple selectionMode: string = 'single'; // none|single|multiple
/** Toggles multiple row selection, renders checkboxes at the beginning of each row */ /** Toggles multiple row selection, rendering a checkbox at the beginning of each row. */
@Input() @Input()
multiselect: boolean = false; multiselect: boolean = false;
/**
* Specifies how the table should be sorted. The parameters are for BE sorting.
*/
@Input() @Input()
sorting: TaskListCloudSortingModel[]; sorting: TaskListCloudSortingModel[];