The project is still in an early stage. Documentation may be missing and examples may be broken.
bpmn-js is a BPMN 2.0 diagram rendering toolkit and web modeler.
var BpmnViewer = ;var xml; // my BPMN 2.0 xmlvar viewer = container: 'body' ;viewer;
You may attach or detach the viewer dynamically to any element on the page, too:
var viewer = ;// attach it to some elementviewer;// detach the panelviewer;
The bower-bpmn-js repository contains pre-built bundles of bpmn-js.
Download them directly or fetch them with Bower:
bower install bpmn-js
Checkout the example project to get started.
Fetch the library via npm to get fine grained access to the parts you need:
npm install --save bpmn-js
Make sure you use browserify or the like to bundle your project and bpmn-js for the browser.
Checkout the example project to learn more.
Perform the following steps to build the library, including running all tests:
cd bpmn-js npm install npm run all
You may need to perform additional project setup when building the latest development snapshot.
Please checkout our contributing guidelines if you plan to file an issue or pull request.
bpmn-js builds on top of a few additional powerful tools:
Use under the terms of the bpmn.io license.