mirror of
https://github.com/sartography/bpmn-js.git
synced 2025-01-10 00:55:51 +00:00
e37bddf3a4
The distribution exports the components via their node-module names.
BREAKING CHANGE:
require('bpmn/*') -> require('bpmn-js/*')
require('bpmn/Model') -> require('bpmn-moddle')
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.