[AAE-3493] Update the documentation to provide the proper guidance on custom forms widgets for APA and APS developers (#6158)

* * improve docs

* * assets fixed

* * links fixed

* * versions fixed

* * assets added

* * fix links

* Update docs/user-guide/aae-extensions.md

Co-authored-by: Mark Hulbert <39801222+m-hulbert@users.noreply.github.com>

* Update docs/user-guide/aae-extensions.md

Co-authored-by: Mark Hulbert <39801222+m-hulbert@users.noreply.github.com>

* Update docs/user-guide/aae-extensions.md

Co-authored-by: Mark Hulbert <39801222+m-hulbert@users.noreply.github.com>

* Update docs/user-guide/aae-extensions.md

Co-authored-by: Mark Hulbert <39801222+m-hulbert@users.noreply.github.com>

* Update docs/user-guide/aae-extensions.md

Co-authored-by: Mark Hulbert <39801222+m-hulbert@users.noreply.github.com>

* Update docs/user-guide/aae-extensions.md

Co-authored-by: Mark Hulbert <39801222+m-hulbert@users.noreply.github.com>

* Update docs/user-guide/aae-extensions.md

Co-authored-by: Mark Hulbert <39801222+m-hulbert@users.noreply.github.com>

* Update docs/user-guide/aae-extensions.md

Co-authored-by: Mark Hulbert <39801222+m-hulbert@users.noreply.github.com>

* Update docs/user-guide/aae-extensions.md

Co-authored-by: Mark Hulbert <39801222+m-hulbert@users.noreply.github.com>

* Update docs/user-guide/aae-extensions.md

Co-authored-by: Mark Hulbert <39801222+m-hulbert@users.noreply.github.com>

* Update docs/user-guide/aae-extensions.md

Co-authored-by: Mark Hulbert <39801222+m-hulbert@users.noreply.github.com>

* Update docs/user-guide/aae-extensions.md

Co-authored-by: Mark Hulbert <39801222+m-hulbert@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Mark Hulbert <39801222+m-hulbert@users.noreply.github.com>

* * example fixed

* * minor changes

* Make stencils document step-based

Co-authored-by: Mark Hulbert <39801222+m-hulbert@users.noreply.github.com>
Co-authored-by: Mark Hulbert <mark.hulbert@alfresco.com>
This commit is contained in:
dhrn 2020-09-25 17:12:37 +05:30 committed by GitHub
parent c84ef7318f
commit d7f0fa5aa0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
13 changed files with 411 additions and 183 deletions

View File

@ -82,7 +82,10 @@ import { ProcessServicesCloudModule } from '@alfresco/adf-process-services-cloud
import { FilteredSearchComponent } from './components/files/filtered-search.component';
import { RouterModule } from '@angular/router';
import { ProcessCloudLayoutComponent } from './components/cloud/process-cloud-layout.component';
import { SampleWidgetComponent } from './components/cloud/custom-form-components/sample-widget.component';
import {
CustomEditorComponent,
CustomWidgetComponent
} from './components/cloud/custom-form-components/custom-editor.component';
import { registerLocaleData } from '@angular/common';
import localeFr from '@angular/common/locales/fr';
@ -188,7 +191,8 @@ registerLocaleData(localeSv);
ConfirmDialogExampleComponent,
FormCloudDemoComponent,
ConfirmDialogExampleComponent,
SampleWidgetComponent,
CustomEditorComponent,
CustomWidgetComponent,
ProcessCloudLayoutComponent
],
providers: [

View File

@ -28,7 +28,10 @@ import {
FormCloudService
} from '@alfresco/adf-process-services-cloud';
import { Subscription } from 'rxjs';
import { SampleWidgetComponent } from '../../../cloud/custom-form-components/sample-widget.component';
import {
CustomEditorComponent,
CustomWidgetComponent
} from '../../../cloud/custom-form-components/custom-editor.component';
@Component({
templateUrl: 'cloud-form-demo.component.html',
@ -60,7 +63,16 @@ export class FormCloudDemoComponent implements OnInit, OnDestroy {
private automationService: CoreAutomationService,
private formRenderingService: FormRenderingService) {
this.formRenderingService.register({
'custom': () => SampleWidgetComponent
'demo-widget': () => CustomEditorComponent,
'custom-editor': () => CustomEditorComponent,
'custom-string': () => CustomWidgetComponent,
'custom-datetime': () => CustomWidgetComponent,
'custom-file': () => CustomWidgetComponent,
'custom-number': () => CustomWidgetComponent,
'custom-something': () => CustomWidgetComponent,
'custom-boolean': () => CustomWidgetComponent,
'custom-date': () => CustomWidgetComponent,
'custom': () => CustomWidgetComponent
});
}

View File

@ -17,14 +17,29 @@
import { Component, OnInit } from '@angular/core';
import { FormService, WidgetComponent } from '@alfresco/adf-core';
// tslint:disable:component-selector
@Component({
selector: 'custom-editor-widget',
template: `
<div style="color: green">
ADF version of custom form widget
</div>
`
})
export class CustomEditorComponent extends WidgetComponent {
constructor() {
super();
}
}
@Component({
selector: 'app-sample-widget',
template: `
<div style="color: red">
Look, I'm custom cloud form widget!
<p *ngIf="field.readOnly || readOnly">
Value :: <span> {{displayValue}}</span>
<label class="adf-label" [attr.for]="field.id">{{field.name | translate }}<span *ngIf="isRequired()">*</span></label>
<span>{{field.value}}</span>
</p>
<mat-form-field *ngIf="!(field.readOnly || readOnly)">
@ -37,21 +52,20 @@ import { FormService, WidgetComponent } from '@alfresco/adf-core';
[value]="field.value"
[(ngModel)]="field.value"
(ngModelChange)="onFieldChanged(field)">
<mat-hint>{{field.placeholder}}</mat-hint>
</mat-form-field>
<error-widget [error]="field.validationSummary"></error-widget>
<error-widget *ngIf="isInvalidFieldRequired()" required="{{ 'FORM.FIELD.REQUIRED' | translate }}"></error-widget>
</div>
`
})
export class SampleWidgetComponent extends WidgetComponent implements OnInit {
displayValue: string;
export class CustomWidgetComponent extends WidgetComponent implements OnInit {
constructor(public formService: FormService) {
super(formService);
}
ngOnInit() {
this.displayValue = this.field.value;
this.field.value = typeof this.field.value === 'object' ? JSON.stringify(this.field.value) : this.field.value;
}
}

View File

@ -18,7 +18,7 @@
import { Component } from '@angular/core';
import { FormRenderingService } from '@alfresco/adf-core';
import { CloudFormRenderingService } from '@alfresco/adf-process-services-cloud';
import { SampleWidgetComponent } from './custom-form-components/sample-widget.component';
import { CustomEditorComponent, CustomWidgetComponent } from './custom-form-components/custom-editor.component';
@Component({
template: `<router-outlet></router-outlet>`,
@ -30,7 +30,16 @@ export class ProcessCloudLayoutComponent {
constructor(private formRenderingService: FormRenderingService) {
this.formRenderingService.register({
'custom': () => SampleWidgetComponent
'custom-editor': () => CustomEditorComponent,
'demo-widget': () => CustomEditorComponent,
'custom-string': () => CustomWidgetComponent,
'custom-datetime': () => CustomWidgetComponent,
'custom-file': () => CustomWidgetComponent,
'custom-number': () => CustomWidgetComponent,
'custom-something': () => CustomWidgetComponent,
'custom-boolean': () => CustomWidgetComponent,
'custom-date': () => CustomWidgetComponent,
'custom': () => CustomWidgetComponent
});
}
}

Binary file not shown.

After

Width:  |  Height:  |  Size: 14 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 34 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.4 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.5 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.5 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.5 KiB

View File

@ -0,0 +1,172 @@
---
Title: Form Extensibility for AAE Form Widget
Added: v4.1.0
---
## Form Extensibility for AAE Form Widget
This page describes how you can customize ADF forms to your own specification.
## Contents
There are two ways to customize the form
- [Replace default form widgets with custom components](#replace-default-form-widgets-with-aae-form-widgets)
- [Replace custom form widget with custom components](#replace-custom-form-widgets-with-custom-components)
## Replace default form widgets with AAE 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 AAE forms rendered within the `<adf-form>` component.
1. Create a simple form with some `Text` widgets:
![default text widget](../docassets/images/aae-simple-form.png)
Every custom widget component must inherit the [`WidgetComponent`](../insights/components/widget.component.md) class in order to function properly:
```ts
import { Component } from '@angular/core';
import { WidgetComponent } from '@alfresco/adf-core';
@Component({
selector: 'custom-editor',
template: `
<div style="color: red">Look, I'm a AAE custom editor!</div>
`
})
export class CustomEditorComponent extends WidgetComponent {}
```
2. Add it to the application module or any custom module that is imported into the application one:
```ts
import { NgModule } from '@angular/core';
import { CustomEditorComponent } from './custom-editor.component';
@NgModule({
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:
```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) {
this.formRenderingService.register({
'text': () => CustomEditorComponent
}, true);
}
}
```
5. At runtime the form should look similar to the following:
![custom text widget](../docassets/images/aae-simple-override-form.png)
## Replace custom form widgets with custom components
This is an example of rendering custom form widgets using custom Angular components.
### Create a custom form widget
To begin, create a basic form widget and call it `demo-widget`:
![custom form widget](../docassets/images/aae-form-widget.png)
**Note**: The `type` is important as it will become the `field type` when the form is rendered.
You can now design a form that uses your custom form widget:
![custom form widget form](../docassets/images/aae-form-with-widget.png)
### Create a custom widget
When displayed in a task, the field will look similar to the following:
![adf form widget](../docassets/images/aae-unresolved-widget.png)
To render the missing content:
1. Create an Angular component:
```ts
import { Component } from '@angular/core';
import { WidgetComponent } from '@alfresco/adf-core';
@Component({
selector: 'app-demo-widget',
template: `<div style="color: green">ADF version of custom form widget</div>`
})
export class DemoWidgetComponent extends WidgetComponent {}
```
2. Place it inside the custom module:
```ts
import { NgModule } from '@angular/core';
import { DemoWidgetComponent } from './demo-widget.component';
@NgModule({
declarations: [ DemoWidgetComponent ],
exports: [ DemoWidgetComponent ]
})
export class CustomWidgetsModule {}
```
3. Import it into your Application Module:
```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) {
this.formRenderingService.register({
'custom-editor': () => DemoWidgetComponent
});
}
}
```
At runtime you should now see your custom Angular component rendered in place of the original form widgets:
![adf form widget runtime](../docassets/images/aae-resolved-widget.png)
## See Also
- [Extensibility](./extensibility.md)
- [Form field model](../core/models/form-field.model.md)
- [Form rendering service](../core/services/form-rendering.service.md)
- [Form component](../core/components/form.component.md)
- [Widget component](../insights/components/widget.component.md)

View File

@ -0,0 +1,184 @@
---
Title: Form Extensibility for APS Stencil
Added: v1.9.0
---
## Form Extensibility for APS Stencil
This page describes how you can customize ADF forms to your own specification.
## Contents
There are two ways to customize the form
- [Replace default form widgets with custom components](#replacing-default-form-widgets-with-custom-components)
- [Replace custom stencils with custom components](#replacing-custom-stencils-with-custom-components)
## Replace default form widgets with custom components
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 APS forms rendered within the `<adf-form>` component.
1. Create a simple form with some `Text` widgets:
![default text widget](../docassets/images/text-default-widget.png)
Every custom [widget](../../lib/testing/src/lib/core/pages/form/widgets/widget.ts) must inherit the [`WidgetComponent`](../insights/components/widget.component.md) class in order to function properly:
```ts
import { Component } from '@angular/core';
import { WidgetComponent } from '@alfresco/adf-core';
@Component({
selector: 'custom-editor',
template: `
<div style="color: red">Look, I'm a custom editor!</div>
`
})
export class CustomEditorComponent extends WidgetComponent {}
```
2. Add it to the application module or any custom module that is imported into the application one:
```ts
import { NgModule } from '@angular/core';
import { CustomEditorComponent } from './custom-editor.component';
@NgModule({
declarations: [ CustomEditorComponent ],
exports: [ CustomEditorComponent ]
})
export class CustomEditorsModule {}
```
3. Every custom [widget](../../lib/testing/src/lib/core/pages/form/widgets/widget.ts) should be added into 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:
```ts
@NgModule({
imports: [
// ...
CustomEditorsModule
// ...
],
providers: [],
bootstrap: [ AppComponent ]
})
export class AppModule {}
```
4. Import the [`FormRenderingService`](../core/services/form-rendering.service.md) in 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) {
formRenderingService.setComponentTypeResolver('text', () => CustomEditorComponent, true);
}
}
```
5. At runtime it should look similar to the following:
![custom text widget](../docassets/images/text-custom-widget.png)
## Replace custom stencils with custom components
This is an example of rendering custom APS stencils using custom Angular components.
### Create a custom stencil
1. Create a basic stencil and call it `Custom Stencil 01`:
![custom stencil](../docassets/images/activiti-stencil-01.png)
**Note**: the `internal identifier` is important as it will become the `field type` when the form is rendered.
2. Create a simple html layout for the [`Form`](../../lib/process-services/src/lib/task-list/models/form.model.ts)`runtime template` and [`Form`](../../lib/process-services/src/lib/task-list/models/form.model.ts)`editor template` fields:
```html
<div style="color: blue">Custom activiti stencil</div>
```
3. Create a test form based on your custom stencil:
![custom stencil form](../docassets/images/activiti-stencil-02.png)
4. Create a task using the test form. It will look similar to the following:
![custom stencil task](../docassets/images/activiti-stencil-03.png)
### Create a custom widget
1. Load the form created in the previous steps into the ADF `<adf-form>` component:
![adf stencil](../docassets/images/adf-stencil-01.png)
2. Create an Angular component to render the missing content:
```ts
import { Component } from '@angular/core';
import { WidgetComponent } from '@alfresco/adf-core';
@Component({
selector: 'custom-stencil-01',
template: `<div style="color: green">ADF version of custom Activiti stencil</div>`
})
export class CustomStencil01 extends WidgetComponent {}
```
3. Place it inside a custom module:
```ts
import { NgModule } from '@angular/core';
import { CustomStencil01 } from './custom-stencil-01.component';
@NgModule({
declarations: [ CustomStencil01 ],
exports: [ CustomStencil01 ]
})
export class CustomEditorsModule {}
```
4. Import it into your Application Module:
```ts
@NgModule({
imports: [
// ...
CustomEditorsModule
// ...
],
providers: [],
bootstrap: [ AppComponent ]
})
export class AppModule {}
```
5. 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 { CustomStencil01 } from './custom-stencil-01.component';
@Component({...})
export class MyView {
constructor(formRenderingService: FormRenderingService) {
formRenderingService.setComponentTypeResolver('custom_stencil_01', () => CustomStencil01, true);
}
}
```
6. At runtime you should now see your custom Angular component rendered in place of the stencils:
![adf stencil runtime](../docassets/images/adf-stencil-02.png)
## See Also
- [Extensibility](./extensibility.md)
- [Form field model](../core/models/form-field.model.md)
- [Form rendering service](../core/services/form-rendering.service.md)
- [Form component](../core/components/form.component.md)
- [Widget component](../insights/components/widget.component.md)

View File

@ -18,10 +18,7 @@ _Note: it is assumed you are familiar with Alfresco Process Services (powered by
- [How components and widgets are rendered on a Form](#how-components-and-widgets-are-rendered-on-a-form)
- [Component type resolvers](#component-type-resolvers)
- [Default component mappings](#default-component-mappings)
- [Replacing default form widgets with custom components](#replacing-default-form-widgets-with-custom-components)
- [Replacing custom stencils with custom components](#replacing-custom-stencils-with-custom-components)
- [Creating custom stencil](#creating-custom-stencil)
- [Creating custom widget](#creating-custom-widget)
- [Form Extensibility for APS/AAE](#form-extensibility-for-apsaae)
- [See Also](#see-also)
## How components and widgets are rendered on a Form
@ -102,173 +99,9 @@ formRenderingService.setComponentTypeResolver('text', customResolver, true);
| Attach | upload | AttachWidgetComponent or [`UploadWidgetComponent`](../../lib/core/form/components/widgets/upload/upload.widget.ts) (based on metadata) |
| N/A | N/A | [`UnknownWidgetComponent`](../../lib/core/form/components/widgets/unknown/unknown.widget.ts) |
## Replacing default form widgets with custom components
This is a short walkthrough on replacing a standard `Text` [widget](../../lib/testing/src/lib/core/pages/form/widgets/widget.ts) with a custom component for all APS forms
rendered within `<adf-form>` component.
First let's create a simple APS form with `Text` widgets:
![default text widget](../docassets/images/text-default-widget.png)
Every custom [widget](../../lib/testing/src/lib/core/pages/form/widgets/widget.ts) must inherit [`WidgetComponent`](../insights/components/widget.component.md) class in order to function properly:
```ts
import { Component } from '@angular/core';
import { WidgetComponent } from '@alfresco/adf-core';
@Component({
selector: 'custom-editor',
template: `
<div style="color: red">Look, I'm a custom editor!</div>
`
})
export class CustomEditorComponent extends WidgetComponent {}
```
Now you will need to add it to the application module or any custom module that is imported into the application one:
```ts
import { NgModule } from '@angular/core';
import { CustomEditorComponent } from './custom-editor.component';
@NgModule({
declarations: [ CustomEditorComponent ],
exports: [ CustomEditorComponent ]
})
export class CustomEditorsModule {}
```
Every custom [widget](../../lib/testing/src/lib/core/pages/form/widgets/widget.ts) should be added into the following collections: `declarations`, `exports`.
If you decided to store custom widgets in a separate dedicated module (and optionally as separate redistributable library)
don't forget to import it into your main application one:
```ts
@NgModule({
imports: [
// ...
CustomEditorsModule
// ...
],
providers: [],
bootstrap: [ AppComponent ]
})
export class AppModule {}
```
Now you can import [`FormRenderingService`](../core/services/form-rendering.service.md) in any of your Views and override default mapping similar to the following:
```ts
import { Component } from '@angular/core';
import { CustomEditorComponent } from './custom-editor.component';
@Component({...})
export class MyView {
constructor(formRenderingService: FormRenderingService) {
formRenderingService.setComponentTypeResolver('text', () => CustomEditorComponent, true);
}
}
```
At runtime it should look similar to the following:
![custom text widget](../docassets/images/text-custom-widget.png)
## Replacing custom stencils with custom components
This is a short walkthrough on rendering custom APS stencils by means of custom Angular components.
### Creating custom stencil
First let's create a basic stencil and call it `Custom Stencil 01`:
![custom stencil](../docassets/images/activiti-stencil-01.png)
_Note the `internal identifier` value as it will become a `field type` value when corresponding form is rendered._
Next put some simple html layout for [`Form`](../../lib/process-services/src/lib/task-list/models/form.model.ts)`runtime template` and [`Form`](../../lib/process-services/src/lib/task-list/models/form.model.ts)`editor template` fields:
```html
<div style="color: blue">Custom activiti stencil</div>
```
Now you are ready to design a test form based on your custom stencil:
![custom stencil form](../docassets/images/activiti-stencil-02.png)
Once wired with a new task it should look like the following within APS web application:
![custom stencil task](../docassets/images/activiti-stencil-03.png)
### Creating custom widget
If you load previously created task into ADF `<adf-form>` component you will see something like the following:
![adf stencil](../docassets/images/adf-stencil-01.png)
Let's create an Angular component to render missing content:
```ts
import { Component } from '@angular/core';
import { WidgetComponent } from '@alfresco/adf-core';
@Component({
selector: 'custom-stencil-01',
template: `<div style="color: green">ADF version of custom Activiti stencil</div>`
})
export class CustomStencil01 extends WidgetComponent {}
```
Put it inside custom module:
```ts
import { NgModule } from '@angular/core';
import { CustomStencil01 } from './custom-stencil-01.component';
@NgModule({
declarations: [ CustomStencil01 ],
exports: [ CustomStencil01 ]
})
export class CustomEditorsModule {}
```
And import into your Application Module
```ts
@NgModule({
imports: [
// ...
CustomEditorsModule
// ...
],
providers: [],
bootstrap: [ AppComponent ]
})
export class AppModule {}
```
Now you can import [`FormRenderingService`](../core/services/form-rendering.service.md) in any of your Views and provide new mapping:
```ts
import { Component } from '@angular/core';
import { CustomStencil01 } from './custom-stencil-01.component';
@Component({...})
export class MyView {
constructor(formRenderingService: FormRenderingService) {
formRenderingService.setComponentTypeResolver('custom_stencil_01', () => CustomStencil01, true);
}
}
```
At runtime you should now see your custom Angular component rendered in place of the stencils:
![adf stencil runtime](../docassets/images/adf-stencil-02.png)
## Form Extensibility for APS/AAE
- [Form Extensibility for APS Stencil](./aps-extensions.md)
- [Form Extensibility for AAE Form Widget](./aae-extensions.md)
## See Also