From a193c2383c225d7b6adf445c81f119a38a3aeb05 Mon Sep 17 00:00:00 2001 From: Andy Stark <30621568+therealandeeee@users.noreply.github.com> Date: Wed, 28 Nov 2018 14:45:18 +0000 Subject: [PATCH] [ADF-3764] Added doc comments for task filters cloud (#4023) --- .../task-filters-cloud.component.md | 6 +++--- .../task-filters-cloud/task-filters-cloud.component.ts | 10 +++++++++- 2 files changed, 12 insertions(+), 4 deletions(-) diff --git a/docs/process-services-cloud/task-filters-cloud.component.md b/docs/process-services-cloud/task-filters-cloud.component.md index 428c6ced4f..137bca9b79 100644 --- a/docs/process-services-cloud/task-filters-cloud.component.md +++ b/docs/process-services-cloud/task-filters-cloud.component.md @@ -22,8 +22,8 @@ Shows all available filters. | Name | Type | Default value | Description | | ---- | ---- | ------------- | ----------- | | appName | `string` | | Display filters available to the current user for the application with the specified name. | -| filterParam | [`FilterParamsModel`](../../lib/process-services-cloud/src/lib/task-cloud/models/filter-cloud.model.ts) | | Parameters to use for the task filter cloud. If there is no match then the default filter (the first one the list) is selected. | -| showIcon | `boolean` | | Toggles display of the filter's icon. | +| filterParam | [`FilterParamsModel`](../../lib/process-services/task-list/models/filter.model.ts) | | Parameters to use for the task filter cloud. If there is no match then the default filter (the first one in the list) is selected. | +| showIcons | `boolean` | false | Toggles display of the filter's icons. | ### Events @@ -45,7 +45,7 @@ Use the `filterParam` property to restrict the range of filters that are shown: ``` -You can use properties from [`FilterParamsModel`](../../lib/process-services-cloud/src/lib/task-cloud/models/filter-cloud.model.ts) +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: | Name | Type | Description | diff --git a/lib/process-services-cloud/src/lib/task-cloud/task-filters-cloud/task-filters-cloud.component.ts b/lib/process-services-cloud/src/lib/task-cloud/task-filters-cloud/task-filters-cloud.component.ts index 762c7ab05d..e028f1ecab 100644 --- a/lib/process-services-cloud/src/lib/task-cloud/task-filters-cloud/task-filters-cloud.component.ts +++ b/lib/process-services-cloud/src/lib/task-cloud/task-filters-cloud/task-filters-cloud.component.ts @@ -26,22 +26,30 @@ import { TranslationService } from '@alfresco/adf-core'; styleUrls: ['task-filters-cloud.component.scss'] }) export class TaskFiltersCloudComponent implements OnChanges { - + /** Display filters available to the current user for the application with the specified name. */ @Input() appName: string; + /** + * Parameters to use for the task filter cloud. If there is no match then the default filter + * (the first one in the list) is selected. + */ @Input() filterParam: FilterParamsModel; + /** Toggles display of the filter's icons. */ @Input() showIcons: boolean = false; + /** Emitted when a filter in the list is clicked. */ @Output() filterClick: EventEmitter = new EventEmitter(); + /** Emitted when the list is loaded. */ @Output() success: EventEmitter = new EventEmitter(); + /** Emitted when an error occurs during loading. */ @Output() error: EventEmitter = new EventEmitter();