Return to Builder Network Home

Apps List Component

Shows all available apps.

how-filter-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-custom-empty-content> section:

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

Class members

Properties

NameTypeDefault valueDescription
filtersAppIdany[]Provides a way to filter the apps to show.
layoutTypestring(required) Defines the layout of the apps. There are two possible values, "GRID" and "LIST".

Events

NameTypeDescription
appClickEventEmitter<AppDefinitionRepresentationModel>Emitted when an app entry is clicked.
errorEventEmitter<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.

how-filter-apps

Github iconEdit on github

© 2023 Alfresco Software, Inc. All Rights Reserved.