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

Go to file

Philipp d521b018c1 fix: reusing process when creating first participant works on redo * during `#preExecute` of `elements.create` process is passed to `shape.create` to be reused during `#execute` (there is no `#exeute` for `elements.create` as it only executes other commands during `#preExecute`) * process must be reused during `#execute` of `shape.create` for `#redo` to work * refactor implementation Closes #1439		2022-01-24 10:45:55 +00:00
.github	Merge master to develop	2021-10-25 06:55:15 +00:00
assets	chore(css): expose color variables in bpmn-js.css	2021-11-24 10:40:04 +01:00
docs	docs: move single run to CONTRIBUTING guide	2020-12-21 22:43:43 +01:00
lib	fix: reusing process when creating first participant works on redo	2022-01-24 10:45:55 +00:00
resources	chore(logo): update local file	2020-05-26 14:42:45 +02:00
tasks	chore: prevent double bundling	2021-11-03 10:54:20 +00:00
test	fix: reusing process when creating first participant works on redo	2022-01-24 10:45:55 +00: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
CHANGELOG.md	chore(CHANGELOG): update to v9.0.0-alpha.0	2022-01-11 14:41:06 +01:00
LICENSE	chore(project): update license	2020-05-20 16:09:03 +00:00
README.md	ci: remove Travis CI config	2021-05-03 12:10:41 +00:00
index.js	fix(project): correct library default export	2018-04-05 09:47:37 +02:00
package-lock.json	9.0.0-alpha.0	2022-01-11 14:47:32 +01:00
package.json	9.0.0-alpha.0	2022-01-11 14:47:32 +01:00
rollup.config.js	chore: prevent double bundling	2021-11-03 10:54:20 +00:00

README.md

bpmn-js - BPMN 2.0 for the web

View and edit BPMN 2.0 diagrams in the browser.

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:

const xml = '...'; // my BPMN 2.0 xml
const 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:

const viewer = new BpmnJS();

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

// detach the panel
viewer.detach();

Resources

Build and Run

Prepare the project by installing all dependencies:

npm install

Then, depending on your use-case you may run any of the following commands:

# build the library and run all tests
npm run all

# spin up a single local modeler instance
npm start

# run the full development setup
npm run dev

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

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

Contributing

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

Code of Conduct

By participating to this project, please uphold to our Code of Conduct.

License

Use under the terms of the bpmn.io license.