sartography
/
bpmn-js
mirror of https://github.com/sartography/bpmn-js.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
A BPMN 2.0 rendering toolkit and web modeler. https://bpmn.io/toolkit/bpmn-js/
1,358 Commits 41 Branches 267 Tags 12 MiB
JavaScript 99.6%
Shell 0.2%
CSS 0.2%
Go to file
Nico Rehwaldt a525c633a2 chore(keyboard): register keys backed by editor actions only 
* only register keyboard bindings that are backed by actual
  editor actions
* rename BpmnKeyBindings -> BpmnKeyboardBindings for parity with
  diagram-js@latest
* sub-class and override _keyboardBindings_ service provided
  by diagram-js
* extend spec to verify default actions
 		2018-10-29 14:52:41 +00:00
.github chore(CONTRIBUTING): link conventional commits 2018-09-27 14:34:48 +02:00
docs chore(CONTRIBUTING): link conventional commits 2018-09-27 14:34:48 +02:00
lib chore(keyboard): register keys backed by editor actions only 2018-10-29 14:52:41 +00:00
resources chore(project): build pre-packaged distros with Rollup 2018-04-03 18:09:52 +02:00
tasks chore(project): build pre-packaged distros with Rollup 2018-04-03 18:09:52 +02:00
test chore(keyboard): register keys backed by editor actions only 2018-10-29 14:52:41 +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): build pre-packaged distros with Rollup 2018-04-03 18:09:52 +02:00
.gitignore chore(project): add test coverage 2018-10-04 07:37:01 +00:00
.npmignore chore(project): move CONTRIBUTING to .github folder 2018-07-25 11:40:04 +02:00
.npmrc chore(project): opt-out of package-lock 2018-04-02 11:20:44 +02:00
.travis.yml chore(ci): run test on node_js@10 2018-10-26 09:39:35 +00:00
CHANGELOG.md chore(CHANGELOG): bump to v2.5.2 2018-09-20 23:10:01 +02:00
LICENSE chore(project): update year in LICENSE 2017-10-07 09:19:32 +02:00
README.md chore(project): move CONTRIBUTING to .github folder 2018-07-25 11:40:04 +02:00
index.js fix(project): correct library default export 2018-04-05 09:47:37 +02:00
package.json chore(project): bump diagram-js version 2018-10-29 14:52:41 +00:00
rollup.config.js chore(project): bump devDependencies 2018-10-26 09:39:35 +00: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'
});

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.