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

Andy Stark 2c49de6070 [ADF-3514] Added transclusions sections to doc files (#3756 )

* [ADF-3514] Added transclusion sections and guide page

* [ADF-3514] Updated tables of contents where needed

* [ADF-3514] Updated index files

2018-09-10 11:11:25 +01:00

2.1 KiB

Raw Blame History

Added, Status, Last reviewed

Added	Status	Last reviewed
v2.0.0	Active	2018-06-08

Apps List Component

Shows all available apps.

Basic Usage

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

Transclusions

You can show custom content when there are no apps available by supplying an <adf-empty-custom-content> section:

<adf-apps
    [layoutType]="'GRID'">
        <adf-empty-custom-content>
            No Apps present
        </adf-empty-custom-content>
</adf-apps>

Class members

Properties

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

Events

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

Details

You can specify a restricted list of apps using the filtersAppId property. This array contains a list of objects containing the property values you are interested in. You can use any of the following properties as filters:

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

For example, if you set filtersAppId as follows:

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

...then only the Tasks app, the app with deploymentId 15037 and the app with "my app name" will be shown.

2.1 KiB Raw Blame History