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

Release Note for 4.2 - Initial draft. (#6390)

Browse Source 
* Release Note for 4.2 - Initial draft.

* update dep

* documentation

* fix

* remove script

* lint

Co-authored-by: Eugenio Romano <eugenio.romano@alfresco.com>
Co-authored-by: Eugenio Romano <eromano@users.noreply.github.com>
This commit is contained in:
Francesco Corti
2020-12-07 22:03:41 +01:00
committed by GitHub
parent 27167b3420
commit 5a4cc4edda
214 changed files with 5178 additions and 4950 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
docs/core/directives/check-allowable-operation.directive.md
View File

@@ -11,14 +11,14 @@ Selectively disables an HTML element or Angular component.
## Contents
- [Basic Usage](#basic-usage)
- [Class members](#class-members)
- [Properties](#properties)
- [Details](#details)
- [HTML element example](#html-element-example)
- [Angular component example](#angular-component-example)
- [Implementing the NodeAllowableOperationSubject interface](#implementing-the-nodeallowableoperationsubject-interface)
- [Defining your component as an EXTENDIBLE_COMPONENT parent component](#defining-your-component-as-an-extendible_component-parent-component)
* [Basic Usage](#basic-usage)
* [Class members](#class-members)
* [Properties](#properties)
* [Details](#details)
* [HTML element example](#html-element-example)
* [Angular component example](#angular-component-example)
* [Implementing the NodeAllowableOperationSubject interface](#implementing-the-nodeallowableoperationsubject-interface)
* [Defining your component as an EXTENDIBLE_COMPONENT parent component](#defining-your-component-as-an-extendible_component-parent-component)
## Basic Usage
@@ -40,10 +40,10 @@ Selectively disables an HTML element or Angular component.
### Properties
| Name | Type | Default value | Description |
| ---------- | ----------------------------------------------------------------------------------------------------------------------- | ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| nodes | [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]` | \[] | Nodes to check permission for. |
| permission | `string` | null | [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) permission to check (create, delete, update, updatePermissions, !create, !delete, !update, !updatePermissions). |
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| nodes | [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]` | \[] | Nodes to check permission for. |
| permission | `string` | null | Node permission to check (create, delete, update, updatePermissions, !create, !delete, !update, !updatePermissions). |
## Details
@@ -52,8 +52,8 @@ by taking a collection of [`NodeEntry`](https://github.com/Alfresco/alfresco-js-
The decorated element will be disabled if:
- there are no nodes in the collection
- at least one of the nodes does not have the required permission
* there are no nodes in the collection
* at least one of the nodes does not have the required permission
### HTML element example

12
docs/core/directives/clipboard.directive.md
View File

@@ -25,11 +25,11 @@ Copies text to the clipboard.
### Properties
| Name | Type | Default value | Description |
| ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | ---------------------------------------------------------- |
| message | `string` | | Translation key or message for snackbar notification. |
| placeholder | `string` | | Translation key or message for the tooltip. |
| target | [`HTMLInputElement`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement)` \| `[`HTMLTextAreaElement`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLTextAreaElement) | | Reference to the HTML element containing the text to copy. |
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| message | `string` | | Translation key or message for snackbar notification. |
| placeholder | `string` | | Translation key or message for the tooltip. |
| target | [`HTMLInputElement`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement)` \| `[`HTMLTextAreaElement`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLTextAreaElement) | | Reference to the HTML element containing the text to copy. |
## Details
@@ -42,4 +42,4 @@ the user hovers the mouse over the element. You can also provide a snackbar mess
## See also
- [Clipboard service](../../core/services/clipboard.service.md)
* [Clipboard service](../../core/services/clipboard.service.md)

8
docs/core/directives/context-menu.directive.md
View File

@@ -47,10 +47,10 @@ export class MyComponent implements OnInit {
### Properties
| Name | Type | Default value | Description |
| ------- | --------- | ------------- | -------------------- |
| enabled | `boolean` | false | Is the menu enabled? |
| links | `any[]` | | Items for the menu. |
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| enabled | `boolean` | false | Is the menu enabled? |
| links | `any[]` | | Items for the menu. |
## Details

18
docs/core/directives/highlight.directive.md
View File

@@ -25,11 +25,11 @@ Adds highlighting to selected sections of an HTML element's content.
### Properties
| Name | Type | Default value | Description |
| ------------ | -------- | --------------- | ------------------------------------------ |
| classToApply | `string` | "adf-highlight" | CSS class used to apply highlighting. |
| search | `string` | "" | Text to highlight. |
| selector | `string` | "" | Class selector for highlightable elements. |
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| classToApply | `string` | "adf-highlight" | CSS class used to apply highlighting. |
| search | `string` | "" | Text to highlight. |
| selector | `string` | "" | Class selector for highlightable elements. |
## Details
@@ -52,8 +52,8 @@ If the search string contain spaces then each section between the spaces will
be treated as a separate item to highlight. For example, you could use this to
highlight all occurrences of words in a list.
The highlighting works by adding an HTML &lt;span> element around the
selected text. The &lt;span> includes a CSS class; this defaults to
The highlighting works by adding an HTML \<span> element around the
selected text. The \<span> includes a CSS class; this defaults to
"adf-highlight" but you can supply your own class using the `adf-highlight-class`
property:
@@ -70,5 +70,5 @@ property:
## See also
- [Text highlight pipe](../pipes/text-highlight.pipe.md)
- [Highlight transform service](../services/highlight-transform.service.md)
* [Text highlight pipe](../pipes/text-highlight.pipe.md)
* [Highlight transform service](../services/highlight-transform.service.md)

14
docs/core/directives/logout.directive.md
View File

@@ -19,19 +19,19 @@ Logs the user out when the decorated element is clicked.
### Properties
| Name | Type | Default value | Description |
| -------------- | --------- | ------------- | ------------------------------------- |
| enableRedirect | `boolean` | true | Enable redirecting after logout |
| redirectUri | `string` | "/login" | URI to redirect to after logging out. |
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| enableRedirect | `boolean` | true | Enable redirecting after logout |
| redirectUri | `string` | "/login" | URI to redirect to after logging out. |
## Kerberos
The configuration for Kerberos authentication will allow users to access Alfresco products by entering their credentials only once when logging into their Windows environment.
**You don't need to use the [logout directive](../../core/directives/logout.directive.md) when Kerberos SSO is enabled in ADF**.
**You don't need to use the [logout directive](../../core/directives/logout.directive.md) when Kerberos SSO is enabled in ADF**.
See [Kerberos Configuration](../../../docs/user-guide/kerberos.md) for instructions on configuring Kerberos for an ADF app.
See [Kerberos Configuration](../../../docs/user-guide/kerberos.md) for instructions on configuring Kerberos for an ADF app.
## See also
- [Login component](../components/login.component.md)
* [Login component](../components/login.component.md)

14
docs/core/directives/node-delete.directive.md
View File

@@ -28,15 +28,15 @@ Deletes multiple files and folders.
### Properties
| Name | Type | Default value | Description |
| --------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | --------------------------------------------------------------------------------- |
| permanent | `boolean` | false | If true then the nodes are deleted immediately rather than being put in the trash |
| selection | [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[] \| DeletedNodeEntity[]` | | Array of nodes to delete. |
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| permanent | `boolean` | false | If true then the nodes are deleted immediately rather than being put in the trash |
| selection | [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[] \| DeletedNodeEntity[]` | | Array of nodes to delete. |
### Events
| Name | Type | Description |
| ------ | ----------------------------------------------------------------- | ----------------------------------------- |
| Name | Type | Description |
| --- | --- | --- |
| delete | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the nodes have been deleted. |
## Details
@@ -46,4 +46,4 @@ this action will delete the file permanently.
## See also
- [Node Restore directive](node-restore.directive.md)
* [Node Restore directive](node-restore.directive.md)

8
docs/core/directives/node-download.directive.md
View File

@@ -29,7 +29,7 @@ Allows folders and/or files to be downloaded, with multiple nodes packed as a '.
### Properties
| Name | Type | Default value | Description |
| ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | ----------------------------------------------------------------------------------------------------------------------------- |
| nodes | [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)` \| `[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]` | | Nodes to download. |
| version | [`VersionEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/VersionEntry.md) | | [Node's](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) version to download. |
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| nodes | [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)` \| `[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]` | | Nodes to download. |
| version | `VersionEntry` | | Node's version to download. |

18
docs/core/directives/node-favorite.directive.md
View File

@@ -41,15 +41,15 @@ export class MyComponent {
### Properties
| Name | Type | Default value | Description |
| --------- | ----------------------------------------------------------------------------------------------------------------------- | ------------- | -------------------------------------- |
| selection | [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]` | \[] | Array of nodes to toggle as favorites. |
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| selection | [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]` | \[] | Array of nodes to toggle as favorites. |
### Events
| Name | Type | Description |
| ------ | ----------------------------------------------------------------- | ---------------------------------------------- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the favorite setting fails. |
| Name | Type | Description |
| --- | --- | --- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the favorite setting fails. |
| toggle | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the favorite setting is complete. |
## Details
@@ -75,9 +75,9 @@ which also lets you add extra styling to the element:
The directive behaves as follows:
- If there are no favorite nodes in the selection, then all are marked as favorites
- If there are one or more favorite nodes in the selection, then only those that are not
* If there are no favorite nodes in the selection, then all are marked as favorites
* If there are one or more favorite nodes in the selection, then only those that are not
favorites are marked
- If all nodes in the selection are favorites, then they all have their favorite status removed
* If all nodes in the selection are favorites, then they all have their favorite status removed
See the **Demo Shell** for examples of usage.

12
docs/core/directives/node-restore.directive.md
View File

@@ -48,14 +48,14 @@ Restores deleted nodes to their original location.
### Properties
| Name | Type | Default value | Description |
| --------- | ------------------------------------------------------------------------------------------------------------------------------------ | ------------- | ---------------------------------- |
| selection | [`DeletedNodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/DeletedNodeEntry.md)`[]` | | Array of deleted nodes to restore. |
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| selection | [`DeletedNodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/DeletedNodeEntry.md)`[]` | | Array of deleted nodes to restore. |
### Events
| Name | Type | Description |
| ------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------- |
| Name | Type | Description |
| --- | --- | --- |
| restore | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`RestoreMessageModel`](../../../lib/core/directives/node-restore.directive.ts)`>` | Emitted when restoration is complete. |
## Details
@@ -69,4 +69,4 @@ been restored. The property specifies the route path where the list of nodes are
## See Also
- [Node delete directive](node-delete.directive.md)
* [Node delete directive](node-delete.directive.md)

28
docs/core/directives/upload.directive.md
View File

@@ -21,14 +21,14 @@ Uploads content in response to file drag and drop.
### Properties
| Name | Type | Default value | Description |
| --------- | ---------- | ------------- | -------------------------------------------------------------------------------------------------------------------------------- |
| accept | `string` | | (Click mode only) MIME type filter for files to accept. |
| data | `any` | | Data to upload. |
| directory | `boolean` | | (Click mode only) Toggles uploading of directories. |
| enabled | `boolean` | true | Enables/disables uploading. |
| mode | `string[]` | ['drop'] | Upload mode. Can be "drop" (receives dropped files) or "click" (clicking opens a file dialog). Both modes can be active at once. |
| multiple | `boolean` | | Toggles multiple file uploads. |
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| accept | `string` | | (Click mode only) MIME type filter for files to accept. |
| data | `any` | | Data to upload. |
| directory | `boolean` | | (Click mode only) Toggles uploading of directories. |
| enabled | `boolean` | true | Enables/disables uploading. |
| mode | `string[]` | \['drop'] | Upload mode. Can be "drop" (receives dropped files) or "click" (clicking opens a file dialog). Both modes can be active at once. |
| multiple | `boolean` | | Toggles multiple file uploads. |
## Details
@@ -65,8 +65,8 @@ value or expression:
The [Upload directive](upload.directive.md) supports two modes:
- **drop** mode, where the decorated element acts like a drop zone for files (enabled by default)
- **click** mode, where the decorated element invokes a file dialog to select files or folders.
* **drop** mode, where the decorated element acts like a drop zone for files (enabled by default)
* **click** mode, where the decorated element invokes a file dialog to select files or folders.
You can also use both modes together:
@@ -80,9 +80,9 @@ You can also use both modes together:
In click mode you can provide extra attributes for the file dialog:
- **directory**, enables directory selection
- **multiple**, enables multiple file/folder selection
- **accept**, filters the content accepted
* **directory**, enables directory selection
* **multiple**, enables multiple file/folder selection
* **accept**, filters the content accepted
```html
<div style="width: 50px; height: 50px; background-color: brown"
@@ -140,7 +140,7 @@ onUploadFiles(e: CustomEvent) {
}
```
You can also attach arbitrary data to each event which you can then access from external event handlers. A typical scenario is with data tables where you may want to make use of the data row
You can also attach arbitrary data to each event which you can then access from external event handlers. A typical scenario is with data tables where you may want to make use of the data row
or make underlying data accessible when files are dropped.
You can use `adf-upload-data` to bind custom values or objects for every event raised:

12
docs/core/directives/version-compatibility.directive.md
View File

@@ -21,17 +21,17 @@ Enables/disables components based on ACS version in use.
### Properties
| Name | Type | Default value | Description |
| ------- | ------ | ------------- | ---------------------------------------------------------- |
| version | `void` | | Minimum version required for component to work correctly . |
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| version | `void` | | Minimum version required for component to work correctly . |
## Details
Add the directive to a component or HTML element to enable or disable it based on the version of ACS running in the app.
The directive takes the version specified in the html and compares it to the version of Alfresco Content Services running in the app.
The directive takes the version specified in the html and compares it to the version of Alfresco Content Services running in the app.
This will allow certain features to be only present under specific versions.
This will allow certain features to be only present under specific versions.
#### Major version
@@ -57,7 +57,7 @@ This will allow certain features to be only present under specific versions.
</button>
```
It can be set to match major, minor and patches of ACS versions. Fox example, if the version `6` is specifed it will enable the component from `6.0.0` onwards.
It can be set to match major, minor and patches of ACS versions. Fox example, if the version `6` is specifed it will enable the component from `6.0.0` onwards.
If the minimum version required is not matched the component will not be initialized and will disappear from the DOM tree.