sequential-workflow-designer
Advanced tools
Sequential workflow designer with no dependencies for web. It's written in pure TypeScript and uses SVG for rendering. This designer is not associated with any workflow engine. It's full generic. You may create any kind application by this, from graphical programming languages to workflow designers.
Features:
To use the designer you should add JS/TS files and CSS files to your project.
Install this package by NPM command:
npm i sequential-workflow-designer
To import the package:
import Designer from 'sequential-workflow-designer';
If you use css-loader or similar, you can add CSS files to your boundle:
import 'sequential-workflow-designer/css/designer.css';
import 'sequential-workflow-designer/css/designer-light.css';
import 'sequential-workflow-designer/css/designer-dark.css';
To create the designer write the below code:
// ...
Designer.create(placeholder, definition, configuration);
Add the below code to your head section in HTML document.
<head>
...
<link href="https://cdn.jsdelivr.net/npm/sequential-workflow-designer@0.2.3/css/designer.css" rel="stylesheet">
<link href="https://cdn.jsdelivr.net/npm/sequential-workflow-designer@0.2.3/css/designer-light.css" rel="stylesheet">
<link href="https://cdn.jsdelivr.net/npm/sequential-workflow-designer@0.2.3/css/designer-dark.css" rel="stylesheet">
<script src="https://cdn.jsdelivr.net/npm/sequential-workflow-designer@0.2.3/lib/designer.js"></script>
Call the designer by:
sequentialWorkflowDesigner.create(placeholder, definition, configuration);
Check examples directory.
import Designer from 'sequential-workflow-designer';
const placeholder = document.getElementById('placeholder');
const definition = {
properties: {
'myProperty': 'my-value',
// global properties...
},
sequence: [
// root steps...
]
};
const configuration = {
theme: 'light', // optional, default: 'light'
isReadonly: false, // optional, default: false
undoStackSize: 10, // optional, default: 0 - disabled, 1+ - enabled
toolbox: {
isHidden: false, // optional, default: false
groups: [
{
name: 'Files',
steps: [
// steps for the toolbox's group
]
},
{
name: 'Notification',
steps: [
// steps for the toolbox's group
]
}
]
},
steps: {
iconUrlProvider: (componentType, type) => {
return `icon-${componentType}-${type}.svg`;
},
validator: (step) => {
return /^[a-z]+$/.test(step.name);
},
canInsertStep: (step, targetSequence, targetIndex) => {
return targetSequence.length < 5;
},
canMoveStep: (sourceSequence, step, targetSequence, targetIndex) => {
return !step.properties['isLocked'];
},
canDeleteStep: (step, parentSequence) => {
return step.name !== 'x';
}
},
editors: {
isHidden: false, // optional, default: false
globalEditorProvider: (definition) => {
const container = document.createElement('div');
// ...
return container;
},
stepEditorProvider: (step) => {
const container = document.createElement('div');
// ...
return container;
}
}
};
const designer = Designer.create(placeholder, definition, configuration);
designer.onDefinitionChanged.subscribe((newDefinition) => {
// ...
});
Any atomic task.
const taskStep = {
componentType: 'task',
id: 'my-unique-id',
type: 'my-type', // e.g. 'save-file', 'send-email', ...
name: 'my-name',
properties: {
'myProperty': 'my-value',
// ...
}
};
This component is mainly designed for for/while/foreach loops. It could be used as a context container too.
const containerStep = {
componentType: 'container',
id: 'my-unique-id',
type: 'my-type', // e.g. 'for', 'while', 'foreach'...
name: 'my-name',
properties: {
'myProperty': 'my-value',
// ...
},
sequence: [
// steps...
]
};
This component is designed for if/else expressions, but you may use it for switch/case expressions too. This component must have minimum 2 branches.
const switchStep = {
componentType: 'switch',
id: 'my-unique-id',
type: 'my-type', // e.g. 'if', 'switch'...
name: 'my-name',
properties: {
'myProperty': 'my-value',
// ...
},
branches: {
'true': [
// steps...
],
'false': [
// steps...
],
// ...
'next': [
// steps...
]
}
};
This project is released under the MIT license.
0.2.3
Improved rendering of the switch step for 3 and more branches.
FAQs
Customizable no-code component for building flow-based programming applications.
The npm package sequential-workflow-designer receives a total of 1,540 weekly downloads. As such, sequential-workflow-designer popularity was classified as popular.
We found that sequential-workflow-designer demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Deno 2.2 enhances Node.js compatibility, improves dependency management, adds OpenTelemetry support, and expands linting and task automation for developers.
Security News
React's CRA deprecation announcement sparked community criticism over framework recommendations, leading to quick updates acknowledging build tools like Vite as valid alternatives.
Security News
Ransomware payment rates hit an all-time low in 2024 as law enforcement crackdowns, stronger defenses, and shifting policies make attacks riskier and less profitable.