Package Exports

bpmn-js
bpmn-js/assets/bpmn-font/css/bpmn-embedded.css
bpmn-js/lib/Modeler
bpmn-js/lib/Modeler.js
bpmn-js/lib/NavigatedViewer
bpmn-js/lib/NavigatedViewer.js
bpmn-js/lib/Viewer
bpmn-js/lib/Viewer.js
bpmn-js/lib/core
bpmn-js/lib/draw
bpmn-js/lib/draw/BpmnRenderer
bpmn-js/lib/features/context-pad/ContextPadProvider
bpmn-js/lib/features/label-editing/LabelEditingProvider
bpmn-js/lib/features/label-editing/LabelUtil
bpmn-js/lib/features/label-editing/cmd/UpdateLabelHandler
bpmn-js/lib/features/modeling
bpmn-js/lib/features/modeling/BpmnFactory
bpmn-js/lib/features/modeling/BpmnUpdater
bpmn-js/lib/features/modeling/ElementFactory
bpmn-js/lib/features/modeling/Modeling
bpmn-js/lib/features/modeling/util/LaneUtil
bpmn-js/lib/features/modeling/util/ModelingUtil
bpmn-js/lib/features/palette
bpmn-js/lib/features/palette/PaletteProvider
bpmn-js/lib/features/popup-menu/ReplaceMenuProvider
bpmn-js/lib/features/popup-menu/util/TypeUtil
bpmn-js/lib/features/replace/ReplaceOptions
bpmn-js/lib/features/rules/BpmnRules
bpmn-js/lib/import/BpmnTreeWalker
bpmn-js/lib/import/Util
bpmn-js/lib/util/DiUtil
bpmn-js/lib/util/LabelUtil
bpmn-js/lib/util/ModelUtil
bpmn-js/test/TestHelper
bpmn-js/test/helper

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

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

Install bpmn-js

via bower

bower install bpmn-js

Make sure to include the library + all dependencies into the website.

Checkout an example project that shows how to use the library in web applications.

via npm

npm install --save bpmn-js

Make sure you use browserify or the like to bundle your project and bpmn-js for the browser.

Checkout an example project that shows how to use bpmn-js in node-style web applications.

Resources

Tools

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

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.io license.