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

Update Doc 4.1.0 (#6215)

Browse Source 
* docbuild

* docbuild

* doc license audit

* remove link redirect to testing
This commit is contained in:
Eugenio Romano
2020-10-08 18:33:57 +01:00
committed by GitHub
parent 2747b7fc13
commit d7db9adbf6
177 changed files with 2638 additions and 2121 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/extensions/components/dynamic.component.md
View File

@@ -13,10 +13,10 @@ Displays dynamically-loaded extension components.
### Properties
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| data | `any` | | Data for the dynamically-loaded component instance. |
| id | `string` | | Unique ID string for the component to show. |
| Name | Type | Default value | Description |
| ---- | -------- | ------------- | --------------------------------------------------- |
| data | `any` | | Data for the dynamically-loaded component instance. |
| id | `string` | | Unique ID string for the component to show. |
## Details

12
docs/extensions/components/preview-extension.component.md
View File

@@ -16,12 +16,12 @@ an example of a real working viewer extension project.
### Properties
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| extension | `string` | | File extension (.jpg, .png, etc) for the viewer. |
| id | `string` | | ID string of the component to preview. |
| node | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) | | [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) containing the content to display. |
| url | `string` | | URL of the content in the repository. |
| Name | Type | Default value | Description |
| --------- | -------------------------------------------------------------------------------------------------------- | ------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| extension | `string` | | File extension (.jpg, .png, etc) for the viewer. |
| id | `string` | | ID string of the component to preview. |
| node | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) | | [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) containing the content to display. |
| url | `string` | | URL of the content in the repository. |
## Details

9
docs/extensions/services/extension.service.md
View File

@@ -22,10 +22,10 @@ Manages and runs basic extension functionality.
Retrieves an action using its ID value.
- _id:_ `string` - The ID value to look for
- **Returns** [`ActionRef`](../../../lib/extensions/src/lib/config/action.extensions.ts) - Action or null if not found
- **getAuthGuards**(ids: `string[]`): `Array<Type<__type>>`<br/>
- **getAuthGuards**(ids: `string[]`): `Array<Type<Function>>`<br/>
Retrieves one or more auth guards using an array of ID values.
- _ids:_ `string[]` - Array of ID value to look for
- **Returns** `Array<Type<__type>>` - Array of auth guards or empty array if none were found
- **Returns** `Array<Type<Function>>` - Array of auth guards or empty array if none were found
- **getComponentById**(id: `string`): `Type<>`<br/>
Retrieves a registered [extension component](../../../lib/extensions/src/lib/services/component-register.service.ts) using its ID value.
- _id:_ `string` - The ID value to look for
@@ -35,7 +35,6 @@ Manages and runs basic extension functionality.
- _key:_ `string` -
- _fallback:_ `Array<>` -
- **Returns** `Array<>` -
- **getEvaluator**(key: `string`): [`RuleEvaluator`](../../../lib/extensions/src/lib/config/rule.extensions.ts)<br/>
Retrieves a [RuleEvaluator](../../../lib/extensions/src/lib/config/rule.extensions.ts) function using its key name.
- _key:_ `string` - Key name to look for
@@ -55,9 +54,9 @@ Manages and runs basic extension functionality.
- **load**(): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`<`[`ExtensionConfig`](../../../lib/extensions/src/lib/config/extension.config.ts)`>`<br/>
Loads and registers an extension config file and plugins (specified by path properties).
- **Returns** [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`<`[`ExtensionConfig`](../../../lib/extensions/src/lib/config/extension.config.ts)`>` - The loaded config data
- **runExpression**(value: `string|__type`, context?: `any`): `Function`<br/>
- **runExpression**(value: `string|Function`, context?: `any`): `Function`<br/>
Runs a lightweight expression stored in a string.
- _value:_ `string|__type` - String containing the expression or literal value
- _value:_ `string|Function` - String containing the expression or literal value
- _context:_ `any` - (Optional) Parameter object for the expression with details of app state
- **Returns** `Function` - Result of evaluated expression, if found, or the literal value otherwise
- **setAuthGuards**(values: `Function`)<br/>