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

Go to file

Nico Rehwaldt 8deb9d30a1 fix(import): ensure correctly import associations This commit ensures we correctly detect and import DataAssociations and Associations. It aligns logging across the import components, too, being slightly more verbose and helpful. Related to #112		2014-10-31 15:05:16 +01:00
docs	docs(project): add integration tests to setup script	2014-09-03 18:47:45 +02:00
lib	fix(import): ensure correctly import *associations	2014-10-31 15:05:16 +01:00
resources	feat(context-pad): add visual creation of connections	2014-09-11 16:44:56 +02:00
test	fix(import): ensure correctly import *associations	2014-10-31 15:05:16 +01: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(dependencies): revert to brfs@1.0.2	2014-09-24 11:46:34 +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.