Package Exports

bpmn-js
bpmn-js/lib/Modeler
bpmn-js/lib/Modeler.js
bpmn-js/lib/Viewer
bpmn-js/lib/Viewer.js
bpmn-js/lib/draw/BpmnRenderer
bpmn-js/lib/import/BpmnTreeWalker

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (bpmn-js) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

bpmn-js - BPMN 2.0 diagrams for the web

bpmn-js is the BPMN 2.0 diagram modeling and rendering toolkit that powers bpmn.io.

bpmn-js is in an alpha stage, expect documentation to be missing and examples to be broken.

Usage

Get the library via npm

npm install --save bpmn-js

Use it in your project

var BpmnViewer = require('bpmn-js').Viewer;

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');
  }
});

Make sure to bundle the project for the browser, e.g. by using browserify.

Resources

Building the Project

As long as the project is in alpha stage, you must make sure you setup the whole development environment, including a number of project dependencies according to our development setup.

License

Use under the terms of the bpmn-js license.