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

Go to file

Nico Rehwaldt 8e55edd80f chore(copy-paste): temporarily prevent consecutive paste This prevents users from creating invalid models due to IDs not properly being generated on consecutive paste (#686). Closes #688.		2017-05-19 13:01:57 +02:00
assets/bpmn-font	chore(font): update font	2016-01-18 14:36:49 +01:00
docs	chore(project): clarify setup	2016-09-01 10:17:50 +02:00
lib	chore(copy-paste): temporarily prevent consecutive paste	2017-05-19 13:01:57 +02:00
resources	docs(project): add screencast	2016-03-29 09:11:45 +02:00
tasks	chore(project): update dev dependencies	2016-01-27 13:31:17 +01:00
test	chore(copy-paste): temporarily prevent consecutive paste	2017-05-19 13:01:57 +02:00
.eslintrc	chore(project): switch to eslint	2016-06-07 09:55:32 +02:00
.gitignore	chore(gitignore): add .DS_Store	2015-05-19 09:18:55 +02:00
.travis.yml	chore(travis): opt-out of sudo	2017-05-19 12:56:59 +02:00
.wiredeps	chore(project): update tiny-svg dependency and wiredeps	2016-11-09 08:23:34 +01:00
CONTRIBUTING.md	feat(space-tool): add create/remove space behaviour	2015-04-16 10:00:18 +02:00
Gruntfile.js	feat(Viewer): allow dynamic attach / detach from DOM	2017-01-27 13:28:27 +01:00
LICENSE	chore(project): update license	2016-01-07 15:52:40 +01:00
README.md	feat(Viewer): allow dynamic attach / detach from DOM	2017-01-27 13:28:27 +01:00
index.js	chore(project): add index.js entry point	2014-06-11 14:36:26 +02:00
package.json	chore(project): bump dev dependencies	2017-05-19 12:56:59 +02: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

bpmn-js is a BPMN 2.0 diagram rendering toolkit and web modeler.

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');
  }
});

Dynamic Attach/Detach

You may attach or detach the viewer dynamically to any element on the page, too:

var viewer = new BpmnViewer();

// attach it to some element
viewer.attachTo('#container');

// detach the panel
viewer.detach();

Installation

Fetch bpmn-js prebuilt or install it via npm.

Fetch Prebuilt

The bower-bpmn-js repository contains pre-built bundles of bpmn-js.

Download them directly or fetch them with Bower:

bower install bpmn-js

Checkout the example project to get started.

Install via npm

Fetch the library via npm to get fine grained access to the parts you need:

npm install --save bpmn-js

Make sure you use browserify or the like to bundle your project and bpmn-js for the browser.

Checkout the example project to learn more.

Resources

Building the Project

Perform the following steps to build the library, including running all tests:

cd bpmn-js
npm install
npm run all

You may need to perform additional project setup when building the latest development snapshot.

Please checkout our contributing guidelines if you plan to file an issue or pull request.

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

License

Use under the terms of the bpmn.io license.