A BPMN 2.0 rendering toolkit and web modeler. https://bpmn.io/toolkit/bpmn-js/
Go to file
Ricardo Matias b233e7f6ed feat(context-pad): pass mouse position to the popup menu
Closes #414
2016-01-06 18:22:12 +01:00
assets/bpmn-font chore(project): migrate to bpmn-icon prefixed font 2015-11-16 15:28:21 +01:00
docs chore(project): update setup instructions 2015-09-30 10:28:04 +02:00
lib feat(context-pad): pass mouse position to the popup menu 2016-01-06 18:22:12 +01:00
resources feat(context-pad): use font to render symbols 2014-11-17 11:02:25 +01:00
tasks chore(bower): hide bpmn-js internals in bundle 2015-02-06 09:56:18 +01:00
test test(context-pad): cleanup provider test case 2016-01-06 17:36:28 +01:00
.gitignore chore(gitignore): add .DS_Store 2015-05-19 09:18:55 +02:00
.jshintrc test(project): replace jasmine with mocha 2015-07-15 17:42:37 +02:00
.travis.yml chore(project): only hint + test during travis builds 2015-02-19 15:03:53 +01:00
.wiredeps chore(project): update didi dependency 2015-10-20 15:34:16 +02:00
CONTRIBUTING.md feat(space-tool): add create/remove space behaviour 2015-04-16 10:00:18 +02:00
Gruntfile.js chore(project): remove jsdoc" 2015-10-21 16:31:26 +02:00
LICENSE feat(project): add license 2014-05-06 14:33:12 +02:00
README.md docs(README): link seed project + standalone pre-packaged files 2015-11-30 16:50:13 +01:00
index.js chore(project): add index.js entry point 2014-06-11 14:36:26 +02:00
package.json chore(project): release v0.12.1 2015-11-19 14:34:32 +01:00

README.md

The project is still in an early stage. Documentation may be missing and examples may be broken.

bpmn-js - BPMN 2.0 for the web

Build Status

bpmn-js is the BPMN 2.0 diagram modeling and rendering toolkit that powers bpmn.io.

Usage

No need for additional setup: Try out our seed project or use the pre-packaged version of the library.

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.io license.