sequential-workflow-designer
Advanced tools
Customizable no-code component for building flow-based programming applications.
Sequential workflow designer with 0 external 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:
📝 Check the documentation for more details.
🤩 Don't miss the pro version.
Pro:
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 bundle:
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.8.0/css/designer.css" rel="stylesheet">
<link href="https://cdn.jsdelivr.net/npm/sequential-workflow-designer@0.8.0/css/designer-light.css" rel="stylesheet">
<link href="https://cdn.jsdelivr.net/npm/sequential-workflow-designer@0.8.0/css/designer-dark.css" rel="stylesheet">
<script src="https://cdn.jsdelivr.net/npm/sequential-workflow-designer@0.8.0/dist/index.umd.js"></script>
Call the designer by:
sequentialWorkflowDesigner.Designer.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: {
// all properties in this section are optional
iconUrlProvider: (componentType, type) => {
return `icon-${componentType}-${type}.svg`;
},
validator: (step, sourceSequence) => {
return /^[a-z]+$/.test(step.name);
},
isDraggable: (step, parentSequence) => {
return step.name !== 'y';
},
isDeletable: (step, parentSequence) => {
return step.properties['isDeletable'];
},
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, globalContext) => {
const editor = document.createElement('div');
// ...
return editor;
},
stepEditorProvider: (step, stepContext) => {
const editor = document.createElement('div');
// ...
return editor;
}
}
};
const designer = Designer.create(placeholder, definition, configuration);
designer.onDefinitionChanged.subscribe((newDefinition) => {
// ...
});
This project is released under the MIT license.
0.8.0
sequential-workflow-designer package to the sequential-workflow-model package. By this it's possible to create a common package with your workflow model and use it for the front-end and back-end applications at the same time. The sequential-workflow-designer package exports definition types as before, but these types come from the sequential-workflow-model package. You don't have to include the sequential-workflow-model package to your project if you don't need it. You can read more about this approach here.TaskStep, SwitchStep, ContainerStep interfaces are depreciated now. Those types will be removed in the future.
🤩 We launched a new project: Sequential Workflow Machine. It's a JavaScript workflow engine for the frontend and the backend. The engine uses exactly the same data model as the Sequential Workflow Designer. It means you can use the same workflow definition for the designer and the engine. The new package is powered by the xstate library.
FAQs
Customizable no-code component for building flow-based programming applications.
The npm package sequential-workflow-designer receives a total of 1,901 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
Research
Socket researchers have discovered malicious npm packages targeting crypto developers, stealing credentials and wallet data using spyware delivered through typosquats of popular cryptographic libraries.
Security News
Socket's package search now displays weekly downloads for npm packages, helping developers quickly assess popularity and make more informed decisions.
Security News
A Stanford study reveals 9.5% of engineers contribute almost nothing, costing tech $90B annually, with remote work fueling the rise of "ghost engineers."