A BPMN 2.0 rendering toolkit and web modeler. https://bpmn.io/toolkit/bpmn-js/

Go to file

Nico Rehwaldt 88fbe05ae4 chore(project): remove browserify bundle Bundling must be done by users of the library in some way anyway. All those that do not bundle it will use the bower version. Removing the bundle function to keep the build slim.		2014-08-21 15:34:37 +02:00
docs	docs(project): use npm link during setup	2014-08-19 20:46:28 +02:00
lib	fix(Viewer): export base layer as SVG only	2014-08-17 19:09:46 +02:00
resources	feat(modeling): allow append TextAnnotation	2014-08-05 17:21:49 +02:00
test	test(importer): fix xml id	2014-08-18 13:48:45 +02:00
.gitignore	chore(build): generate api docs to docs/api	2014-03-17 15:11:15 +01:00
.jshintrc	chore(jshint): update	2014-07-31 15:57:15 +02:00
Gruntfile.js	chore(project): remove browserify bundle	2014-08-21 15:34:37 +02:00
LICENSE	feat(project): add license	2014-05-06 14:33:12 +02:00
README.md	docs(README): add links to diagram-js + bpmn-moddle	2014-06-19 08:11:13 +02:00
index.js	chore(project): add index.js entry point	2014-06-11 14:36:26 +02:00
package.json	chore(project): remove browserify bundle	2014-08-21 15:34:37 +02:00

README.md

bpmn-js - BPMN 2.0 for the web

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.