A BPMN 2.0 rendering toolkit and web modeler. https://bpmn.io/toolkit/bpmn-js/
Go to file
Nico Rehwaldt de35cdc6a0 chore(modeling): switch to primary modifier for lane expanding 2015-10-22 20:28:08 +02:00
assets/bpmn-font chore(bpmn-font): update 2015-10-21 12:19:01 +02:00
docs chore(project): update setup instructions 2015-09-30 10:28:04 +02:00
lib chore(modeling): switch to primary modifier for lane expanding 2015-10-22 20:28:08 +02:00
resources feat(context-pad): use font to render symbols 2014-11-17 11:02:25 +01:00
tasks chore(bower): hide bpmn-js internals in bundle 2015-02-06 09:56:18 +01:00
test fix(auto-resize): expand non-primary parents in multi select move 2015-10-22 18:20:35 +02:00
.gitignore chore(gitignore): add .DS_Store 2015-05-19 09:18:55 +02:00
.jshintrc test(project): replace jasmine with mocha 2015-07-15 17:42:37 +02:00
.travis.yml chore(project): only hint + test during travis builds 2015-02-19 15:03:53 +01:00
.wiredeps chore(project): update didi dependency 2015-10-20 15:34:16 +02:00
CONTRIBUTING.md feat(space-tool): add create/remove space behaviour 2015-04-16 10:00:18 +02:00
Gruntfile.js chore(project): remove jsdoc" 2015-10-21 16:31:26 +02:00
LICENSE feat(project): add license 2014-05-06 14:33:12 +02:00
README.md docs(README): add travis status badge 2015-02-19 14:59:57 +01:00
index.js chore(project): add index.js entry point 2014-06-11 14:36:26 +02:00
package.json chore(project): bump bpmn-moddle dependency 2015-10-22 08:43:05 +02:00

README.md

bpmn-js - BPMN 2.0 for the web

Build Status

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

the project is still in an early stage. Documentation may be missing and examples may be broken.

Usage

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