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

Generate docs (#8481)

Browse Source 
* Generate docs

* Fix duplicated Optional and restore code block ticks

* Fix docbuild command errors, improve documentations

---------

Co-authored-by: Amedeo Lepore <amedeo.lepore85@gmail.com>
Co-authored-by: Amedeo Lepore <amedeo.lepore@hyland.com>
This commit is contained in:
Ardit Domi
2023-04-18 14:28:07 +01:00
committed by GitHub
parent 7704c62e1c
commit 657e5ef7fd
29 changed files with 166 additions and 142 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/content-services/components/content-user-info.component.md
View File

@@ -23,9 +23,9 @@ Shows user information for `CONTENT` and `CONTENT_SSO` mode.
| ---- | ---- | ------------- | ----------- |
| bpmBackgroundImage | `string` | | Custom path for the background banner image for APS users. |
| ecmBackgroundImage | `string` | | Custom path for the background banner image for ACS users. |
| ecmUser | [`EcmUserModel`](../../core/models/ecm-user.model.md) | | |
| identityUser | [`IdentityUserModel`](../../../lib/process-services-cloud/src/lib/people/models/identity-user.model.ts) | | |
| isLoggedIn | `boolean` | | |
| ecmUser | [`EcmUserModel`](../../core/models/ecm-user.model.md) | | ECM user info. |
| identityUser | [`IdentityUserModel`](../../../lib/process-services-cloud/src/lib/people/models/identity-user.model.ts) | | Identity user info. |
| isLoggedIn | `boolean` | | Determines if user is logged in. |
| 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`. |
| menuPositionY | [`MenuPositionY`](https://github.com/angular/components/blob/master/src/material/menu/menu-positions.ts) | "below" | Custom choice for opening the menu at the bottom. Can be `above` or `below`. |
| mode | `UserInfoMode` | | current mode. |

9
docs/content-services/components/document-list.component.md
View File

@@ -38,6 +38,7 @@ Displays the documents from a repository.
- [Custom 'empty folder' template](#custom-empty-folder-template)
- [Custom 'permission denied' template](#custom-permission-denied-template)
- [Custom 'loading' template](#custom-loading-template)
- [File Auto downloading](#file-auto-downloading)
- [See also](#see-also)
## Basic Usage
@@ -792,9 +793,9 @@ This will give the following output:
### File Auto downloading
In case of files exceeding a predefined file size, the document list component can be configured to automatically download those file when trying to preview them.
In case of files exceeding a predefined file size, the [document list component](../../content-services/components/document-list.component.md) can be configured to automatically download those file when trying to preview them.
This can help in reducing server load, and ensuring quick access to such files. After turning this feature on, whenever the user tries to preview a file with a large
file size, the Document List component will first preview a dialog, asking for confirmation from the user on whether they want to download the file, or cancel the preview altogether.
file size, the [Document List component](../../content-services/components/document-list.component.md) will first preview a dialog, asking for confirmation from the user on whether they want to download the file, or cancel the preview altogether.
In order to configure the Document List to automatically download the files, the following environment variables would need to be set up in app.config.json -
@@ -805,10 +806,10 @@ In order to configure the Document List to automatically download the files, the
}
```
Here, `"enableFileAutoDownload": true,` would enable the file auto download feature on the Document List component. Setting this flag to false disables this feature, and always
Here, `"enableFileAutoDownload": true,` would enable the file auto download feature on the [Document List component](../../content-services/components/document-list.component.md). Setting this flag to false disables this feature, and always
triggers a file preview when trying to view a file, regardless of its size.
The second configuration here, `"fileAutoDownloadSizeThresholdInMB": 15` specifies the file size threshold (in MB), after which the Document List component will start downloading the file.
The second configuration here, `"fileAutoDownloadSizeThresholdInMB": 15` specifies the file size threshold (in MB), after which the [Document List component](../../content-services/components/document-list.component.md) will start downloading the file.
In the example provided above, any file greater than 15MB in size would trigger the auto download functionality. Files lower than 15MB in size would continue to preview normally.
## See also

4
docs/content-services/components/node-comments.component.md
View File

@@ -25,5 +25,5 @@ Displays comments from users involved in a specified content and allows an invol
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| nodeId | `string` | | The numeric ID of the node. |
| readOnly | `boolean` | | Are the comments read only? |
| nodeId | `string` | | nodeId of the document that has comments |
| readOnly | `boolean` | | make the [comments component](../../core/components/comments.component.md) readOnly |

2
docs/content-services/components/search-chip-list.component.md
View File

@@ -25,4 +25,4 @@ Displays search criteria as a set of "chips".
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| clearAll | `boolean` | false | Flag used to enable the display of a clear-all-filters button. |
| searchFilter | [`SearchFilterComponent`](../../content-services/components/search-filter.component.md) | | Search filter to supply the data for the chips. Not required from 4.5.0 and later versions |
| searchFilter | [`SearchFilterComponent`](../../content-services/components/search-filter.component.md) | | Search filter to supply the data for the chips. Not required from 4.5.0 and later versions @deprecated |

23
docs/content-services/components/tags-creator.component.md
View File

@@ -23,18 +23,17 @@ Allows to create multiple tags. That component contains input and two lists. Top
### Properties
| Name | Type | Default value | Description |
|-----------------------|-------------------|---------------|-------------------------------------------------------------------------------------------------------------------------------------|
| mode | `TagsCreatorMode` | | Create mode if only new tags can be created or Create And Assign mode if new tags can be created and existing tags can be selected. |
| disabledTagsRemoving | `boolean` | false | False if tags can be removed from top list, true otherwise. |
| tags | `string[]` | | Default top list. |
| tagNameControlVisible | `boolean` | false | True if input should be visible, false otherwise. | |
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| disabledTagsRemoving | `boolean` | false | False if tags can be removed from top list, true otherwise. |
| mode | `TagsCreatorMode` | | Mode for component. In Create mode we can't select existing tags, we can only create them. In Create and Assign mode we can both - create tags and select existing tags. |
| tagNameControlVisible | `boolean` | | Decides if input for tags creation/searching should be visible. When input is hidden then panel of existing tags is hidden as well. |
| tags | `string[]` | | Default top list. |
### Events
| Name | Type | Description |
|-----------------------------------|------------------------------------------------------------------------|--------------------------------------------------|
| existingTagsPanelVisibilityChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<boolean>` | Emitted when bottom list is showing or hiding. |
| tagsChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string[]>` | Emitted when tags in top list are changed. |
| tagNameControlVisibleChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<boolean>` | Emitted when input is showing or hiding. |
| Name | Type | Description |
| ---- | ---- | ----------- |
| existingTagsPanelVisibilityChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<boolean>` | Emitted when bottom list is showing or hiding. |
| tagNameControlVisibleChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<boolean>` | Emitted when input is showing or hiding. |
| tagsChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string[]>` | Emitted when tags in top list are changed. |