A BPMN 2.0 rendering toolkit and web modeler. https://bpmn.io/toolkit/bpmn-js/
Go to file
Nico Rehwaldt 37777565c7 7.0.0-beta.0 2020-05-27 12:36:59 +02:00
.github chore(project): rework issue templates 2019-11-29 18:15:01 +01:00
docs chore(CONTRIBUTING): link conventional commits 2018-09-27 14:34:48 +02:00
lib chore(project): update logo 2020-05-25 17:09:05 +02:00
resources chore(logo): update local file 2020-05-26 14:42:45 +02:00
tasks chore(tasks/update-website): do not read and write at the same time 2020-02-04 09:49:21 +01:00
test feat(lib): deprecate import.parse.complete <context> payload 2020-04-29 11:12:23 +02:00
.babelrc chore(project): build using ES6 ready deps 2018-04-03 16:30:05 +02:00
.eslintignore chore(project): don't lint coverage folder 2018-10-04 16:37:28 +02:00
.eslintrc chore(project): declare Promise as a global variable for linting 2020-04-29 11:12:23 +02:00
.gitignore chore(project): re-introduce package-lock 2018-11-27 08:38:38 +00:00
.npmignore chore(project): remove coverage directory from the package 2019-08-22 13:55:30 +02:00
.travis.yml chore(tasks): update examples and websites on stable release only 2020-02-05 11:26:11 +00:00
CHANGELOG.md chore(CHANGELOG): update 2020-05-27 12:31:13 +02:00
LICENSE chore(project): update license 2020-05-20 16:09:03 +00:00
README.md docs(README): up example 2020-04-29 11:37:51 +02:00
index.js fix(project): correct library default export 2018-04-05 09:47:37 +02:00
package-lock.json 7.0.0-beta.0 2020-05-27 12:36:59 +02:00
package.json 7.0.0-beta.0 2020-05-27 12:36:59 +02:00
rollup.config.js chore(project): minify using terser 2019-07-31 13:03:32 +02:00

README.md

bpmn-js - BPMN 2.0 for the web

Build Status

View and edit BPMN 2.0 diagrams in the browser.

bpmn-js screencast

Installation

Use the library pre-packaged or include it via npm into your node-style web-application.

Usage

To get started, create a bpmn-js instance and render BPMN 2.0 diagrams in the browser:

var xml; // my BPMN 2.0 xml
var viewer = new BpmnJS({
  container: 'body'
});

try {
  const { warnings } = await viewer.importXML(xml);

  console.log('rendered');
} catch (err) {
  console.log('error rendering', err);
}

Checkout our examples for many more supported usage scenarios.

Dynamic Attach/Detach

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

var viewer = new BpmnJS();

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

// detach the panel
viewer.detach();

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