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

Go to file

Nico Rehwaldt 0a619a53fd fix(BpmnRenderer): minor drawing improvements This fix contributes these improvements * reset strokeWidth back to 1px for boundary + intermediate events * unify strokeDasharray for initiating start + cancelActivity boundary events * set dataObject fill to white		2014-05-28 23:19:41 +02:00
docs	chore(project): pull out bpmn model	2014-04-03 19:34:17 +02:00
example	chore(example): update to latest bpmn-js	2014-05-27 18:47:45 +02:00
lib	fix(BpmnRenderer): minor drawing improvements	2014-05-28 23:19:41 +02:00
resources	feat(zoomscroll): add zoom scroll util	2014-04-11 17:11:10 +02:00
test	feat(BpmnRenderer): clean up flow markers	2014-05-28 22:49:35 +02:00
.gitignore	chore(build): generate api docs to docs/api	2014-03-17 15:11:15 +01:00
.jshintrc	chore(jshint): remove unnecessary config	2014-05-21 16:30:18 +02:00
Gruntfile.js	chore(distro): align exports with project name	2014-05-28 15:36:41 +02:00
LICENSE	feat(project): add license	2014-05-06 14:33:12 +02:00
README.md	docs(README): fix example link + heading	2014-05-26 11:26:02 +02:00
bower.json	chore(project): pull out bpmn model	2014-04-03 19:34:17 +02:00
package.json	chore(project): release v0.1.3	2014-05-26 09:34:07 +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.

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.