The project is still in an early stage. Documentation may be missing and examples may be broken.
bpmn-js - BPMN 2.0 for the web
bpmn-js is a BPMN 2.0 diagram rendering toolkit and web modeler.
Usage
No need for additional setup: Try out our seed project or use the pre-packaged version of the library.
Get the library via npm or Bower and use it in your web applications to display BPMN 2.0 diagrams.
var BpmnViewer = require('bpmn-js');
var xml; // my BPMN 2.0 xml
var viewer = new BpmnViewer({ container: 'body' });
viewer.importXML(xml, function(err) {
if (err) {
console.log('error rendering', err);
} else {
console.log('rendered');
}
});
Installation
Fetch bpmn-js prebuilt or install it via npm.
Fetch Prebuilt
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.
Install via npm
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.
Resources
Building the Project
Perform the following steps to build the library, including running all tests:
cd bpmn-js
npm install
grunt
When building the latest development snapshot you may need to perform additional project setup.
Related
bpmn-js builds on top of a few additional powerful tools:
- bpmn-moddle: Read / write support for BPMN 2.0 XML in the browsers
- diagram-js: Diagram rendering and editing toolkit
License
Use under the terms of the bpmn.io license.