mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-05-12 17:04:57 +00:00
900fd70d63
* [ADF-1769] Added prop tables and fixed script * [ADF-1769] Corrected JSDoc formatting errors * [ADF-1769] Restored default column to prop tables
60 lines
1.5 KiB
Markdown
60 lines
1.5 KiB
Markdown
# Apps List Component
|
|
|
|
Shows all available apps.
|
|
|
|
|
|
|
|
## Basic Usage
|
|
|
|
```html
|
|
<adf-apps
|
|
[layoutType]="'GRID'">
|
|
</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.
|
|
|
|
|
|
|
|
You can use inside the filter one of the following property
|
|
|
|
```json
|
|
{
|
|
"defaultAppId": "string",
|
|
"deploymentId": "string",
|
|
"name": "string",
|
|
"id": "number",
|
|
"modelId": "number",
|
|
"tenantId": "number"
|
|
}
|
|
```
|