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

generate documentation (#7006)

Browse Source
This commit is contained in:
Eugenio Romano
2021-05-10 10:47:48 +01:00
committed by GitHub
parent 2d510776ea
commit d6a4f84161
68 changed files with 235 additions and 195 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
docs/core/components/data-column.component.md
View File

@@ -201,7 +201,6 @@ In the example below we will show capitalised custom name for a column:
<!-- {% endraw %} -->
In the Example below we will integrate the [adf-tag-node-list](../../content-services/components/tag-node-list.component.md) component
within the document list.

10
docs/core/components/datatable.component.md
View File

@@ -369,11 +369,11 @@ Learm more about styling your datatable: [Customizing the component's styles](#c
| Name | Type | Description |
| ---- | ---- | ----------- |
| executeRowAction | `any` | Emitted when the user executes a row action. |
| rowClick | `any` | Emitted when the user clicks a row. |
| rowDblClick | `any` | Emitted when the user double-clicks a row. |
| showRowActionsMenu | `any` | Emitted before the actions menu is displayed for a row. |
| showRowContextMenu | `any` | Emitted before the context menu is displayed for a row. |
| executeRowAction | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataRowActionEvent`](../../../lib/core/datatable/components/data-row-action.event.ts)`>` | Emitted when the user executes a row action. |
| rowClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataRowEvent`](../../../lib/core/datatable/data/data-row-event.model.ts)`>` | Emitted when the user clicks a row. |
| rowDblClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataRowEvent`](../../../lib/core/datatable/data/data-row-event.model.ts)`>` | Emitted when the user double-clicks a row. |
| showRowActionsMenu | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataCellEvent`](../../../lib/core/datatable/components/data-cell.event.ts)`>` | Emitted before the actions menu is displayed for a row. |
| showRowContextMenu | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataCellEvent`](../../../lib/core/datatable/components/data-cell.event.ts)`>` | Emitted before the context menu is displayed for a row. |
## Details

2
docs/core/components/header.component.md
View File

@@ -51,7 +51,7 @@ body of the element:
| Name | Type | Description |
| ---- | ---- | ----------- |
| clicked | `any` | Emitted when the sidenav button is clicked. |
| clicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<boolean>` | Emitted when the sidenav button is clicked. |
## Details

6
docs/core/components/host-settings.component.md
View File

@@ -40,6 +40,6 @@ Validates the URLs for ACS and APS and saves them in the user's local storage
| Name | Type | Description |
| ---- | ---- | ----------- |
| cancel | `any` | Emitted when the user cancels the changes. |
| error | `any` | Emitted when the URL is invalid. |
| success | `any` | Emitted when the changes are successfully applied. |
| cancel | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<boolean>` | Emitted when the user cancels the changes. |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string>` | Emitted when the URL is invalid. |
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<boolean>` | Emitted when the changes are successfully applied. |

2
docs/core/components/login-dialog-panel.component.md
View File

@@ -15,7 +15,7 @@ Shows and manages a login dialog.
| Name | Type | Description |
| ---- | ---- | ----------- |
| success | `any` | Emitted when the login succeeds. |
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`LoginSuccessEvent`](../../../lib/core/login/models/login-success.event.ts)`>` | Emitted when the login succeeds. |
## Details

6
docs/core/components/login.component.md
View File

@@ -92,9 +92,9 @@ with custom input fields handled by your application or parent component:
| Name | Type | Description |
| ---- | ---- | ----------- |
| error | `any` | Emitted when the login fails. |
| executeSubmit | `any` | Emitted when the login form is submitted. |
| success | `any` | Emitted when the login is successful. |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`LoginErrorEvent`](../../../lib/core/login/models/login-error.event.ts)`>` | Emitted when the login fails. |
| executeSubmit | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`LoginSubmitEvent`](../../../lib/core/login/models/login-submit.event.ts)`>` | Emitted when the login form is submitted. |
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`LoginSuccessEvent`](../../../lib/core/login/models/login-success.event.ts)`>` | Emitted when the login is successful. |
## Details

10
docs/core/components/pagination.component.md
View File

@@ -50,11 +50,11 @@ Adds pagination to the component it is used with.
| Name | Type | Description |
| ---- | ---- | ----------- |
| change | `any` | Emitted when pagination changes in any way. |
| changePageNumber | `any` | Emitted when the page number changes. |
| changePageSize | `any` | Emitted when the page size changes. |
| nextPage | `any` | Emitted when the next page is requested. |
| prevPage | `any` | Emitted when the previous page is requested. |
| change | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PaginationModel`](../../../lib/core/models/pagination.model.ts)`>` | Emitted when pagination changes in any way. |
| changePageNumber | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PaginationModel`](../../../lib/core/models/pagination.model.ts)`>` | Emitted when the page number changes. |
| changePageSize | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PaginationModel`](../../../lib/core/models/pagination.model.ts)`>` | Emitted when the page size changes. |
| nextPage | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PaginationModel`](../../../lib/core/models/pagination.model.ts)`>` | Emitted when the next page is requested. |
| prevPage | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PaginationModel`](../../../lib/core/models/pagination.model.ts)`>` | Emitted when the previous page is requested. |
## Details

2
docs/core/components/sidenav-layout.component.md
View File

@@ -80,7 +80,7 @@ sub-components (note the use of `<ng-template>` in the sub-components' body sect
| Name | Type | Description |
| ---- | ---- | ----------- |
| expanded | `any` | Emitted when the menu toggle and the collapsed/expanded state of the sideNav changes. |
| expanded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<boolean>` | Emitted when the menu toggle and the collapsed/expanded state of the sideNav changes. |
## Details

4
docs/core/components/sorting-picker.component.md
View File

@@ -36,8 +36,8 @@ Selects from a set of predefined sorting definitions and directions.
| Name | Type | Description |
| ---- | ---- | ----------- |
| sortingChange | `any` | Raised each time direction gets changed. |
| valueChange | `any` | Raised each time sorting key gets changed. |
| sortingChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<boolean>` | Raised each time direction gets changed. |
| valueChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string>` | Raised each time sorting key gets changed. |
## Details

14
docs/core/components/viewer.component.md
View File

@@ -109,13 +109,13 @@ See the [Custom layout](#custom-layout) section for full details of all availabl
| Name | Type | Description |
| ---- | ---- | ----------- |
| extensionChange | `any` | Emitted when the filename extension changes. |
| goBack | `any` | Emitted when user clicks the 'Back' button. |
| invalidSharedLink | `any` | Emitted when the shared link used is not valid. |
| navigateBefore | `any` | Emitted when user clicks 'Navigate Before' ("&lt;") button. |
| navigateNext | `any` | Emitted when user clicks 'Navigate Next' (">") button. |
| print | `any` | Emitted when user clicks the 'Print' button. |
| showViewerChange | `any` | Emitted when the viewer is shown or hidden. |
| extensionChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string>` | Emitted when the filename extension changes. |
| goBack | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`BaseEvent`](../../../lib/core/events/base.event.ts)`<any>>` | Emitted when user clicks the 'Back' button. |
| invalidSharedLink | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the shared link used is not valid. |
| navigateBefore | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<MouseEvent \| KeyboardEvent>` | Emitted when user clicks 'Navigate Before' ("&lt;") button. |
| navigateNext | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<MouseEvent \| KeyboardEvent>` | Emitted when user clicks 'Navigate Next' (">") button. |
| print | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`BaseEvent`](../../../lib/core/events/base.event.ts)`<any>>` | Emitted when user clicks the 'Print' button. |
| showViewerChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<boolean>` | Emitted when the viewer is shown or hidden. |
## Keyboard shortcuts