mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-05-12 17:04:57 +00:00

Andy Stark c9a3b048b4 [ADF-1769] Added JSDocs and updated prop table script (#2838 )

* [ADF-1769] Added JSDocs and updated prop table script

* [ADF-1769] Fixed lint error in JSDoc

2018-01-17 17:11:22 +00:00

1.4 KiB

Raw Blame History

Apps List Component

Shows all available apps.

Basic Usage

<adf-apps 
    [layoutType]="'GRID'">
</adf-apps>

Properties

Name	Type	Description
layoutType	`string`	(required) Defines the layout of the apps. There are two possible values, "GRID" and "LIST". Default value: `AppsListComponent.LAYOUT_GRID`
filtersAppId	`any[]`	Provides a way to filter the apps to show.

Events

Name	Type	Description
appClick	`EventEmitter<AppDefinitionRepresentationModel>`	Emitted when an app entry is clicked.
error	`EventEmitter<any>`	Emitted when an error occurs.

Details

How filter the activiti apps

If you want to show some specific apps you can specify them through the filtersAppId parameters

<adf-apps 
    [filtersAppId]="'[
        {defaultAppId: 'tasks'}, 
        {deploymentId: '15037'}, 
        {name : 'my app name'}]'">
</adf-apps>

In this specific case only the Tasks app, the app with deploymentId 15037 and the app with "my app name" will be shown.

You can use inside the filter one of the following property

{ 
    "defaultAppId": "string", 
    "deploymentId": "string", 
    "name": "string", 
    "id": "number", 
    "modelId": "number",
    "tenantId": "number"
}

1.4 KiB Raw Blame History