A BPMN 2.0 rendering toolkit and web modeler.
https://bpmn.io/toolkit/bpmn-js/
027c4278fd
This commit removes the build dependency on brfs by inlining the bpmn-js logo directly into the source code. Because of that users have an easier time integrating the library. |
||
|---|---|---|
| docs | ||
| example | ||
| lib | ||
| resources | ||
| test | ||
| .gitignore | ||
| .jshintrc | ||
| Gruntfile.js | ||
| LICENSE | ||
| README.md | ||
| bower.json | ||
| package.json | ||
README.md
bpmn-js - BPMN 2.0 diagrams 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.