mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
Documentation build (#6762)
* move doc dependency in doctools * add ignore link * rebuild doc * version index * put it back some deps
This commit is contained in:
Eugenio Romano
GitHub
@@ -14,7 +14,7 @@ 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. |
|
||||
|
||||
@@ -54,4 +54,4 @@ simply by registering that class with `setComponents` before use.
|
||||
|
||||
## See also
|
||||
|
||||
* [Extension service](../services/extension.service.md)
|
||||
- [Extension service](../services/extension.service.md)
|
||||
|
||||
@@ -17,10 +17,10 @@ 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. |
|
||||
| node | `Node` | | Node containing the content to display. |
|
||||
| url | `string` | | URL of the content in the repository. |
|
||||
|
||||
## Details
|
||||
@@ -101,5 +101,5 @@ further details of how to develop extensions.
|
||||
|
||||
## See also
|
||||
|
||||
* [Extension service](../services/extension.service.md)
|
||||
* [App extensions](../../user-guide/app-extensions.md)
|
||||
- [Extension service](../services/extension.service.md)
|
||||
- [App extensions](../../user-guide/app-extensions.md)
|
||||
|
||||
@@ -13,64 +13,65 @@ Manages and runs basic extension functionality.
|
||||
|
||||
### Methods
|
||||
|
||||
* **evaluateRule**(ruleId: `string`, context?: [`RuleContext`](../../../lib/extensions/src/lib/config/rule.extensions.ts)): `boolean`<br/>
|
||||
- **evaluateRule**(ruleId: `string`, context?: [`RuleContext`](../../../lib/extensions/src/lib/config/rule.extensions.ts)): `boolean`<br/>
|
||||
Evaluates a rule.
|
||||
* *ruleId:* `string` - ID of the rule to evaluate
|
||||
* *context:* [`RuleContext`](../../../lib/extensions/src/lib/config/rule.extensions.ts) - (Optional) Custom rule execution context.
|
||||
* **Returns** `boolean` - True if the rule passed, false otherwise
|
||||
* **getActionById**(id: `string`): [`ActionRef`](../../../lib/extensions/src/lib/config/action.extensions.ts)<br/>
|
||||
- _ruleId:_ `string` - ID of the rule to evaluate
|
||||
- _context:_ [`RuleContext`](../../../lib/extensions/src/lib/config/rule.extensions.ts) - (Optional) Custom rule execution context.
|
||||
- **Returns** `boolean` - True if the rule passed, false otherwise
|
||||
- **getActionById**(id: `string`): [`ActionRef`](../../../lib/extensions/src/lib/config/action.extensions.ts)<br/>
|
||||
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<Function>>`<br/>
|
||||
- _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/>
|
||||
Retrieves one or more auth guards using an array of ID values.
|
||||
* *ids:* `string[]` - Array of ID value to look for
|
||||
* **Returns** `Array<Type<Function>>` - Array of auth guards or empty array if none were found
|
||||
* **getComponentById**(id: `string`): `Type<>`<br/>
|
||||
- _ids:_ `string[]` - Array of ID value to look for
|
||||
- **Returns** `Array<Type<__type>>` - Array of auth guards or empty array if none were found
|
||||
- **getComponentById**(id: `string`): `any`<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
|
||||
* **Returns** `Type<>` - The component or null if not found
|
||||
* **getElements**(key: `string`, fallback: `Array<>` = `[]`): `Array<>`<br/>
|
||||
- _id:_ `string` - The ID value to look for
|
||||
- **Returns** `any` - The component or null if not found
|
||||
- **getElements**(key: `string`, fallback: `Array<>` = `[]`): `Array<>`<br/>
|
||||
|
||||
* *key:* `string` -
|
||||
* *fallback:* `Array<>` -
|
||||
* **Returns** `Array<>` -
|
||||
* **getEvaluator**(key: `string`): [`RuleEvaluator`](../../../lib/extensions/src/lib/config/rule.extensions.ts)<br/>
|
||||
- _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
|
||||
* **Returns** [`RuleEvaluator`](../../../lib/extensions/src/lib/config/rule.extensions.ts) - [RuleEvaluator](../../../lib/extensions/src/lib/config/rule.extensions.ts) or null if not found
|
||||
* **getFeature**(key: `string`): `any[]`<br/>
|
||||
- _key:_ `string` - Key name to look for
|
||||
- **Returns** [`RuleEvaluator`](../../../lib/extensions/src/lib/config/rule.extensions.ts) - [RuleEvaluator](../../../lib/extensions/src/lib/config/rule.extensions.ts) or null if not found
|
||||
- **getFeature**(key: `string`): `any[]`<br/>
|
||||
Gets features by key.
|
||||
* *key:* `string` - Key string, using dot notation
|
||||
* **Returns** `any[]` - Features array found by key
|
||||
* **getRouteById**(id: `string`): [`RouteRef`](../../../lib/extensions/src/lib/config/routing.extensions.ts)<br/>
|
||||
- _key:_ `string` - Key string, using dot notation
|
||||
- **Returns** `any[]` - Features array found by key
|
||||
- **getRouteById**(id: `string`): [`RouteRef`](../../../lib/extensions/src/lib/config/routing.extensions.ts)<br/>
|
||||
Retrieves a route using its ID value.
|
||||
* *id:* `string` - The ID value to look for
|
||||
* **Returns** [`RouteRef`](../../../lib/extensions/src/lib/config/routing.extensions.ts) - The route or null if not found
|
||||
* **getRuleById**(id: `string`): [`RuleRef`](../../../lib/extensions/src/lib/config/rule.extensions.ts)<br/>
|
||||
- _id:_ `string` - The ID value to look for
|
||||
- **Returns** [`RouteRef`](../../../lib/extensions/src/lib/config/routing.extensions.ts) - The route or null if not found
|
||||
- **getRuleById**(id: `string`): [`RuleRef`](../../../lib/extensions/src/lib/config/rule.extensions.ts)<br/>
|
||||
Retrieves a rule using its ID value.
|
||||
* *id:* `string` - The ID value to look for
|
||||
* **Returns** [`RuleRef`](../../../lib/extensions/src/lib/config/rule.extensions.ts) - The rule or null if not found
|
||||
* **load**(): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`<`[`ExtensionConfig`](../../../lib/extensions/src/lib/config/extension.config.ts)`>`<br/>
|
||||
- _id:_ `string` - The ID value to look for
|
||||
- **Returns** [`RuleRef`](../../../lib/extensions/src/lib/config/rule.extensions.ts) - The rule or null if not found
|
||||
- **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|Function`, context?: `any`): `Function`<br/>
|
||||
- **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/>
|
||||
Runs a lightweight expression stored in a string.
|
||||
* *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/>
|
||||
- _value:_ `string|__type` - 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/>
|
||||
Adds one or more new auth guards to the existing set.
|
||||
* *values:* `Function` - The new auth guards to add
|
||||
* **setComponents**(values: `Function`)<br/>
|
||||
- _values:_ `Function` - The new auth guards to add
|
||||
- **setComponents**(values: `Function`)<br/>
|
||||
Adds one or more new components to the existing set.
|
||||
* *values:* `Function` - The new components to add
|
||||
* **setEvaluators**(values: `Function`)<br/>
|
||||
- _values:_ `Function` - The new components to add
|
||||
- **setEvaluators**(values: `Function`)<br/>
|
||||
Adds one or more new rule evaluators to the existing set.
|
||||
* *values:* `Function` - The new evaluators to add
|
||||
* **setup**(config: [`ExtensionConfig`](../../../lib/extensions/src/lib/config/extension.config.ts))<br/>
|
||||
- _values:_ `Function` - The new evaluators to add
|
||||
- **setup**(config: [`ExtensionConfig`](../../../lib/extensions/src/lib/config/extension.config.ts))<br/>
|
||||
Registers extensions from a config object.
|
||||
* *config:* [`ExtensionConfig`](../../../lib/extensions/src/lib/config/extension.config.ts) - Object with config data
|
||||
- _config:_ [`ExtensionConfig`](../../../lib/extensions/src/lib/config/extension.config.ts) - Object with config data
|
||||
|
||||
## Details
|
||||
|
||||
|
||||
Reference in New Issue
Block a user