!Sequential Workflow Designer for Angular

Sequential Workflow Designer for Angular

  

Angular wrapper for the Sequential Workflow Designer component.

🚀 Installation

Install the following packages by NPM command:

npm i sequential-workflow-designer sequential-workflow-designer-angular

Add CSS files to your angular.json file.

``json
{
"projects": {
"YOUR_APP": {
"architect": {
"build": {
"styles": [
"./node_modules/sequential-workflow-designer/css/designer.css",
"./node_modules/sequential-workflow-designer/css/designer-light.css",
"./node_modules/sequential-workflow-designer/css/designer-dark.css"
]
}
}
}
}
}
`

🎬 Usage

Import the module:

`ts
import { SequentialWorkflowDesignerModule } from 'sequential-workflow-designer-angular';

@NgModule({
imports: [
SequentialWorkflowDesignerModule,
// ...
],
// ...
})
export class AppModule {}
`

Define a definition and a configuration.

`ts
export class AppComponent {
private designer?: Designer;
public definition: Definition = { / ... / };
public toolboxConfiguration: ToolboxConfiguration = { / ... / };
public stepsConfiguration: StepsConfiguration = { / ... / };
public validatorConfiguration: ValidatorConfiguration = { / ... / };
// ...
}
`

Define the following methods to handle the designer's events.

`ts
export class AppComponent {
//...
public onDesignerReady(designer: Designer) {
this.designer = designer;
}

public onDefinitionChanged(definition: Definition) {
this.definition = definition;
}

public onSelectedStepIdChanged(stepId: string | null) {
// ...
}
}
`

Additionally we need to define a few utils methods to handle the editor's logic.

`ts
export class AppComponent {
// ...
public updateName(step: Step, event: Event, context: StepEditorContext) {
step.name = (event.target as HTMLInputElement).value;
context.notifyNameChanged();
}

public updateProperty(properties: Properties, name: string, event: Event, context: RootEditorContext | StepEditorContext) {
properties[name] = (event.target as HTMLInputElement).value;
context.notifyPropertiesChanged();
}
}
`

Create a template for the root editor. The value of the editor variable implements the RootEditorWrapper interface.

`html



Root Editor

Velocity


[value]="editor.definition.properties.velocity"
(input)="updateProperty(editor.definition.properties, 'velocity', $event, editor.context)" />

`

`ts
interface RootEditorWrapper {
definition: Definition;
context: RootEditorContext;
isReadonly: boolean;
}
`

Create a template for the step editor. The value of the editor variable implements the StepEditorWrapper interface.

`html



Step Editor

Name

[value]="editor.step.name"
(input)="updateName(editor.step, $event, editor.context)" />

Velocity

[value]="editor.step.properties.velocity"
(input)="updateProperty(editor.step.properties, 'velocity', $event, editor.context)" />

`

`ts
interface StepEditorWrapper {
step: Step;
definition: Definition;
context: StepEditorContext;
isReadonly: boolean;
}
`

At the end attach the designer:

`html
theme="light"
[undoStackSize]="10"
[definition]="startDefinition"
[toolboxConfiguration]="toolboxConfiguration"
[stepsConfiguration]="stepsConfiguration"
[validatorConfiguration]="validatorConfiguration"
[controlBar]="true"
[contextMenu]="true"
[areEditorsHidden]="false"
[rootEditor]="rootEditor"
[stepEditor]="stepEditor"
(onReady)="onDesignerReady($event)"
(onDefinitionChanged)="onDefinitionChanged($event)"
(onSelectedStepIdChanged)="onSelectedStepIdChanged($event)">

``

Check the demo project.

💡 License

This project is released under the MIT license.