A BPMN 2.0 rendering toolkit and web modeler.
https://bpmn.io/toolkit/bpmn-js/
9c063f867b
This was removed in f8f9334, but it occurred that the method is used productively by some of the clients. This commit restores the method as part of public API. Use `Viewer#importDefinitions` to import previously parsed definitions. Now it is also possible to pass the diagram or diagram id to be rendered during graphical import. |
||
|---|---|---|
| .github | ||
| docs | ||
| lib | ||
| resources | ||
| tasks | ||
| test | ||
| .babelrc | ||
| .eslintignore | ||
| .eslintrc | ||
| .gitignore | ||
| .npmignore | ||
| .travis.yml | ||
| CHANGELOG.md | ||
| LICENSE | ||
| README.md | ||
| index.js | ||
| package-lock.json | ||
| package.json | ||
| rollup.config.js | ||
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:
var xml; // my BPMN 2.0 xml
var viewer = new BpmnJS({
container: 'body'
});
viewer.importXML(xml, function(err) {
if (err) {
console.log('error rendering', err);
} else {
console.log('rendered');
}
});
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.
Related
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.