alfresco-ng2-components/docs/apps-list.component.md
madhukar23 5955cc567d [ADF-2297] App-list - The component shows "No Apps found" until all the apps are loaded (#2945)
* [ADF-2297] When loading the process workspace landing page after login, there is a message "No Apps found" displayed until all the apps are loaded

* Added a template in app-list component to show apps loading status.

* [ADF-2297] When loading the process workspace landing page after login, there is a message "No Apps found" displayed until all the apps are loaded

* Added a template in app-list component to show apps loading status.

* [ADF-2297] When loading the process workspace landing page after login, there is a message "No Apps found" displayed until all the apps are loaded

* Added a template in app-list component to show apps loading status.

* [ADF-2297] When loading the process workspace landing page after login, there is a message "No Apps found" displayed until all the apps are loaded

* Added a template in app-list component to show apps loading status.

* added a way to pass custom no-apps template to adf-apps

* [ADF-2297] When loading the process workspace landing page after login, there is a message "No Apps found" displayed until all the apps are loaded

* Added a template in app-list component to show apps loading status.

* added a way to pass custom no-apps template to adf-apps
2018-02-20 10:25:53 +00:00

73 lines
1.8 KiB
Markdown

# Apps List Component
Shows all available apps.
![how-filter-apps](docassets/images/how-filter-apps.png)
## Basic Usage
```html
<adf-apps
[layoutType]="'GRID'">
</adf-apps>
```
## Passing custom no-apps template
If we intend to show a custom template if there are no apps present
```html
<adf-apps
[layoutType]="'GRID'">
<adf-empty-list>
<div adf-empty-list-header class="adf-empty-list-header">No apps present</div>
</adf-empty-list>
</adf-apps>
```
### Properties
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| layoutType | `string` | `AppsListComponent.LAYOUT_GRID` | (**required**) Defines the layout of the apps. There are two possible values, "GRID" and "LIST". |
| 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
```html
<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.
![how-filter-apps](docassets/images/how-filter-apps.png)
You can use inside the filter one of the following property
```json
{
"defaultAppId": "string",
"deploymentId": "string",
"name": "string",
"id": "number",
"modelId": "number",
"tenantId": "number"
}
```