mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
[ADF-4152] Updated doc folder structure and index tool (#4403)
* [ADF-4152] Initial GraphQL implementation * [ADF-4152] Schema updates * [ADF-4152] Rounded out basic fields * [ADF-4152] Added basic template functionality * [ADF-4152] Added full template generation * [ADF-4152] Moved proc services doc files to new folders * [ADF-4152] Updated README.md with section from new template * [ADF-4152] Fixed another problem with relative URLs * [ADF-4152] Fixed links and some more bugs * [ADF-4152] Removed proc services folder README file
This commit is contained in:
committed by
Eugenio Romano
parent
75b90c5e08
commit
e74f545aa8
82
docs/process-services/components/apps-list.component.md
Normal file
82
docs/process-services/components/apps-list.component.md
Normal file
@@ -0,0 +1,82 @@
|
||||
---
|
||||
Title: Apps List Component
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
Last reviewed: 2019-01-14
|
||||
---
|
||||
|
||||
# [Apps List Component](../../../lib/process-services/app-list/apps-list.component.ts "Defined in apps-list.component.ts")
|
||||
|
||||
Shows all available apps.
|
||||
|
||||

|
||||
|
||||
## Basic Usage
|
||||
|
||||
```html
|
||||
<adf-apps
|
||||
[layoutType]="'GRID'">
|
||||
</adf-apps>
|
||||
```
|
||||
|
||||
### [Transclusions](../../user-guide/transclusion.md)
|
||||
|
||||
You can show custom content when there are no apps available by supplying an
|
||||
`<adf-custom-empty-content>` section:
|
||||
|
||||
```html
|
||||
<adf-apps
|
||||
[layoutType]="'GRID'">
|
||||
<adf-custom-empty-content>
|
||||
No Apps present
|
||||
</adf-custom-empty-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`](https://angular.io/api/core/EventEmitter)`<`[`AppDefinitionRepresentationModel`](../../../lib/process-services/task-list/models/filter.model.ts)`>` | Emitted when an app entry is clicked. |
|
||||
| error | [`EventEmitter`](https://angular.io/api/core/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:
|
||||
|
||||
```json
|
||||
{
|
||||
"defaultAppId": "string",
|
||||
"deploymentId": "string",
|
||||
"name": "string",
|
||||
"id": "number",
|
||||
"modelId": "number",
|
||||
"tenantId": "number"
|
||||
}
|
||||
```
|
||||
|
||||
For example, if you set `filtersAppId` as follows:
|
||||
|
||||
```html
|
||||
<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.
|
||||
|
||||

|
Reference in New Issue
Block a user