@omneedia/workflow-designer
v11.0.1
Published
forked version of sequential workflow designer
Downloads
10
Readme
Sequential Workflow Designer
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 builders.
Features:
- 0 external dependencies,
- full generic & configurable,
- light/dark themes,
- works on modern browsers,
- works on mobile,
- the definition is stored as JSON,
- has support for React and Angular.
📝 Check the documentation for more details.
🤩 Don't miss the pro version.
👀 Examples
- ⏩ Live Testing
- ❎ Fullscreen
- 🌅 Image Filter
- 🔴 Particles
- ⛅ Light Dark
- 🤖 Code Generator
- 📐 Simple Flow
- 🌻 Rendering Test
- 🚄 Stress Test
- 🚪 Editing Restrictions
- 📜 Scrollable Page
Pro:
- 🤩 Pro Components
- 👈 Goto
- 📁 Folders
- ⭕ Wheel Mode
- 🐭 Minimal Root Component
- 🦁 External UI Components
- 👋 Custom Dragged Component
- 🔰 Badges
- 🎩 Custom Viewport
- 🛎 Clickable Placeholder
👩💻 Integrations
- 🚚 Sequential Workflow Machine - JavaScript workflow engine, powered by the xstate library.
🚀 Installation
To use the designer you should add JS/TS files and CSS files to your project.
NPM
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);CDN
Add the below code to your head section in HTML document.
<head>
...
<link href="https://cdn.jsdelivr.net/npm/[email protected]/css/designer.css" rel="stylesheet">
<link href="https://cdn.jsdelivr.net/npm/[email protected]/css/designer-light.css" rel="stylesheet">
<link href="https://cdn.jsdelivr.net/npm/[email protected]/css/designer-dark.css" rel="stylesheet">
<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/index.umd.js"></script>Call the designer by:
sequentialWorkflowDesigner.Designer.create(placeholder, definition, configuration);🎬 Usage
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
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';
}
},
toolbox: {
groups: [
{
name: 'Files',
steps: [
// steps for the toolbox's group
]
},
{
name: 'Notification',
steps: [
// steps for the toolbox's group
]
}
]
},
editors: {
globalEditorProvider: (definition, globalContext) => {
const editor = document.createElement('div');
// ...
return editor;
},
stepEditorProvider: (step, stepContext) => {
const editor = document.createElement('div');
// ...
return editor;
}
},
controlBar: true,
};
const designer = Designer.create(placeholder, definition, configuration);
designer.onDefinitionChanged.subscribe((newDefinition) => {
// ...
});You can hide default UI components by setting the corresponding configuration property to false.
const configuration = {
toolbox: false,
editors: false,
controlBar: false,
// ...
}💡 License
This project is released under the MIT license.