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,178 Commits 41 Branches 267 Tags 12 MiB
JavaScript 99.6%
Shell 0.2%
CSS 0.2%
Go to file
Nico Rehwaldt d3449ca87c chore(project): es6ify source code 
* use ES6 import / export
* UTILS: export individual utilities
* TESTS: localize TestHelper includes

BREAKING CHANGE:

* all utilities export independent functions
* library sources got ported to ES6. You must now use
  a ES module bundler such as Browserify + babelify or
  Webpack to consume this library (or parts of it).
 		2018-04-03 16:32:14 +02:00
.github docs(project): add pull request template 2017-09-26 14:34:02 +02:00
docs docs(SETUP): remove grunt 2017-10-04 09:27:54 +02:00
lib chore(project): es6ify source code 2018-04-03 16:32:14 +02:00
resources chore(project): scale down screencast 2018-02-06 12:06:41 +01:00
tasks chore(project): build using ES6 ready deps 2018-04-03 16:30:05 +02:00
test chore(project): es6ify source code 2018-04-03 16:32:14 +02:00
.babelrc chore(project): build using ES6 ready deps 2018-04-03 16:30:05 +02:00
.eslintignore chore(project): drop grunt + bundle assets to dist directory 2018-02-02 11:24:00 +01:00
.eslintrc chore(project): use shared linter config 2018-02-14 16:42:52 +01:00
.gitignore chore(project): opt-out of package-lock 2018-04-02 11:20:44 +02:00
.npmignore chore(project): make .npmignore more stable 2018-02-14 17:00:01 +01:00
.npmrc chore(project): opt-out of package-lock 2018-04-02 11:20:44 +02:00
.travis.yml chore(ci): simplify stages 2018-02-26 09:29:32 +01:00
.wiredeps chore(wiredeps): rebuild 2018-03-22 12:02:48 +01:00
CHANGELOG.md chore(project): bump dependency versions 2018-04-03 10:38:43 +02:00
CONTRIBUTING.md docs(CONTRIBUTING): link setup guide 2017-10-04 09:30:31 +02:00
LICENSE chore(project): update year in LICENSE 2017-10-07 09:19:32 +02:00
README.md docs(README): fix BPMN 2.0 standard link 2018-02-14 22:42:19 +01:00
index.js chore(project): es6ify source code 2018-04-03 16:32:14 +02:00
package.json chore(project): build using ES6 ready deps 2018-04-03 16:30:05 +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

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.