inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-05-19 17:14:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

[ADF-3764] Added doc comments for task filters cloud (#4023)

Browse Source
This commit is contained in:
Andy Stark 2018-11-28 14:45:18 +00:00 committed by Eugenio Romano
parent 1a21f234b6
commit a193c2383c
2 changed files with 12 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -22,8 +22,8 @@ Shows all available filters.
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- | | ---- | ---- | ------------- | ----------- |
| appName | `string` | | Display filters available to the current user for the application with the specified name. | | 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. | | 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. |
| showIcon | `boolean` | | Toggles display of the filter's icon. | | showIcons | `boolean` | false | Toggles display of the filter's icons. |
### Events ### Events
@ -45,7 +45,7 @@ Use the `filterParam` property to restrict the range of filters that are shown:
</adf-cloud-task-filters> </adf-cloud-task-filters>
``` ```
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: as the value of `filterParam` as shown in the table below:
| Name | Type | Description | | Name | Type | Description |

10
lib/process-services-cloud/src/lib/task-cloud/task-filters-cloud/task-filters-cloud.component.ts
View File

@ -26,22 +26,30 @@ import { TranslationService } from '@alfresco/adf-core';
styleUrls: ['task-filters-cloud.component.scss'] styleUrls: ['task-filters-cloud.component.scss']
}) })
export class TaskFiltersCloudComponent implements OnChanges { export class TaskFiltersCloudComponent implements OnChanges {
/** Display filters available to the current user for the application with the specified name. */
@Input() @Input()
appName: string; 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() @Input()
filterParam: FilterParamsModel; filterParam: FilterParamsModel;
/** Toggles display of the filter's icons. */
@Input() @Input()
showIcons: boolean = false; showIcons: boolean = false;
/** Emitted when a filter in the list is clicked. */
@Output() @Output()
filterClick: EventEmitter<TaskFilterCloudRepresentationModel> = new EventEmitter<TaskFilterCloudRepresentationModel>(); filterClick: EventEmitter<TaskFilterCloudRepresentationModel> = new EventEmitter<TaskFilterCloudRepresentationModel>();
/** Emitted when the list is loaded. */
@Output() @Output()
success: EventEmitter<any> = new EventEmitter<any>(); success: EventEmitter<any> = new EventEmitter<any>();
/** Emitted when an error occurs during loading. */
@Output() @Output()
error: EventEmitter<any> = new EventEmitter<any>(); error: EventEmitter<any> = new EventEmitter<any>();