mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-05-19 17:14:57 +00:00
MNT-25095 Update the documentation (#10864)
* update the documentation * update the documentation --------- Co-authored-by: Eugenio Romano <eromano@users.noreply.github.com>
This commit is contained in:
parent
deefa948cd
commit
fe53c5d5a8
@ -4,16 +4,18 @@ Added: v4.1.0
|
|||||||
---
|
---
|
||||||
|
|
||||||
## Form Extensibility for APA Form Widget
|
## Form Extensibility for APA Form Widget
|
||||||
|
|
||||||
This page describes how you can customize ADF forms to your own specification.
|
This page describes how you can customize ADF forms to your own specification.
|
||||||
|
|
||||||
## Contents
|
## Contents
|
||||||
|
|
||||||
There are two ways to customize the form
|
There are two ways to customize the form
|
||||||
- [Replace default form widgets with custom components](#replace-default-form-widgets-with-apa-form-widgets)
|
- [Replace default form widgets with custom components](#replace-default-form-widgets-with-apa-form-widgets)
|
||||||
- [Replace custom form widget with custom components](#replace-custom-form-widgets-with-custom-components)
|
- [Replace custom form widget with custom components](#replace-custom-form-widgets-with-custom-components)
|
||||||
|
|
||||||
## Replace default form widgets with APA form widgets
|
## Replace default form widgets with APA form widgets
|
||||||
|
|
||||||
This is an example of replacing the standard `Text` [widget](../../lib/testing/src/lib/core/pages/form/widgets/widget.ts) with a custom component for all APA forms rendered within the `<adf-form>` component.
|
This is an example of replacing the standard `Text` with a custom component for all APA forms rendered within the `<adf-form>` component.
|
||||||
|
|
||||||
1. Create a simple form with some `Text` widgets:
|
1. Create a simple form with some `Text` widgets:
|
||||||
|
|
||||||
@ -24,8 +26,10 @@ This is an example of replacing the standard `Text` [widget](../../lib/testing/s
|
|||||||
```ts
|
```ts
|
||||||
import { Component } from '@angular/core';
|
import { Component } from '@angular/core';
|
||||||
import { WidgetComponent } from '@alfresco/adf-core';
|
import { WidgetComponent } from '@alfresco/adf-core';
|
||||||
|
|
||||||
@Component({
|
@Component({
|
||||||
selector: 'custom-editor',
|
selector: 'custom-editor',
|
||||||
|
standalone: true,
|
||||||
template: `
|
template: `
|
||||||
<div style="color: red">Look, I'm a APA custom editor!</div>
|
<div style="color: red">Look, I'm a APA custom editor!</div>
|
||||||
`
|
`
|
||||||
@ -33,40 +37,14 @@ This is an example of replacing the standard `Text` [widget](../../lib/testing/s
|
|||||||
export class CustomEditorComponent extends WidgetComponent {}
|
export class CustomEditorComponent extends WidgetComponent {}
|
||||||
```
|
```
|
||||||
|
|
||||||
2. Add it to the application module or any custom module that is imported into the application one:
|
2. Import the [`FormRenderingService`](../core/services/form-rendering.service.md) in the feature module, or application module (recommended: `ProcessServicesExtensionModule`), and override the default mapping:
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
import { NgModule } from '@angular/core';
|
|
||||||
import { CustomEditorComponent } from './custom-editor.component';
|
import { CustomEditorComponent } from './custom-editor.component';
|
||||||
@NgModule({
|
import { FormRenderingService } from '@alfresco/adf-core';
|
||||||
declarations: [ CustomEditorComponent ],
|
|
||||||
exports: [ CustomEditorComponent ]
|
|
||||||
})
|
|
||||||
export class CustomEditorsModule {}
|
|
||||||
```
|
|
||||||
|
|
||||||
3. Every custom widget component should be added into the the collections `declarations` and `exports`. If you decided to store custom widgets in a separate dedicated module (and optionally as a separate re-distributable library) don't forget to import it into the main application:
|
@NgModule({...})
|
||||||
|
export class ProcessServicesExtensionModule {
|
||||||
```ts
|
|
||||||
@NgModule({
|
|
||||||
imports: [
|
|
||||||
// ...
|
|
||||||
CustomEditorsModule
|
|
||||||
// ...
|
|
||||||
],
|
|
||||||
providers: [],
|
|
||||||
bootstrap: [ AppComponent ]
|
|
||||||
})
|
|
||||||
export class AppModule {}
|
|
||||||
```
|
|
||||||
|
|
||||||
4. Import the [`FormRenderingService`](../core/services/form-rendering.service.md) into any of your Views and override the default mapping, for example:
|
|
||||||
|
|
||||||
```ts
|
|
||||||
import { Component } from '@angular/core';
|
|
||||||
import { CustomEditorComponent } from './custom-editor.component';
|
|
||||||
@Component({...})
|
|
||||||
export class MyView {
|
|
||||||
constructor(formRenderingService: FormRenderingService) {
|
constructor(formRenderingService: FormRenderingService) {
|
||||||
this.formRenderingService.register({
|
this.formRenderingService.register({
|
||||||
'text': () => CustomEditorComponent
|
'text': () => CustomEditorComponent
|
||||||
@ -75,10 +53,12 @@ This is an example of replacing the standard `Text` [widget](../../lib/testing/s
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
5. At runtime the form should look similar to the following:
|
> [!IMPORTANT]
|
||||||
|
> The widget should be registered outside the custom widget component, otherwise the widget will not be registered correctly.
|
||||||
|
|
||||||

|
At runtime the form should look similar to the following:
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
## Replace custom form widgets with custom components
|
## Replace custom form widgets with custom components
|
||||||
|
|
||||||
@ -105,54 +85,30 @@ When displayed in a task, the field will look similar to the following:
|
|||||||
|
|
||||||
To render the missing content:
|
To render the missing content:
|
||||||
|
|
||||||
1. Create an Angular component:
|
1. Create a standalone Angular component:
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
import { Component } from '@angular/core';
|
import { Component } from '@angular/core';
|
||||||
import { WidgetComponent } from '@alfresco/adf-core';
|
import { WidgetComponent } from '@alfresco/adf-core';
|
||||||
|
|
||||||
@Component({
|
@Component({
|
||||||
selector: 'app-demo-widget',
|
selector: 'app-demo-widget',
|
||||||
|
standalone: true,
|
||||||
template: `<div style="color: green">ADF version of custom form widget</div>`
|
template: `<div style="color: green">ADF version of custom form widget</div>`
|
||||||
})
|
})
|
||||||
export class DemoWidgetComponent extends WidgetComponent {}
|
export class DemoWidgetComponent extends WidgetComponent {}
|
||||||
```
|
```
|
||||||
|
|
||||||
2. Place it inside the custom module:
|
2. Import the [`FormRenderingService`](../core/services/form-rendering.service.md) in the feature module, or application module (recommended: `ProcessServicesExtensionModule`), and override the default mapping:
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
import { NgModule } from '@angular/core';
|
|
||||||
import { DemoWidgetComponent } from './demo-widget.component';
|
import { DemoWidgetComponent } from './demo-widget.component';
|
||||||
@NgModule({
|
import { FormRenderingService } from '@alfresco/adf-core';
|
||||||
declarations: [ DemoWidgetComponent ],
|
|
||||||
exports: [ DemoWidgetComponent ]
|
|
||||||
})
|
|
||||||
export class CustomWidgetsModule {}
|
|
||||||
```
|
|
||||||
|
|
||||||
3. Import it into your Application Module:
|
@NgModule({/*...*/})
|
||||||
|
export class ProcessServicesExtensionModule {
|
||||||
```ts
|
|
||||||
@NgModule({
|
|
||||||
imports: [
|
|
||||||
// ...
|
|
||||||
CustomWidgetsModule
|
|
||||||
// ...
|
|
||||||
],
|
|
||||||
providers: [],
|
|
||||||
bootstrap: [ AppComponent ]
|
|
||||||
})
|
|
||||||
export class AppModule {}
|
|
||||||
```
|
|
||||||
|
|
||||||
4. Import the [`FormRenderingService`](../core/services/form-rendering.service.md) in any of your Views and provide the new mapping:
|
|
||||||
|
|
||||||
```ts
|
|
||||||
import { Component } from '@angular/core';
|
|
||||||
import { DemoWidgetComponent } from './demo-widget.component';
|
|
||||||
@Component({...})
|
|
||||||
export class MyView {
|
|
||||||
constructor(formRenderingService: FormRenderingService) {
|
constructor(formRenderingService: FormRenderingService) {
|
||||||
this.formRenderingService.register({
|
formRenderingService.register({
|
||||||
'custom-editor': () => DemoWidgetComponent
|
'custom-editor': () => DemoWidgetComponent
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
@ -163,6 +119,9 @@ At runtime you should now see your custom Angular component rendered in place of
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
|
> [!IMPORTANT]
|
||||||
|
> The widget should be registered outside the custom widget component, otherwise the widget will not be registered correctly.
|
||||||
|
|
||||||
## See Also
|
## See Also
|
||||||
|
|
||||||
- [Extensibility](./extensibility.md)
|
- [Extensibility](./extensibility.md)
|
||||||
|
Loading…
x
Reference in New Issue
Block a user