bpmn-io /bpmn-js
A BPMN 2.0 rendering toolkit and web modeler.
★ 9,736⑂ 1,499👁 224⑃ 1,055● 1,442▤ 98
+0
日增长
9,736
stars
1,499
forks
224
watchers
1,055
prs
1,442
issues
98
releases
README
bpmn-js - BPMN 2.0 for the web
View and edit BPMN 2.0 diagrams in the browser.
Installation
Use the library pre-packaged
or include it via npm
into your node-style web-application.
Usage
To get started, create a bpmn-js instance
and render BPMN 2.0 diagrams in the browser:
javascript
const xml = '...'; // my BPMN 2.0 xml
const viewer = new BpmnJS({
container: 'body'
});
try {
const { warnings } = await viewer.importXML(xml);
console.log('rendered');
} catch (err) {
console.log('error rendering', err);
}
Checkout our examples for many
more supported usage scenarios.
Resources
Demo
Issues
Examples
Forum
Changelog
Build and Run
Prepare the project by installing all dependencies:
sh
npm install
Then, depending on your use-case you may run any of the following commands:
sh
build the library and run all tests
npm run all
spin up a single local modeler instance
npm start
run the full development setup
npm run dev
You may need to perform additional project setup when
building the latest development snapshot.
Related
bpmn-js builds on top of a few powerful tools:
bpmn-moddle: Read / write support for BPMN 2.0 XML in the browser
diagram-js: Diagram rendering and editing toolkit
It is an extensible toolkit, complemented by many additional utilities.
License
Use under the terms of the bpmn.io license.Top issues
#507Vertical Pools and Lanes Modeling20 comments · 2016-04-11#1341Render URLs in text annotations as clickable links18 comments · 2020-08-11#924Support RTL (right to left) languages18 comments · 2018-12-15#757Auto Placement should not put elements on top of existing flows18 comments · 2018-01-29#2221A bug occurs when deleting a box :A DOM element reference is required, But there is no problem using shift to select11 comments · 2024-08-19#2080Collapsed Event Sub-Processes do not show the type10 comments · 2024-01-16#748Activate direct editing on create for all activities and events10 comments · 2018-01-05#332Provide Documentation10 comments · 2015-08-12
Latest release
v18.31.0 v18.31.0 2026-10-01Changes - chore(CHANGELOG): update to v18.31.0 81c1652a - deps: update to [email protected] f0371c3d - chore: update test dependencies e4c2a77a - deps: update to [email protected] 71cde543 - deps: update to [email protected] 30840b37 - fix(modeling): remove BPMNLabel with external label e2c39ea0 --- https://github.com/bpmn-io/bpmn-js/compare/v18.30.1...v18.31.0