inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-07-31 17:38:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

[ADF-1769] Added JSDocs and updated prop table script (#2838)

Browse Source 
* [ADF-1769] Added JSDocs and updated prop table script

* [ADF-1769] Fixed lint error in JSDoc
This commit is contained in:
Andy Stark
2018-01-17 17:11:22 +00:00
committed by Eugenio Romano
parent 3461749dc6
commit c9a3b048b4
25 changed files with 194 additions and 100 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
docs/apps-list.component.md
View File

@@ -1,4 +1,4 @@
# Activiti Apps Component
# Apps List Component
Shows all available apps.
@@ -15,15 +15,16 @@ Shows all available apps.
### Properties
| Name | Type | Description |
| --- | --- | --- |
| layoutType | string | (**required**) Define the layout of the apps. There are two possible values: GRID or LIST. |
| filtersAppId | Object | Provide 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".<br/> Default value: `AppsListComponent.LAYOUT_GRID` |
| filtersAppId | `any[]` | Provides a way to filter the apps to show. |
### Events
| Name | Description |
| --- | --- |
| appClick | Raised when an app entry is clicked |
| Name | Type | Description |
| ---- | ---- | ----------- |
| appClick | `EventEmitter<AppDefinitionRepresentationModel>` | Emitted when an app entry is clicked. |
| error | `EventEmitter<any>` | Emitted when an error occurs. |
## Details