mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
[ADF-4152] Restructured remaining doc folders and fixed links (#4441)
* [ADF-4152] Moved proc services cloud docs to subfolders * [ADF-4152] Fixed links in PS cloud docs * [ADF-4152] Added subfolders and checked links for extensions and insights docs * [ADF-4152] Moved proc services cloud docs to subfolders * [ADF-4152] Fixed links in PS cloud docs * [ADF-4152] Added subfolders and checked links for extensions and insights docs * [ADF-4152] Fixed links in Proc cloud, Insights and Extensions docs * [ADF-4152] Updated links in user guide * [ADF-4152] Fixed broken links in tutorials * [ADF-4152] Fixed remaining links in core docs * [ADF-4152] Fixed remaining links in proc services docs * [ADF-4152] Fixed remaining links in content services docs * [ADF-4152] Fixed links in breaking changes docs * [ADF-4152] Updated main README index page * [ADF-4152] Fixed glitches with preview ext component docs
This commit is contained in:
Andy Stark
committed by
Eugenio Romano
Eugenio Romano
parent
8edf92f325
commit
31479cfaa4
@@ -1,28 +0,0 @@
|
||||
---
|
||||
Title: Extensions API
|
||||
Github only: true
|
||||
---
|
||||
|
||||
# Extensions API
|
||||
|
||||
Contains components related to the Extensions functionality.
|
||||
See the library's
|
||||
[README file](../../lib/extensions/README.md)
|
||||
for more information about installing and using the source code.
|
||||
|
||||
<!--extensions start-->
|
||||
|
||||
## Components
|
||||
|
||||
| Name | Description | Source link |
|
||||
| ---- | ----------- | ----------- |
|
||||
| [Dynamic component](dynamic.component.md)  | Displays dynamically-loaded extension components. | [Source](../../lib/extensions/src/lib/components/dynamic-component/dynamic.component.ts) |
|
||||
| [Preview Extension component](preview-extension.component.md)  | Preview extension component. | [Source](../../lib/extensions/src/lib/components/viewer/preview-extension.component.ts) |
|
||||
|
||||
## Services
|
||||
|
||||
| Name | Description | Source link |
|
||||
| ---- | ----------- | ----------- |
|
||||
| [Extension service](extension.service.md)  | Manages and runs basic extension functionality. | [Source](../../lib/extensions/src/lib/services/extension.service.ts) |
|
||||
|
||||
<!--extensions end-->
|
||||
@@ -5,7 +5,7 @@ Status: Experimental
|
||||
Last reviewed: 2018-12-17
|
||||
---
|
||||
|
||||
# [Dynamic Component](../../lib/extensions/src/lib/components/dynamic-component/dynamic.component.ts "Defined in dynamic.component.ts")
|
||||
# [Dynamic Component](../../../lib/extensions/src/lib/components/dynamic-component/dynamic.component.ts "Defined in dynamic.component.ts")
|
||||
|
||||
Displays dynamically-loaded extension components.
|
||||
|
||||
@@ -24,7 +24,7 @@ Use the Dynamic component to create extensible apps
|
||||
(ie, apps that provide a generalized UI structure where the specific content
|
||||
can be "plugged in" by other developers). The `id` property refers to a
|
||||
component that has previously been registered using the `setComponents` method
|
||||
of the [Extension service](../../lib/extensions/src/lib/services/extension.service.ts):
|
||||
of the [Extension service](../services/extension.service.md):
|
||||
|
||||
```ts
|
||||
// Registering the extension components.
|
||||
@@ -48,11 +48,10 @@ Use this to provide the extension developer with a standard layout that
|
||||
contains placeholders defined by instances of the Dynamic component. The
|
||||
developer can then register any desired components to correspond to the
|
||||
defined component IDs. For example, the extensible app might be shipped
|
||||
with the standard [Document List component](../content-services/document-list.component.md) registered against `plugInName.components.docList`.
|
||||
with the standard [Document List component](../../content-services/components/document-list.component.md) registered against `plugInName.components.docList`.
|
||||
The extension developer can replace this with a custom class
|
||||
simply by registering that class with `setComponents` before use.
|
||||
|
||||
## See also
|
||||
|
||||
- [Extension service](../../lib/extensions/src/lib/services/extension.service.ts)
|
||||
- [Dynamic tab component](../../lib/extensions/src/lib/components/dynamic-tab/dynamic-tab.component.ts)
|
||||
- [Extension service](../services/extension.service.md)
|
||||
@@ -1,31 +1,32 @@
|
||||
---
|
||||
Title: Dynamic Component
|
||||
Title: Preview Extension Component
|
||||
Added: v3.1.0
|
||||
Status: Experimental
|
||||
Last reviewed: 2018-04-12
|
||||
---
|
||||
|
||||
# [Preview Extension component](../../lib/extensions/src/lib/components/viewer/preview-extension.component.ts "Defined in preview-extension.component.ts")
|
||||
# [Preview Extension component](../../../lib/extensions/src/lib/components/viewer/preview-extension.component.ts "Defined in preview-extension.component.ts")
|
||||
|
||||
Displays dynamically-loaded extension components.
|
||||
If you want give a look on a real working viewer extension project you can look at [aca monaco extensio](https://github.com/eromano/aca-monaco-extension)
|
||||
|
||||
See the [ACA monaco extension](https://github.com/eromano/aca-monaco-extension) for
|
||||
an example of a real working viewer extension project.
|
||||
|
||||
## Class members
|
||||
|
||||
### Properties
|
||||
|
||||
The viewer component when it recognize a new extension always pass the following two parameter as input:
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| extension | `string` | | |
|
||||
| id | `string` | | |
|
||||
| node | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md) | | of the content to display |
|
||||
| url | `string` | | URL Of the content in the repository |
|
||||
| node | `Node` | | Node of the content to display |
|
||||
|
||||
|
||||
## Details
|
||||
|
||||
If you want create your custom extension viewer you need to create the following files in a separate project:
|
||||
|
||||
|
||||
The Module needs to know which is the Id of your extension:
|
||||
|
||||
```ts
|
||||
@@ -36,11 +37,9 @@ export class YourExtensionViewerModule {
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
|
||||
Your viewer component extension business logic:
|
||||
Your [viewer component](../../core/components/viewer.component.md) extension business logic:
|
||||
|
||||
```ts
|
||||
import { Node } from '@alfresco/js-api';
|
||||
@@ -65,19 +64,15 @@ export class YourExtensionViewerComponent implements ViewerExtensionInterface {
|
||||
|
||||
....YOUR CUSTOM LOGIC
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
Your viewer component template:
|
||||
Your [viewer component](../../core/components/viewer.component.md) template:
|
||||
|
||||
```HTML
|
||||
|
||||
<div> This is your custom extension viewer template</div>
|
||||
|
||||
```
|
||||
|
||||
Your viewer component extension.json:
|
||||
|
||||
Your [viewer component](../../core/components/viewer.component.md) extension.json:
|
||||
|
||||
```JSON
|
||||
{
|
||||
@@ -96,11 +91,8 @@ Your viewer component extension.json:
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
## See also
|
||||
|
||||
- [Extension service](../../lib/extensions/src/lib/services/extension.service.ts)
|
||||
- [Extension service](../services/extension.service.md)
|
||||
@@ -5,7 +5,7 @@ Status: Experimental
|
||||
Last reviewed: 2018-12-17
|
||||
---
|
||||
|
||||
# [Extension Service](../../lib/extensions/src/lib/services/extension.service.ts "Defined in extension.service.ts")
|
||||
# [Extension Service](../../../lib/extensions/src/lib/services/extension.service.ts "Defined in extension.service.ts")
|
||||
|
||||
Manages and runs basic extension functionality.
|
||||
|
||||
@@ -13,38 +13,43 @@ 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) - Parameter object for the evaluator with details of app state
|
||||
- _context:_ [`RuleContext`](../../../lib/extensions/src/lib/config/rule.extensions.ts) - Parameter object for the evaluator with details of app state
|
||||
- **Returns** `boolean` - True if the rule passed, false otherwise
|
||||
- **getActionById**(id: `string`): [`ActionRef`](../../lib/extensions/src/lib/config/action.extensions.ts)<br/>
|
||||
- **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
|
||||
- **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<__type>>` - 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.
|
||||
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
|
||||
- **getEvaluator**(key: `string`): `RuleEvaluator`<br/>
|
||||
Retrieves a RuleEvaluator function using its key name.
|
||||
- _key:_ `string` - Key name to look for
|
||||
- **Returns** `RuleEvaluator` - RuleEvaluator or null if not found
|
||||
- **getRouteById**(id: `string`): [`RouteRef`](../../lib/extensions/src/lib/config/routing.extensions.ts)<br/>
|
||||
- **getFeature**(key: `string`): `any[]`<br/>
|
||||
|
||||
- _key:_ `string` -
|
||||
- **Returns** `any[]` -
|
||||
|
||||
- **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/>
|
||||
- **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/>
|
||||
- **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
|
||||
- **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`, context?: `any`): `any`<br/>
|
||||
Runs a lightweight expression stored in a string.
|
||||
- _value:_ `string` - String containing the expression or literal value
|
||||
@@ -59,11 +64,11 @@ Manages and runs basic extension functionality.
|
||||
- **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/>
|
||||
- **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
|
||||
|
||||
Use the methods of this service to add extensibility features to your app. You can find further
|
||||
details in the [App extensions](../user-guide/app-extensions.md) page.
|
||||
details in the [App extensions](../../user-guide/app-extensions.md) page.
|
||||
Reference in New Issue
Block a user