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

Documentation build (#6762)

Browse Source 
* move doc dependency in doctools

* add ignore link

* rebuild doc

* version index

* put it back some deps
This commit is contained in:
Eugenio Romano
2021-03-03 14:08:15 +00:00
committed by GitHub
parent e05c80f04f
commit c3452a4f62
227 changed files with 6994 additions and 4146 deletions
Download Patch File Download Diff File Expand all files Collapse all files

202
docs/core/components/card-view.component.md
View File

@@ -107,7 +107,7 @@ Defining properties from Typescript:
### Properties
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| ---- | ---- | ------------- | ----------- |
| copyToClipboardAction | `boolean` | true | Toggles whether or not to enable copy to clipboard action. |
| displayClearAction | `boolean` | true | Toggles whether or not to display clear action. |
| displayEmpty | `boolean` | true | Toggles whether or not to show empty items in non-editable mode. |
@@ -121,16 +121,16 @@ Defining properties from Typescript:
You define the property list, the [`CardViewComponent`](../../core/components/card-view.component.md) does the rest. Each property represents a card view item (a row) in the [card view component](card-view.component.md). The following item types are available by default:
* [**CardViewTextItemModel**](#card-text-item) - *for text items*
* [**CardViewMapItemModel**](#card-map-item) - *for map items*
* [**CardViewDateItemModel**](#card-date-item) - *for date items*
* [**CardViewDatetimeItemModel**](#card-datetime-item) - *for datetime items*
* [**CardViewBoolItemModel**](#card-bool-item) - *for bool items (checkbox)*
* [**CardViewIntItemModel**](#card-int-item) - *for integer items*
* [**CardViewFloatItemModel**](#card-float-item) - *for float items*
* [**CardViewKeyValuePairsItemModel**](#card-key-value-pairs-item) - *for key-value-pairs items*
* [**CardViewSelectItemModel**](#card-select-item) - *for select items*
* [**CardViewArrayItemModel**](#card-array-item) - *for array items*
- [**CardViewTextItemModel**](#card-text-item) - _for text items_
- [**CardViewMapItemModel**](#card-map-item) - _for map items_
- [**CardViewDateItemModel**](#card-date-item) - _for date items_
- [**CardViewDatetimeItemModel**](#card-datetime-item) - _for datetime items_
- [**CardViewBoolItemModel**](#card-bool-item) - _for bool items (checkbox)_
- [**CardViewIntItemModel**](#card-int-item) - _for integer items_
- [**CardViewFloatItemModel**](#card-float-item) - _for float items_
- [**CardViewKeyValuePairsItemModel**](#card-key-value-pairs-item) - _for key-value-pairs items_
- [**CardViewSelectItemModel**](#card-select-item) - _for select items_
- [**CardViewArrayItemModel**](#card-array-item) - _for array items_
Each of these types implements the [Card View Item interface](../interfaces/card-view-item.interface.md):
@@ -156,8 +156,8 @@ this.
You can optionally set up the card view so that its properties can be edited. You can control
the editing of properties at two levels:
* **Global level** - *via the editable parameter of the card-view.component*
* **[`Property`](../../../lib/content-services/src/lib/content-metadata/interfaces/property.interface.ts) level** - *in each property via the editable attribute*
- **Global level** - _via the editable parameter of the card-view.component_
- **[`Property`](../../../lib/content-services/src/lib/content-metadata/interfaces/property.interface.ts) level** - _in each property via the editable attribute_
If you set the global editable parameter to false, no properties can be edited regardless of their
individual `editable` settings.
@@ -182,22 +182,22 @@ specific data types, as described below.
const textItemProperty = new CardViewTextItemModel(options);
```
| Name | Type | Default | Description |
| ----------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------ |
| label\* | string | | Item label |
| value\* | any | | The original data value for the item |
| key\* | string | | Identifying key (important when editing the item) |
| default | any | | The default value to display if the value is empty |
| displayValue\* | string | | The value to display |
| editable | boolean | false | Toggles whether the item is editable |
| clickable | boolean | false | Toggles whether the property responds to clicks |
| clickableCallBack | function | null | Function to execute when click the element |
| copyToClipboardAction | `boolean` | true | Toggles whether or not to enable copy to clipboard action. |
| useChipsForMultiValueProperty | `boolean` | true | Toggles whether or not to enable chips for multivalued properties. |
| multiValueSeparator | `string` | ',' | String separator between multi-value property items. |
| icon | string | | The material icon to show beside the item if it is clickable |
| multiline | boolean | false | Single or multiline text |
| pipes | [`CardViewTextItemPipeProperty`](../../../lib/core/card-view/interfaces/card-view-textitem-pipe-property.interface.ts)\[] | \[] | Pipes to be applied to the text before display |
| Name | Type | Default | Description |
| ---- | ---- | ------- | ----------- |
| label\* | string | | Item label |
| value\* | any | | The original data value for the item |
| key\* | string | | Identifying key (important when editing the item) |
| default | any | | The default value to display if the value is empty |
| displayValue\* | string | | The value to display |
| editable | boolean | false | Toggles whether the item is editable |
| clickable | boolean | false | Toggles whether the property responds to clicks |
| clickableCallBack | function | null | Function to execute when click the element |
| copyToClipboardAction | `boolean` | true | Toggles whether or not to enable copy to clipboard action. |
| useChipsForMultiValueProperty | `boolean` | true | Toggles whether or not to enable chips for multivalued properties. |
| multiValueSeparator | `string` | ',' | String separator between multi-value property items. |
| icon | string | | The material icon to show beside the item if it is clickable |
| multiline | boolean | false | Single or multiline text |
| pipes | [`CardViewTextItemPipeProperty`](../../../lib/core/card-view/interfaces/card-view-textitem-pipe-property.interface.ts)\[] | \[] | Pipes to be applied to the text before display |
##### Using pipes with a Card Text Item
@@ -227,14 +227,14 @@ new CardViewTextItemModel({
const mapItemProperty = new CardViewMapItemModel(options);
```
| Name | Type | Default | Description |
| -------------- | ------- | ------- | -------------------------------------------------- |
| label\* | string | | Item label |
| value\* | Map | | A map that contains the key value pairs |
| key\* | string | | Identifying key (important when editing the item) |
| default | any | | The default value to display if the value is empty |
| displayValue\* | string | | The value to display |
| clickable | boolean | false | Toggles whether the property responds to clicks |
| Name | Type | Default | Description |
| ---- | ---- | ------- | ----------- |
| label\* | string | | Item label |
| value\* | Map | | A map that contains the key value pairs |
| key\* | string | | Identifying key (important when editing the item) |
| default | any | | The default value to display if the value is empty |
| displayValue\* | string | | The value to display |
| clickable | boolean | false | Toggles whether the property responds to clicks |
#### Card Date Item
@@ -244,16 +244,16 @@ const mapItemProperty = new CardViewMapItemModel(options);
const dateItemProperty = new CardViewDateItemModel(options);
```
| Name | Type | Default | Description |
| --------------------- | --------- | ------------- | ---------------------------------------------------------- |
| label\* | string | | Item label |
| value\* | any | | The original data value for the item |
| copyToClipboardAction | `boolean` | true | Toggles whether or not to enable copy to clipboard action. |
| key\* | string | | Identifying key (important when editing the item) |
| default | any | | The default value to display if the value is empty |
| displayValue\* | any | | The value to display |
| editable | boolean | false | Toggles whether the item is editable |
| format | string | "MMM DD YYYY" | Any date format that momentjs accepts |
| Name | Type | Default | Description |
| ---- | ---- | ------- | ----------- |
| label\* | string | | Item label |
| value\* | any | | The original data value for the item |
| copyToClipboardAction | `boolean` | true | Toggles whether or not to enable copy to clipboard action. |
| key\* | string | | Identifying key (important when editing the item) |
| default | any | | The default value to display if the value is empty |
| displayValue\* | any | | The value to display |
| editable | boolean | false | Toggles whether the item is editable |
| format | string | "MMM DD YYYY" | Any date format that momentjs accepts |
#### Card Datetime Item
@@ -263,15 +263,15 @@ const dateItemProperty = new CardViewDateItemModel(options);
const datetimeItemProperty = new CardViewDatetimeItemModel(options);
```
| Name | Type | Default | Description |
| -------------- | ------- | ------------------- | -------------------------------------------------- |
| label\* | string | | Item label |
| value\* | any | | The original data value for the item |
| key\* | string | | Identifying key (important when editing the item) |
| default | any | any | The default value to display if the value is empty |
| displayValue\* | string | | The value to display |
| editable | boolean | false | Toggles whether the item is editable |
| format | string | "MMM DD YYYY HH:mm" | Any datetime format that momentjs accepts |
| Name | Type | Default | Description |
| ---- | ---- | ------- | ----------- |
| label\* | string | | Item label |
| value\* | any | | The original data value for the item |
| key\* | string | | Identifying key (important when editing the item) |
| default | any | any | The default value to display if the value is empty |
| displayValue\* | string | | The value to display |
| editable | boolean | false | Toggles whether the item is editable |
| format | string | "MMM DD YYYY HH:mm" | Any datetime format that momentjs accepts |
#### Card Bool Item
@@ -281,14 +281,14 @@ const datetimeItemProperty = new CardViewDatetimeItemModel(options);
const boolItemProperty = new CardViewBoolItemModel(options);
```
| Name | Type | Default | Description |
| -------------- | ------- | ------- | -------------------------------------------------- |
| label\* | string | | Item label |
| value\* | boolean | | The original data value for the item |
| key\* | string | | Identifying key (important when editing the item) |
| default | boolean | false | The default value to display if the value is empty |
| displayValue\* | boolean | | The value to display |
| editable | boolean | false | Toggles whether the item is editable |
| Name | Type | Default | Description |
| ---- | ---- | ------- | ----------- |
| label\* | string | | Item label |
| value\* | boolean | | The original data value for the item |
| key\* | string | | Identifying key (important when editing the item) |
| default | boolean | false | The default value to display if the value is empty |
| displayValue\* | boolean | | The value to display |
| editable | boolean | false | Toggles whether the item is editable |
#### Card Int Item
@@ -298,14 +298,14 @@ const boolItemProperty = new CardViewBoolItemModel(options);
const intItemProperty = new CardViewIntItemModel(options);
```
| Name | Type | Default | Description |
| -------------- | ------- | ------- | -------------------------------------------------- |
| label\* | string | | Item label |
| value\* | integer | | The original data value for the item |
| key\* | string | | Identifying key (important when editing the item) |
| default | integer | | The default value to display if the value is empty |
| displayValue\* | integer | | The value to display |
| editable | boolean | false | Toggles whether the item is editable |
| Name | Type | Default | Description |
| ---- | ---- | ------- | ----------- |
| label\* | string | | Item label |
| value\* | integer | | The original data value for the item |
| key\* | string | | Identifying key (important when editing the item) |
| default | integer | | The default value to display if the value is empty |
| displayValue\* | integer | | The value to display |
| editable | boolean | false | Toggles whether the item is editable |
#### Card Float Item
@@ -315,14 +315,14 @@ const intItemProperty = new CardViewIntItemModel(options);
const floatItemProperty = new CardViewFloatItemModel(options);
```
| Name | Type | Default | Description |
| -------------- | ------- | ------- | -------------------------------------------------- |
| label\* | string | | Item label |
| value\* | float | | The original data value for the item |
| key\* | string | | Identifying key (important when editing the item) |
| default | float | | The default value to display if the value is empty |
| displayValue\* | float | | The value to display |
| editable | boolean | false | Toggles whether the item is editable |
| Name | Type | Default | Description |
| ---- | ---- | ------- | ----------- |
| label\* | string | | Item label |
| value\* | float | | The original data value for the item |
| key\* | string | | Identifying key (important when editing the item) |
| default | float | | The default value to display if the value is empty |
| displayValue\* | float | | The value to display |
| editable | boolean | false | Toggles whether the item is editable |
#### Card Key Value Pairs Item
@@ -332,12 +332,12 @@ const floatItemProperty = new CardViewFloatItemModel(options);
const keyValuePairsItemProperty = new CardViewKeyValuePairsItemModel(options);
```
| Name | Type | Default | Description |
| -------- | -------------------------------- | ------- | ------------------------------------------------- |
| label\* | string | | Item label |
| key\* | string | | Identifying key (important when editing the item) |
| editable | boolean | false | Toggles whether the item is editable |
| value\* | `[{ name: '', value: '' }, ...]` | | The original data value for the item |
| Name | Type | Default | Description |
| ---- | ---- | ------- | ----------- |
| label\* | string | | Item label |
| key\* | string | | Identifying key (important when editing the item) |
| editable | boolean | false | Toggles whether the item is editable |
| value\* | `[{ name: '', value: '' }, ...]` | | The original data value for the item |
#### Card Select Item
@@ -347,13 +347,13 @@ const keyValuePairsItemProperty = new CardViewKeyValuePairsItemModel(options);
const selectItemProperty = new CardViewSelectItemModel(options);
```
| Name | Type | Default | Description |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------- | ------------------------------------------------- |
| label\* | string | | Item label |
| key\* | string | | Identifying key (important when editing the item) |
| editable | boolean | false | Toggles whether the item is editable |
| value | string | | The original data value for the item |
| options$\* | [`Observable`](http://reactivex.io/documentation/observable.html)<[`CardViewSelectItemOption`](../../../lib/core/card-view/interfaces/card-view-selectitem-properties.interface.ts)\[]> | | The original data value for the item |
| Name | Type | Default | Description |
| ---- | ---- | ------- | ----------- |
| label\* | string | | Item label |
| key\* | string | | Identifying key (important when editing the item) |
| editable | boolean | false | Toggles whether the item is editable |
| value | string | | The original data value for the item |
| options$\* | [`Observable`](http://reactivex.io/documentation/observable.html)&lt;[`CardViewSelectItemOption`](../../../lib/core/card-view/interfaces/card-view-selectitem-properties.interface.ts)\[]> | | The original data value for the item |
#### Card Array Item
@@ -363,14 +363,14 @@ const selectItemProperty = new CardViewSelectItemModel(options);
const arrayItemProperty = new CardViewArrayItemModel(items);
```
| Name | Type | Default | Description |
| -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | ------------------------------------------------- |
| label\* | string | | Item label |
| key\* | string | | Identifying key (important when editing the item) |
| editable | boolean | false | Toggles whether the item is editable |
| value | [`Observable`](http://reactivex.io/documentation/observable.html)<[`CardViewArrayItem`](../../../lib/core/card-view/models/card-view-arrayitem.model.ts)\[]> | | The original data value for the item |
| Name | Type | Default | Description |
| ---- | ---- | ------- | ----------- |
| label\* | string | | Item label |
| key\* | string | | Identifying key (important when editing the item) |
| editable | boolean | false | Toggles whether the item is editable |
| value | [`Observable`](http://reactivex.io/documentation/observable.html)&lt;[`CardViewArrayItem`](../../../lib/core/card-view/models/card-view-arrayitem.model.ts)\[]> | | The original data value for the item |
## See also
* [Card View Update service](../services/card-view-update.service.md)
* [Card View Item interface](../interfaces/card-view-item.interface.md)
- [Card View Update service](../services/card-view-update.service.md)
- [Card View Item interface](../interfaces/card-view-item.interface.md)

4
docs/core/components/comment-list.component.md
View File

@@ -64,11 +64,11 @@ In the component template use the [comment list component](comment-list.componen
### Properties
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| ---- | ---- | ------------- | ----------- |
| comments | [`CommentModel`](../../../lib/core/models/comment.model.ts)`[]` | | The comments data used to populate the list. |
### Events
| Name | Type | Description |
| --- | --- | --- |
| ---- | ---- | ----------- |
| clickRow | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`CommentModel`](../../../lib/core/models/comment.model.ts)`>` | Emitted when the user clicks on one of the comment rows. |

4
docs/core/components/comments.component.md
View File

@@ -33,7 +33,7 @@ Displays comments from users involved in a specified task or content and allows
### Properties
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| ---- | ---- | ------------- | ----------- |
| nodeId | `string` | | The numeric ID of the node. |
| readOnly | `boolean` | false | Are the comments read only? |
| taskId | `string` | | The numeric ID of the task. |
@@ -41,5 +41,5 @@ Displays comments from users involved in a specified task or content and allows
### Events
| Name | Type | Description |
| --- | --- | --- |
| ---- | ---- | ----------- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs while displaying/adding a comment. |

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

@@ -11,17 +11,17 @@ Defines column properties for DataTable, Tasklist, Document List and other compo
## Contents
* [Basic Usage](#basic-usage)
* [Class members](#class-members)
* [Properties](#properties)
* [Details](#details)
* [Conditional visibility](#conditional-visibility)
* [Automatic column header translation](#automatic-column-header-translation)
* [Custom tooltips](#custom-tooltips)
* [Column Template](#column-template)
* [Styling Techniques](#styling-techniques)
* [Using the copyContent option](#using-the-copycontent-option)
* [See also](#see-also)
- [Basic Usage](#basic-usage)
- [Class members](#class-members)
- [Properties](#properties)
- [Details](#details)
- [Conditional visibility](#conditional-visibility)
- [Automatic column header translation](#automatic-column-header-translation)
- [Custom tooltips](#custom-tooltips)
- [Column Template](#column-template)
- [Styling Techniques](#styling-techniques)
- [Using the copyContent option](#using-the-copycontent-option)
- [See also](#see-also)
## Basic Usage
@@ -42,7 +42,7 @@ Defines column properties for DataTable, Tasklist, Document List and other compo
### Properties
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| ---- | ---- | ------------- | ----------- |
| copyContent | `boolean` | | Enables/disables a [Clipboard directive](../../core/directives/clipboard.directive.md) to allow copying of cell contents. |
| cssClass | `string` | | Additional CSS class to be applied to column (header and cells). |
| editable | `boolean` | false | Toggles the editing support of the column data. |
@@ -124,11 +124,11 @@ You can provide custom column/cell templates that may contain other Angular comp
Every cell in the DataTable component is bound to the dynamic data context containing the following properties:
| Name | Type | Description |
| ---- | --------------------------------------------------------------------------- | ----------------------------- |
| data | [`DataTableAdapter`](../../../lib/core/datatable/data/datatable-adapter.ts) | Data adapter instance. |
| row | [`DataRow`](../../../lib/core/datatable/data/data-row.model.ts) | Current data row instance. |
| col | [`DataColumn`](../../../lib/core/datatable/data/data-column.model.ts) | Current data column instance. |
| Name | Type | Description |
| ---- | ---- | ----------- |
| data | [`DataTableAdapter`](../../../lib/core/datatable/data/datatable-adapter.ts) | Data adapter instance. |
| row | [`DataRow`](../../../lib/core/datatable/data/data-row.model.ts) | Current data row instance. |
| col | [`DataColumn`](../../../lib/core/datatable/data/data-column.model.ts) | Current data column instance. |
You can use all three properties to gain full access to underlying data from within your custom templates.
In order to wire HTML templates with the data context you will need to define a variable that is bound to `$implicit` as shown below:
@@ -334,6 +334,6 @@ HTML `<data-column>` element example:
## See also
* [Document list component](../../content-services/components/document-list.component.md)
* [Datatable component](datatable.component.md)
* [Task list component](../../process-services/components/task-list.component.md)
- [Document list component](../../content-services/components/document-list.component.md)
- [Datatable component](datatable.component.md)
- [Task list component](../../process-services/components/task-list.component.md)

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

@@ -15,21 +15,21 @@ See it live: [DataTable Quickstart](https://embed.plnkr.co/80qr4YFBeHjLMdAV0F6l/
## Contents
* [Basic usage](#basic-usage)
* [Setting the rows and column schema](#setting-the-rows-and-column-schema)
* [Transclusions](#transclusions)
* [Class members](#class-members)
* [Properties](#properties)
* [Events](#events)
* [Details](#details)
* [Supplying data for the table](#supplying-data-for-the-table)
* [Customizing columns](#customizing-columns)
* [DataTable DOM Events](#datatable-dom-events)
* [Card view](#card-view)
* [Using events](#using-events)
* [Customizing the component's styles](#customizing-the-components-styles)
* [Resolver Function](#resolver-function)
* [See also](#see-also)
- [Basic usage](#basic-usage)
- [Setting the rows and column schema](#setting-the-rows-and-column-schema)
- [Transclusions](#transclusions)
- [Class members](#class-members)
- [Properties](#properties)
- [Events](#events)
- [Details](#details)
- [Supplying data for the table](#supplying-data-for-the-table)
- [Customizing columns](#customizing-columns)
- [DataTable DOM Events](#datatable-dom-events)
- [Card view](#card-view)
- [Using events](#using-events)
- [Customizing the component's styles](#customizing-the-components-styles)
- [Resolver Function](#resolver-function)
- [See also](#see-also)
## Basic usage
@@ -343,7 +343,7 @@ Learm more about styling your datatable: [Customizing the component's styles](#c
### Properties
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| ---- | ---- | ------------- | ----------- |
| actions | `boolean` | false | Toggles the data actions column. |
| actionsPosition | `string` | "right" | Position of the actions dropdown menu. Can be "left" or "right". |
| allowFiltering | `boolean` | false | Flag that indicate if the datatable allow the use facet [widget](../../../lib/testing/src/lib/core/pages/form/widgets/widget.ts) search for filtering. |
@@ -361,19 +361,19 @@ Learm more about styling your datatable: [Customizing the component's styles](#c
| rowStyleClass | `string` | "" | The CSS class to apply to every row. |
| rows | `any[]` | \[] | The rows that the datatable will show. |
| selectionMode | `string` | "single" | Row selection mode. Can be none, `single` or `multiple`. For `multiple` mode, you can use Cmd (macOS) or Ctrl (Win) modifier key to toggle selection for multiple rows. |
| showHeader | `string` | ShowHeaderMode.Data | Toggles the header. |
| sorting | `any[]` | \[] | Define the sort order of the datatable. Possible values are : \[`created`, `desc`], \[`created`, `asc`], \[`due`, `desc`], \[`due`, `asc`] |
| showHeader | `string` | | Toggles the header. |
| sorting | `any[]` | \[] | Define the sort order of the datatable. Possible values are : [`created`, `desc`], [`created`, `asc`], [`due`, `desc`], [`due`, `asc`] |
| stickyHeader | `boolean` | false | Toggles the sticky header mode. |
### Events
| Name | Type | Description |
| --- | --- | --- |
| 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<DataRowEvent>` | Emitted when the user double-clicks a row. |
| showRowActionsMenu | `EventEmitter<DataCellEvent>` | Emitted before the actions menu is displayed for a row. |
| showRowContextMenu | `EventEmitter<DataCellEvent>` | Emitted before the context menu is displayed for a row. |
| ---- | ---- | ----------- |
| 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. |
## Details
@@ -395,18 +395,18 @@ for more information.
Below are the DOM events emitted by the DataTable component.
These events bubble up the component tree and can be handled by any parent component.
| Name | Description |
| --------------- | ---------------------------------------------------- |
| row-click | Raised when user clicks a row |
| row-dblclick | Raised when user double-clicks a row |
| row-select | Raised after user selects a row |
| row-unselect | Raised after user unselects a row |
| row-keyup | Raised on the 'keyup' event for the focused row. |
| Name | Description |
| ---- | ----------- |
| row-click | Raised when user clicks a row |
| row-dblclick | Raised when user double-clicks a row |
| row-select | Raised after user selects a row |
| row-unselect | Raised after user unselects a row |
| row-keyup | Raised on the 'keyup' event for the focused row. |
| sorting-changed | Raised after user clicks the sortable column header. |
| header-dragover | Raised when dragging content over the header. |
| header-drop | Raised when data is dropped on the column header. |
| cell-dragover | Raised when dragging data over the cell. |
| cell-drop | Raised when data is dropped on the column cell. |
| header-dragover | Raised when dragging content over the header. |
| header-drop | Raised when data is dropped on the column header. |
| cell-dragover | Raised when dragging data over the cell. |
| cell-drop | Raised when data is dropped on the column cell. |
#### Drop Events
@@ -824,7 +824,7 @@ here is the sample resolver which merge the users property and status and it wil
## See also
* [Data column component](data-column.component.md)
* [Pagination component](pagination.component.md)
* [Data Table Adapter interface](../interfaces/datatable-adapter.interface.md)
* [Document list component](../../content-services/components/document-list.component.md)
- [Data column component](data-column.component.md)
- [Pagination component](pagination.component.md)
- [Data Table Adapter interface](../interfaces/datatable-adapter.interface.md)
- [Document list component](../../content-services/components/document-list.component.md)

4
docs/core/components/empty-content.component.md
View File

@@ -30,7 +30,7 @@ Provides a generic "Empty Content" placeholder for components.
### Properties
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| ---- | ---- | ------------- | ----------- |
| icon | `string` | "cake" | Material Icon to use. |
| subtitle | `string` | "" | String or Resource Key for the subtitle. |
| title | `string` | "" | String or Resource Key for the title. |
@@ -72,4 +72,4 @@ You can also use multiple lines instead of the subtitle section:
## See also
* [Error content component](error-content.component.md)
- [Error content component](error-content.component.md)

4
docs/core/components/error-content.component.md
View File

@@ -22,7 +22,7 @@ this.router.navigate(['/error', errorCode]);
### Properties
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| ---- | ---- | ------------- | ----------- |
| errorCode | `string` | | Error code associated with this error. |
## Details
@@ -63,4 +63,4 @@ For example you can have a custom action button with the following code
## See also
* [Empty Content component](empty-content.component.md)
- [Empty Content component](empty-content.component.md)

44
docs/core/components/form-field.component.md
View File

@@ -26,7 +26,7 @@ based on the field type or the metadata information.
### Properties
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| ---- | ---- | ------------- | ----------- |
| field | [`FormFieldModel`](../../core/models/form-field.model.md) | null | Contains all the necessary data needed to determine what UI [`Widget`](../../../lib/testing/src/lib/core/pages/form/widgets/widget.ts) to use when rendering the field in the form. You would typically not create this data manually but instead create the form in APS and export it to get to all the `FormFieldModel` definitions. |
## Details
@@ -38,24 +38,24 @@ uses `<adf-form-field>` components to render the form fields.
Forms defined in APS have the following default mappings for the form fields:
| *APS [`Form`](../../../lib/process-services/src/lib/task-list/models/form.model.ts) Designer* [`Widget`](../../../lib/testing/src/lib/core/pages/form/widgets/widget.ts) | Field Type | Component Type |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| Text | text | [`TextWidgetComponent`](../../../lib/core/form/components/widgets/text/text.widget.ts) |
| Multi-line text | multi-line-text | [`MultilineTextWidgetComponentComponent`](../../../lib/core/form/components/widgets/multiline-text/multiline-text.widget.ts) |
| Number | integer | [`NumberWidgetComponent`](../../../lib/core/form/components/widgets/number/number.widget.ts) |
| Checkbox | boolean | [`CheckboxWidgetComponent`](../../../lib/core/form/components/widgets/checkbox/checkbox.widget.ts) |
| Date | date | [`DateWidgetComponent`](../../../lib/core/form/components/widgets/date/date.widget.ts) |
| Dropdown | dropdown | [`DropdownWidgetComponent`](../../../lib/core/form/components/widgets/dropdown/dropdown.widget.ts) |
| Typeahead | typeahead | [`TypeaheadWidgetComponent`](../../../lib/core/form/components/widgets/typeahead/typeahead.widget.ts) |
| Amount | amount | [`AmountWidgetComponent`](../../../lib/core/form/components/widgets/amount/amount.widget.ts) |
| Radio buttons | radio-buttons | [`RadioButtonsWidgetComponent`](../../../lib/core/form/components/widgets/radio-buttons/radio-buttons.widget.ts) |
| People | people | [`PeopleWidgetComponent`](../../../lib/core/form/components/widgets/people/people.widget.ts) |
| Group of people | functional-group | [`FunctionalGroupWidgetComponent`](../../../lib/core/form/components/widgets/functional-group/functional-group.widget.ts) |
| Dynamic table | dynamic-table | [`DynamicTableWidgetComponent`](../../../lib/core/form/components/widgets/dynamic-table/dynamic-table.widget.ts) |
| Hyperlink | hyperlink | [`HyperlinkWidgetComponent`](../../../lib/core/form/components/widgets/hyperlink/hyperlink.widget.ts) |
| Header | group | [`ContainerWidgetComponent`](../../../lib/core/form/components/widgets/container/container.widget.ts) |
| Attach File | upload | AttachWidgetComponent or [`UploadWidgetComponent`](../../../lib/core/form/components/widgets/upload/upload.widget.ts) (based on metadata) |
| Display value | readonly | [`TextWidgetComponent`](../../../lib/core/form/components/widgets/text/text.widget.ts) |
| Display text | readonly-text | [`DisplayTextWidgetComponent`](../../../lib/core/form/components/widgets/display-text/display-text.widget.ts) |
| N/A | container | [`ContainerWidgetComponent`](../../../lib/core/form/components/widgets/container/container.widget.ts) (layout component) |
| N/A | N/A | [`UnknownWidgetComponent`](../../../lib/core/form/components/widgets/unknown/unknown.widget.ts) |
| _APS [`Form`](../../../lib/process-services/src/lib/task-list/models/form.model.ts) Designer_ [`Widget`](../../../lib/testing/src/lib/core/pages/form/widgets/widget.ts) | Field Type | Component Type |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------- | -------------- |
| Text | text | [`TextWidgetComponent`](../../../lib/core/form/components/widgets/text/text.widget.ts) |
| Multi-line text | multi-line-text | [`MultilineTextWidgetComponentComponent`](../../../lib/core/form/components/widgets/multiline-text/multiline-text.widget.ts) |
| Number | integer | [`NumberWidgetComponent`](../../../lib/core/form/components/widgets/number/number.widget.ts) |
| Checkbox | boolean | [`CheckboxWidgetComponent`](../../../lib/core/form/components/widgets/checkbox/checkbox.widget.ts) |
| Date | date | [`DateWidgetComponent`](../../../lib/core/form/components/widgets/date/date.widget.ts) |
| Dropdown | dropdown | [`DropdownWidgetComponent`](../../../lib/core/form/components/widgets/dropdown/dropdown.widget.ts) |
| Typeahead | typeahead | [`TypeaheadWidgetComponent`](../../../lib/core/form/components/widgets/typeahead/typeahead.widget.ts) |
| Amount | amount | [`AmountWidgetComponent`](../../../lib/core/form/components/widgets/amount/amount.widget.ts) |
| Radio buttons | radio-buttons | [`RadioButtonsWidgetComponent`](../../../lib/core/form/components/widgets/radio-buttons/radio-buttons.widget.ts) |
| People | people | [`PeopleWidgetComponent`](../../../lib/core/form/components/widgets/people/people.widget.ts) |
| Group of people | functional-group | [`FunctionalGroupWidgetComponent`](../../../lib/core/form/components/widgets/functional-group/functional-group.widget.ts) |
| Dynamic table | dynamic-table | [`DynamicTableWidgetComponent`](../../../lib/core/form/components/widgets/dynamic-table/dynamic-table.widget.ts) |
| Hyperlink | hyperlink | [`HyperlinkWidgetComponent`](../../../lib/core/form/components/widgets/hyperlink/hyperlink.widget.ts) |
| Header | group | [`ContainerWidgetComponent`](../../../lib/core/form/components/widgets/container/container.widget.ts) |
| Attach File | upload | AttachWidgetComponent or [`UploadWidgetComponent`](../../../lib/core/form/components/widgets/upload/upload.widget.ts) (based on metadata) |
| Display value | readonly | [`TextWidgetComponent`](../../../lib/core/form/components/widgets/text/text.widget.ts) |
| Display text | readonly-text | [`DisplayTextWidgetComponent`](../../../lib/core/form/components/widgets/display-text/display-text.widget.ts) |
| N/A | container | [`ContainerWidgetComponent`](../../../lib/core/form/components/widgets/container/container.widget.ts) (layout component) |
| N/A | N/A | [`UnknownWidgetComponent`](../../../lib/core/form/components/widgets/unknown/unknown.widget.ts) |

2
docs/core/components/form-list.component.md
View File

@@ -22,5 +22,5 @@ Shows forms as a list.
### Properties
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| ---- | ---- | ------------- | ----------- |
| forms | `any[]` | \[] | The array that contains the information to show inside the list. |

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

@@ -37,7 +37,7 @@ body of the element:
### Properties
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| ---- | ---- | ------------- | ----------- |
| color | `string` | | Background color for the header. It can be any hex color code or one of the Material theme colors: 'primary', 'accent' or 'warn'. |
| expandedSidenav | `boolean` | true | expandedSidenav: Toggles the expanded state of the component. |
| logo | `string` | | Path to an image file for the application logo. |
@@ -50,8 +50,8 @@ body of the element:
### Events
| Name | Type | Description |
| --- | --- | --- |
| clicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<boolean>` | Emitted when the sidenav button is clicked. |
| ---- | ---- | ----------- |
| clicked | `any` | Emitted when the sidenav button is clicked. |
## Details

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

@@ -33,13 +33,13 @@ Validates the URLs for ACS and APS and saves them in the user's local storage
### Properties
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| ---- | ---- | ------------- | ----------- |
| providers | `string[]` | | Tells the component which provider options are available. Possible valid values are "ECM" (Content), "BPM" (Process) , "ALL" (Content and Process), 'OAUTH2' SSO. |
### Events
| Name | Type | Description |
| --- | --- | --- |
| 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<boolean>` | Emitted when the changes are successfully applied. |
| ---- | ---- | ----------- |
| 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. |

4
docs/core/components/icon.component.md
View File

@@ -27,7 +27,7 @@ Provides a universal way of rendering registered and named icons.
### Properties
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| ---- | ---- | ------------- | ----------- |
| color | [`ThemePalette`](https://github.com/angular/components/blob/master/src/material/core/common-behaviors/color.ts) | | Theme color palette for the component. |
| value | `string` | | Icon value, which can be either a ligature name or a custom icon in the format `[namespace]:[name]`. |
@@ -80,4 +80,4 @@ using the `adf:` namespace.
## See also
* [Thumbnail service](../services/thumbnail.service.md)
- [Thumbnail service](../services/thumbnail.service.md)

8
docs/core/components/infinite-pagination.component.md
View File

@@ -37,7 +37,7 @@ Adds "infinite" pagination to the component it is used with.
### Properties
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| ---- | ---- | ------------- | ----------- |
| isLoading | `boolean` | false | Is a new page loading? |
| pageSize | `number` | | Number of items that are added with each "load more" event. |
| target | [`PaginatedComponent`](../../../lib/core/pagination/paginated-component.interface.ts) | | Component that provides custom pagination support. |
@@ -45,7 +45,7 @@ Adds "infinite" pagination to the component it is used with.
### Events
| Name | Type | Description |
| --- | --- | --- |
| ---- | ---- | ----------- |
| loadMore | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`RequestPaginationModel`](../../../lib/core/models/request-pagination.model.ts)`>` | Emitted when the "Load More" button is clicked. |
## Details
@@ -65,5 +65,5 @@ See the [Pagination component](pagination.component.md) for more information abo
## See also
* [Document list component](../../content-services/components/document-list.component.md)
* [Pagination component](pagination.component.md)
- [Document list component](../../content-services/components/document-list.component.md)
- [Pagination component](pagination.component.md)

12
docs/core/components/info-drawer-layout.component.md
View File

@@ -18,9 +18,9 @@ Displays a sidebar-style information panel.
There are three regions where you can add your own content using `<div>` elements
with the following names:
* info-drawer-title
* info-drawer-buttons
* info-drawer-content
- info-drawer-title
- info-drawer-buttons
- info-drawer-content
```html
<adf-info-drawer-layout [showHeader]="true">
@@ -43,7 +43,7 @@ with the following names:
### Properties
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| ---- | ---- | ------------- | ----------- |
| showHeader | `boolean` | true | The visibility of the header. |
## Details
@@ -54,5 +54,5 @@ See the [Info drawer tab component](info-drawer-tab.component.md) for an alterna
## See also
* [Info drawer component](info-drawer.component.md)
* [Info drawer tab component](info-drawer-tab.component.md)
- [Info drawer component](info-drawer.component.md)
- [Info drawer tab component](info-drawer-tab.component.md)

6
docs/core/components/info-drawer-tab.component.md
View File

@@ -54,7 +54,7 @@ You can also combine `icon` and `label` properties.
### Properties
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| ---- | ---- | ------------- | ----------- |
| icon | `string` | null | Icon to render for the tab. |
| label | `string` | "" | The title of the tab (string or translation key). |
@@ -64,5 +64,5 @@ See the [Info drawer component](info-drawer.component.md) page for details of ho
## See also
* [Info drawer component](info-drawer.component.md)
* [Info drawer layout component](info-drawer-layout.component.md)
- [Info drawer component](info-drawer.component.md)
- [Info drawer layout component](info-drawer-layout.component.md)

14
docs/core/components/info-drawer.component.md
View File

@@ -18,9 +18,9 @@ Displays a sidebar-style information panel with tabs.
There are three regions where you can add your own content using `<div>` elements
with the following names (as with the [Info drawer layout component](info-drawer-layout.component.md)):
* info-drawer-title
* info-drawer-buttons
* info-drawer-content
- info-drawer-title
- info-drawer-buttons
- info-drawer-content
The tabs are added using one or more `<adf-info-drawer-tab>` elements, which can
have any content you like:
@@ -48,7 +48,7 @@ have any content you like:
### Properties
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| ---- | ---- | ------------- | ----------- |
| selectedIndex | `number` | 0 | The selected index tab. |
| showHeader | `boolean` | true | The visibility of the header. |
| title | `string \| null` | null | The title of the info drawer (string or translation key). |
@@ -56,7 +56,7 @@ have any content you like:
### Events
| Name | Type | Description |
| --- | --- | --- |
| ---- | ---- | ----------- |
| currentTab | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<number>` | Emitted when the currently active tab changes. |
## Details
@@ -65,5 +65,5 @@ This is a variant of the [Info Drawer Layout component](info-drawer-layout.compo
## See also
* [Info drawer layout component](info-drawer-layout.component.md)
* [Info drawer tab component](info-drawer-tab.component.md)
- [Info drawer layout component](info-drawer-layout.component.md)
- [Info drawer tab component](info-drawer-tab.component.md)

4
docs/core/components/json-cell.component.md
View File

@@ -42,7 +42,7 @@ You can specify the cell inside the `app.config.json` file:
### Properties
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| ---- | ---- | ------------- | ----------- |
| column | [`DataColumn`](../../../lib/core/datatable/data/data-column.model.ts) | | Data that defines the column. |
| copyContent | `boolean` | | Enables/disables a [Clipboard directive](../../core/directives/clipboard.directive.md) to allow copying of the cell's content. |
| data | [`DataTableAdapter`](../../../lib/core/datatable/data/datatable-adapter.ts) | | Data table adapter instance. |
@@ -58,4 +58,4 @@ This component provides a custom display to show JSON data in a
## See also
* [Datatable component](datatable.component.md)
- [Datatable component](datatable.component.md)

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

@@ -14,8 +14,8 @@ Shows and manages a login dialog.
### Events
| Name | Type | Description |
| --- | --- | --- |
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`LoginSuccessEvent`](../../../lib/core/login/models/login-success.event.ts)`>` | Emitted when the login succeeds. |
| ---- | ---- | ----------- |
| success | `any` | Emitted when the login succeeds. |
## Details
@@ -24,4 +24,4 @@ but it also creates and manages the dialog for you.
## See also
* [Login Dialog component](login-dialog.component.md)
- [Login Dialog component](login-dialog.component.md)

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

@@ -13,20 +13,21 @@ Authenticates to Alfresco Content Services and Alfresco Process Services.
## Contents
* [Basic usage](#basic-usage)
* [Transclusions](#transclusions)
* [Class members](#class-members)
* [Properties](#properties)
* [Events](#events)
* [Details](#details)
* [Handling events](#handling-events)
* [Custom logo and background](#custom-logo-and-background)
* [Customizing validation rules](#customizing-validation-rules)
* [Call an external identity provider to fetch the auth token](#call-an-external-identity-provider-to-fetch-the-auth-token)
* [Controlling form submit execution behaviour](#controlling-form-submit-execution-behaviour)
* [Single Sign-On (SSO)](#single-sign-on-sso)
* [Kerberos](#kerberos)
* [See Also](#see-also)
- [Basic usage](#basic-usage)
- [Transclusions](#transclusions)
- [Class members](#class-members)
- [Properties](#properties)
- [Events](#events)
- [Details](#details)
- [Handling events](#handling-events)
- [Custom logo and background](#custom-logo-and-background)
- [Customizing validation rules](#customizing-validation-rules)
- [Call an external identity provider to fetch the auth token](#call-an-external-identity-provider-to-fetch-the-auth-token)
- [Override the successRoute from app.config.json with Basic Auth](#override-the-successroute-from-appconfigjson-with-basic-auth)
- [Controlling form submit execution behaviour](#controlling-form-submit-execution-behaviour)
- [Single Sign-On (SSO)](#single-sign-on-sso)
- [Kerberos](#kerberos)
- [See Also](#see-also)
## Basic usage
@@ -76,7 +77,7 @@ with custom input fields handled by your application or parent component:
### Properties
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| ---- | ---- | ------------- | ----------- |
| backgroundImageUrl | `string` | | Path to a custom background image. |
| copyrightText | `string` | | The copyright text below the login box. |
| fieldsValidation | `any` | | Custom validation rules for the login form. |
@@ -90,10 +91,10 @@ with custom input fields handled by your application or parent component:
### Events
| Name | Type | Description |
| --- | --- | --- |
| 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<LoginSuccessEvent>` | Emitted when the login is successful. |
| ---- | ---- | ----------- |
| error | `any` | Emitted when the login fails. |
| executeSubmit | `any` | Emitted when the login form is submitted. |
| success | `any` | Emitted when the login is successful. |
## Details
@@ -277,7 +278,7 @@ export class MyCustomLogin {
```
Note that if you do not call `event.preventDefault()` then the default behaviour
will execute *after* your custom code has completed.
will execute _after_ your custom code has completed.
### Single Sign-On (SSO)
@@ -313,8 +314,8 @@ automatically to the authorization server when the user is not logged-in
You can also enable automatic redirection to the OAuth provider using the following properties:
* `silentLogin`
* `redirectSilentIframeUri`
- `silentLogin`
- `redirectSilentIframeUri`
```json
{
@@ -368,4 +369,4 @@ See [Kerberos Configuration](../../../docs/user-guide/kerberos.md) for instructi
## See Also
* [Logout directive](../directives/logout.directive.md)
- [Logout directive](../directives/logout.directive.md)

6
docs/core/components/notification-history.component.md
View File

@@ -23,11 +23,11 @@ The main purpose of the [Notification history component](../../core/components/n
### Properties
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| ---- | ---- | ------------- | ----------- |
| maxNotifications | `number` | 5 | Maximum number of notifications to display. The rest will remain hidden until load more is clicked |
| menuPositionX | `string` | "after" | Custom choice for opening the menu at the bottom. Can be `before` or `after`. |
| menuPositionY | `string` | "below" | Custom choice for opening the menu at the bottom. Can be `above` or `below`. |
| maxNotifications | `number` | 5 | Maximum number of notifications to display. The rest will remain hidden until load more is clicked. |
## See also
* [Notification Service](../../core/services/notification.service.md)
- [Notification Service](../../core/services/notification.service.md)

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

@@ -13,14 +13,14 @@ Adds pagination to the component it is used with.
## Contents
* [Basic Usage](#basic-usage)
* [Class members](#class-members)
* [Properties](#properties)
* [Events](#events)
* [Details](#details)
* [Integrating with the Document List component](#integrating-with-the-document-list-component)
* [Custom pagination](#custom-pagination)
* [See also](#see-also)
- [Basic Usage](#basic-usage)
- [Class members](#class-members)
- [Properties](#properties)
- [Events](#events)
- [Details](#details)
- [Integrating with the Document List component](#integrating-with-the-document-list-component)
- [Custom pagination](#custom-pagination)
- [See also](#see-also)
## Basic Usage
@@ -41,7 +41,7 @@ Adds pagination to the component it is used with.
### Properties
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| ---- | ---- | ------------- | ----------- |
| supportedPageSizes | `number[]` | | An array of page sizes. |
| target | [`PaginatedComponent`](../../../lib/core/pagination/paginated-component.interface.ts) | | Component that provides custom pagination support. |
| pagination | [`PaginationModel`](../../../lib/core/models/pagination.model.ts) | | Pagination object. |
@@ -49,12 +49,12 @@ Adds pagination to the component it is used with.
### Events
| Name | Type | Description |
| --- | --- | --- |
| 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<PaginationModel>` | Emitted when the page size changes. |
| nextPage | `EventEmitter<PaginationModel>` | Emitted when the next page is requested. |
| prevPage | `EventEmitter<PaginationModel>` | Emitted when the previous page is requested. |
| ---- | ---- | ----------- |
| 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. |
## Details
@@ -102,4 +102,4 @@ and pass the updated parameters.
## See also
* [Infinite Pagination component](infinite-pagination.component.md)
- [Infinite Pagination component](infinite-pagination.component.md)

6
docs/core/components/search-text-input.component.md
View File

@@ -27,7 +27,7 @@ Displays a input text that supports autocompletion
### Properties
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| ---- | ---- | ------------- | ----------- |
| autocomplete | `boolean` | false | Toggles auto-completion of the search input field. |
| collapseOnSubmit | `boolean` | true | Collapse search bar on submit. |
| debounceTime | `number` | 0 | Debounce time in milliseconds. |
@@ -42,8 +42,8 @@ Displays a input text that supports autocompletion
### Events
| Name | Type | Description |
| --- | --- | --- |
| ---- | ---- | ----------- |
| reset | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<boolean>` | Emitted when the result list is reset |
| searchChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string>` | Emitted when the search term is changed. The search term is provided in the 'value' property of the returned object. If the term is less than three characters in length then it is truncated to an empty string. |
| selectResult | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the result list is selected |
| submit | `EventEmitter<any>` | Emitted when the search is submitted by pressing the ENTER key. The search term is provided as the value of the event. |
| submit | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the search is submitted by pressing the ENTER key. The search term is provided as the value of the event. |

8
docs/core/components/sidebar-action-menu.component.md
View File

@@ -19,9 +19,9 @@ Displays a sidebar-action menu information panel.
There are three regions where you can add your own content in `<div>` elements with
the following names:
* adf-sidebar-menu-title-icon
* adf-sidebar-menu-options
* adf-sidebar-menu-expand-icon
- adf-sidebar-menu-title-icon
- adf-sidebar-menu-options
- adf-sidebar-menu-expand-icon
```html
<adf-sidebar-action-menu>
@@ -43,7 +43,7 @@ the following names:
### Properties
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| ---- | ---- | ------------- | ----------- |
| expanded | `boolean` | | Toggle the sidebar action menu on expand. |
| title | `string` | | The title of the sidebar action. |
| width | `number` | 272 | Width in pixels for sidebar action menu options. |

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

@@ -13,15 +13,15 @@ Displays the standard three-region ADF application layout.
## Contents
* [Basic Usage](#basic-usage)
* [Transclusions](#transclusions)
* [Class members](#class-members)
* [Properties](#properties)
* [Events](#events)
* [Details](#details)
* [Template context](#template-context)
* [menuOpenState$](#menuopenstate)
* [Preserving the menu state](#preserving-the-menu-state)
- [Basic Usage](#basic-usage)
- [Transclusions](#transclusions)
- [Class members](#class-members)
- [Properties](#properties)
- [Events](#events)
- [Details](#details)
- [Template context](#template-context)
- [menuOpenState$](#menuopenstate)
- [Preserving the menu state](#preserving-the-menu-state)
## Basic Usage
@@ -68,7 +68,7 @@ sub-components (note the use of `<ng-template>` in the sub-components' body sect
### Properties
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| ---- | ---- | ------------- | ----------- |
| expandedSidenav | `boolean` | true | Should the navigation region be expanded initially? |
| hideSidenav | `boolean` | false | Toggles showing/hiding the navigation region. |
| position | `string` | "start" | The side that the drawer is attached to. Possible values are 'start' and 'end'. |
@@ -79,8 +79,8 @@ sub-components (note the use of `<ng-template>` in the sub-components' body sect
### Events
| Name | Type | Description |
| --- | --- | --- |
| expanded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<boolean>` | Emitted when the menu toggle and the collapsed/expanded state of the sideNav changes. |
| ---- | ---- | ----------- |
| expanded | `any` | Emitted when the menu toggle and the collapsed/expanded state of the sideNav changes. |
## Details
@@ -114,24 +114,24 @@ Mobile layout (screen width less than the `stepOver` value):
Each template is given a context containing the following methods:
* `toggleMenu(): void`
- `toggleMenu(): void`
Triggers menu toggling.
* `isMenuMinimized(): boolean`
- `isMenuMinimized(): boolean`
The expanded/compact (minimized) state of the navigation. This one only makes sense in case of desktop size, when the screen size is above the value of stepOver.
### menuOpenState$
Beside the template context's **isMenuMinimized** variable, another way to listen to the component's menu's open/closed state is with the `menuOpenState$` observable, which is driven by a `BehaviorSubject` in the background. The value emitted by this observable is the opposite of the `isMenuMinimized` template variable.
| Name | Type | Default | Description |
| -------------- | ----------------------------------------------------------------------------- | ------- | ----------------------------------------------- |
| menuOpenState$ | [`Observable`](http://reactivex.io/documentation/observable.html)&lt;boolean> | true | Another way to listen to menu open/closed state |
| Name | Type | Default | Description |
| ---- | ---- | ------- | ----------- |
| menuOpenState$ | [`Observable`](http://reactivex.io/documentation/observable.html)&lt;boolean> | true | Another way to listen to menu open/closed state |
Every time the menu state is changed, the following values are emitted:
* true, if the menu changed to the opened state
* false, if the menu changed to the closed state
- true, if the menu changed to the opened state
- false, if the menu changed to the closed state
### Preserving the menu state

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

@@ -27,7 +27,7 @@ Selects from a set of predefined sorting definitions and directions.
### Properties
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| ---- | ---- | ------------- | ----------- |
| ascending | `boolean` | true | Current sorting direction |
| options | `Array<Function>` | \[] | Available sorting options |
| selected | `string` | | Currently selected option key |
@@ -35,9 +35,9 @@ Selects from a set of predefined sorting definitions and directions.
### Events
| Name | Type | Description |
| --- | --- | --- |
| 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. |
| ---- | ---- | ----------- |
| sortingChange | `any` | Raised each time direction gets changed. |
| valueChange | `any` | Raised each time sorting key gets changed. |
## Details

18
docs/core/components/start-form.component.md
View File

@@ -25,20 +25,20 @@ Displays the Start [`Form`](../../../lib/process-services/src/lib/task-list/mode
### Properties
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| ---- | ---- | ------------- | ----------- |
| data | [`FormValues`](../../../lib/core/form/components/widgets/core/form-values.ts) | | Custom form values map to be used with the rendered form. |
| disableCompleteButton | `boolean` | false | If true then the `Complete` outcome button is shown but it will be disabled. |
| disableSaveButton | `boolean` | false | If true then the `Save` outcome button is shown but will be disabled. |
| disableStartProcessButton | `boolean` | false | If true then the `Start Process` outcome button is shown but it will be disabled. |
| enableFixedSpacedForm | `boolean` | true | The form will set a prefixed space for invisible fields. |
| fieldValidators | [`FormFieldValidator`](../../../lib/core/form/components/widgets/core/form-field-validator.ts)`[]` | | Contains a list of form field validator instances. |
| form | [`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts) | | Underlying [form model](../../../lib/core/form/components/widgets/core/form.model.ts) instance. |
| form | [`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts) | | Underlying form model instance. |
| formId | `number` | | The id of the form definition to load and display with custom values. |
| formName | `string` | | Name of the form definition to load and display with custom values. |
| nameNode | `string` | | Name to assign to the new node where the metadata are stored. |
| nodeId | `string` | | Content Services node ID for the form metadata. |
| path | `string` | | Path of the folder where the metadata will be stored. |
| processDefinitionId | `string` | | [`Definition`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/definition.ts) ID of the process to start, this parameter can not be use in combination with processId |
| processDefinitionId | `string` | | [Definition](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/definition.ts) ID of the process to start, this parameter can not be use in combination with processId |
| processId | `string` | | Process ID of the process to start, this parameter can not be use in combination with processDefinitionId |
| readOnly | `boolean` | false | Toggle readonly state of the form. Forces all form widgets to render as readonly if enabled. |
| readOnlyForm | `boolean` | false | Is the form read-only (ie, can't be edited)? |
@@ -54,16 +54,16 @@ Displays the Start [`Form`](../../../lib/process-services/src/lib/task-list/mode
### Events
| Name | Type | Description |
| --- | --- | --- |
| ---- | ---- | ----------- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when any error occurs. |
| executeOutcome | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormOutcomeEvent`](../../../lib/core/form/components/widgets/core/form-outcome-event.model.ts)`>` | Emitted when any outcome is executed. Default behaviour can be prevented via `event.preventDefault()`. |
| formCompleted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is submitted with the `Complete` outcome. |
| formContentClicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ContentLinkModel`](../../../lib/core/form/components/widgets/core/content-link.model.ts)`>` | Emitted when a field of the form is clicked. |
| formDataRefreshed | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when form values are refreshed due to a data property change. |
| formError | `EventEmitter<FormFieldModel[]>` | Emitted when the supplied form values have a validation error. |
| formLoaded | `EventEmitter<FormModel>` | Emitted when the form is loaded or reloaded. |
| formSaved | `EventEmitter<FormModel>` | Emitted when the form is submitted with the `Save` or custom outcomes. |
| outcomeClick | `EventEmitter<any>` | Emitted when the user clicks one of the outcome buttons that completes the form. |
| formError | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormFieldModel`](../../core/models/form-field.model.md)`[]>` | Emitted when the supplied form values have a validation error. |
| formLoaded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is loaded or reloaded. |
| formSaved | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is submitted with the `Save` or custom outcomes. |
| outcomeClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the user clicks one of the outcome buttons that completes the form. |
## Details
@@ -78,4 +78,4 @@ the user clicked. You can pass this value to the `startProcess` method (defined
## See also
* [Process service](../../process-services/services/process.service.md)
- [Process service](../../process-services/services/process.service.md)

12
docs/core/components/text-mask.component.md
View File

@@ -20,7 +20,7 @@ Implements text field input masks.
### Properties
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| ---- | ---- | ------------- | ----------- |
| inputMask | `Function` | | Object defining mask and "reversed" status. |
## Details
@@ -45,11 +45,11 @@ text mask in ADF would be:
The following characters have special meaning within a mask; all other characters
are included in the text as they are:
* **"0"**: Denotes a digit
* **"9"**: Denotes a digit that can optionally be left out
* **"A"**: Denotes a alphanumeric character (upper- or lower-case A-Z and digits 0-9)
* **"S"**: Denotes a alphabetic character (upper- or lower-case A-Z)
* **"#"**: Denotes a string of zero or more digits
- **"0"**: Denotes a digit
- **"9"**: Denotes a digit that can optionally be left out
- **"A"**: Denotes a alphanumeric character (upper- or lower-case A-Z and digits 0-9)
- **"S"**: Denotes a alphabetic character (upper- or lower-case A-Z)
- **"#"**: Denotes a string of zero or more digits
The mask is passed to the directive in the `mask` field of the parameter object. The
`reversed` field indicates that digits in the mask are "filled up" in

22
docs/core/components/toolbar.component.md
View File

@@ -13,14 +13,14 @@ Simple container for headers, titles, actions and breadcrumbs.
## Contents
* [Basic Usage](#basic-usage)
* [Transclusions](#transclusions)
* [Class members](#class-members)
* [Properties](#properties)
* [Details](#details)
* [Dropdown menu](#dropdown-menu)
* [Custom color](#custom-color)
* [See also](#see-also)
- [Basic Usage](#basic-usage)
- [Transclusions](#transclusions)
- [Class members](#class-members)
- [Properties](#properties)
- [Details](#details)
- [Dropdown menu](#dropdown-menu)
- [Custom color](#custom-color)
- [See also](#see-also)
## Basic Usage
@@ -73,7 +73,7 @@ pushed to the right by a spacer:
### Properties
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| ---- | ---- | ------------- | ----------- |
| color | [`ThemePalette`](https://github.com/angular/components/blob/master/src/material/core/common-behaviors/color.ts) | | Toolbar color. Can be changed to empty value (default), `primary`, `accent` or `warn`. |
| title | `string` | "" | Toolbar title. |
@@ -133,5 +133,5 @@ For example:
## See also
* [Toolbar Divider component](toolbar-divider.component.md)
* [Toolbar Title component](toolbar-title.component.md)
- [Toolbar Divider component](toolbar-divider.component.md)
- [Toolbar Title component](toolbar-title.component.md)

2
docs/core/components/user-info.component.md
View File

@@ -20,7 +20,7 @@ Shows user information.
### Properties
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| ---- | ---- | ------------- | ----------- |
| bpmBackgroundImage | `string` | | Custom path for the background banner image for APS users. |
| ecmBackgroundImage | `string` | | Custom path for the background banner image for ACS users. |
| menuPositionX | [`MenuPositionX`](https://github.com/angular/components/blob/master/src/material/menu/menu-positions.ts) | "after" | Custom choice for opening the menu at the bottom. Can be `before` or `after`. |

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

@@ -13,22 +13,22 @@ See it live: [Viewer Quickstart](https://embed.plnkr.co/iTuG1lFIXfsP95l6bDW6/)
## Contents
* [Basic usage](#basic-usage)
* [Transclusions](#transclusions)
* [Class members](#class-members)
* [Properties](#properties)
* [Events](#events)
* [Keyboard shortcuts](#keyboard-shortcuts)
* [Details](#details)
* [Integrating with the Document List component](#integrating-with-the-document-list-component)
* [Custom file parameters](#custom-file-parameters)
* [Supported file formats](#supported-file-formats)
* [Content Renditions](#content-renditions)
* [Configuring PDF.js library](#configuring-pdfjs-library)
* [Extending the Viewer](#extending-the-viewer)
* [Custom layout](#custom-layout)
* [Printing](#printing)
* [See also](#see-also)
- [Basic usage](#basic-usage)
- [Transclusions](#transclusions)
- [Class members](#class-members)
- [Properties](#properties)
- [Events](#events)
- [Keyboard shortcuts](#keyboard-shortcuts)
- [Details](#details)
- [Integrating with the Document List component](#integrating-with-the-document-list-component)
- [Custom file parameters](#custom-file-parameters)
- [Supported file formats](#supported-file-formats)
- [Content Renditions](#content-renditions)
- [Configuring PDF.js library](#configuring-pdfjs-library)
- [Extending the Viewer](#extending-the-viewer)
- [Custom layout](#custom-layout)
- [Printing](#printing)
- [See also](#see-also)
## Basic usage
@@ -75,7 +75,7 @@ See the [Custom layout](#custom-layout) section for full details of all availabl
### Properties
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| ---- | ---- | ------------- | ----------- |
| allowDownload | `boolean` | true | Toggles downloading. |
| allowFullScreen | `boolean` | true | Toggles the 'Full Screen' feature. |
| allowGoBack | `boolean` | true | Allows `back` navigation |
@@ -84,14 +84,14 @@ See the [Custom layout](#custom-layout) section for full details of all availabl
| allowPrint | `boolean` | false | Toggles printing. |
| allowRightSidebar | `boolean` | false | Allow the right sidebar. |
| allowThumbnails | `boolean` | true | Toggles PDF thumbnails. |
| blobFile | [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob) | | Loads a [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob) File |
| canNavigateBefore | `boolean` | true | Toggles the "before" ("<") button. Requires `allowNavigate` to be enabled. |
| blobFile | [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob) | | Loads a [Blob](https://developer.mozilla.org/en-US/docs/Web/API/Blob) File |
| canNavigateBefore | `boolean` | true | Toggles the "before" ("&lt;") button. Requires `allowNavigate` to be enabled. |
| canNavigateNext | `boolean` | true | Toggles the next (">") button. Requires `allowNavigate` to be enabled. |
| displayName | `string` | | Specifies the name of the file when it is not available from the URL. |
| fileName | `string` | | Content filename. |
| maxRetries | `number` | 30 | Number of times the Viewer will retry fetching content Rendition. There is a delay of at least one second between attempts. |
| mimeType | `string` | | MIME type of the file content (when not determined by the filename extension). |
| nodeId | `string` | null | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) Id of the file to load. |
| nodeId | `string` | null | Node Id of the file to load. |
| overlayMode | `boolean` | false | If `true` then show the Viewer as a full page over the current content. Otherwise fit inside the parent div. |
| sharedLinkId | `string` | null | Shared link id (to display shared file). |
| showLeftSidebar | `boolean` | false | Toggles left sidebar visibility. Requires `allowLeftSidebar` to be set to `true`. |
@@ -108,23 +108,23 @@ See the [Custom layout](#custom-layout) section for full details of all availabl
### Events
| Name | Type | Description |
| --- | --- | --- |
| 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' ("<") button. |
| navigateNext | `EventEmitter<MouseEvent \| KeyboardEvent>` | Emitted when user clicks 'Navigate Next' (">") button. |
| print | `EventEmitter<BaseEvent<any>>` | Emitted when user clicks the 'Print' button. |
| showViewerChange | `EventEmitter<boolean>` | Emitted when the viewer is shown or hidden. |
| ---- | ---- | ----------- |
| 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. |
## Keyboard shortcuts
| Name | Description |
| ------ | ------------------------------------- |
| Esc | Close the viewer (overlay mode only). |
| Left | Invoke 'Navigate before' action. |
| Right | Invoke 'Navigate next' action. |
| Ctrl+F | Activate full-screen mode. |
| Name | Description |
| ---- | ----------- |
| Esc | Close the viewer (overlay mode only). |
| Left | Invoke 'Navigate before' action. |
| Right | Invoke 'Navigate next' action. |
| Ctrl+F | Activate full-screen mode. |
## Details
@@ -182,45 +182,45 @@ You can provide custom file parameters, for example a value for the `mimeType` o
The [Viewer component](viewer.component.md) consists of separate Views that handle particular file types or type families based on either a file extension or a mime type:
* PDF View
* application/pdf
* \*.pdf
* Image View
* image/png
* image/jpeg
* image/gif
* image/bmp
* image/svg+xml
* \*.png
* \*.jpg
* \*.jpeg
* \*.gif
* \*.bpm
* \*.svg
* Text View
* text/plain
* text/csv
* text/xml
* text/html
* application/x-javascript
* \*.txt
* \*.xml
* \*.js
* \*.html
* \*.json
* \*.ts
* Media View
* video/mp4
* video/webm
* video/ogg
* audio/mpeg
* audio/ogg
* audio/wav
* \*.wav
* \*.mp4
* \*.mp3
* \*.webm
* \*.ogg
- PDF View
- application/pdf
- \*.pdf
- Image View
- image/png
- image/jpeg
- image/gif
- image/bmp
- image/svg+xml
- \*.png
- \*.jpg
- \*.jpeg
- \*.gif
- \*.bpm
- \*.svg
- Text View
- text/plain
- text/csv
- text/xml
- text/html
- application/x-javascript
- \*.txt
- \*.xml
- \*.js
- \*.html
- \*.json
- \*.ts
- Media View
- video/mp4
- video/webm
- video/ogg
- audio/mpeg
- audio/ogg
- audio/wav
- \*.wav
- \*.mp4
- \*.mp3
- \*.webm
- \*.ogg
### Content Renditions
@@ -502,4 +502,4 @@ content.
## See also
* [Document List component](../../content-services/components/document-list.component.md)
- [Document List component](../../content-services/components/document-list.component.md)