A BPMN 2.0 rendering toolkit and web modeler. https://bpmn.io/toolkit/bpmn-js/
Go to file
Nico Rehwaldt c87167c8c6 test: do not double add test-container class
This prevents the .test-container selector to appear twice in our test
markup:

```html
<div class="test-container passed" id="camunda-properties simple should
open stuff">
  <div class="title-row">
    <a href="#camunda-properties%20simple%20should%20open%20stuff">
<h3 class="test-titel">camunda-properties simple should open
stuff</h3>
    </a>
    <div class="test-result" style="float: right;">passed</div>
  </div>
  <div class="test-content-container test-container">
    <!-- test content -->
  </div>
</div>
```

With this commit we only add the .test-content-container marker in cases
where `mocha-test-container-support` is not present upon running
`bootstrapBpmnJS`.
2021-01-15 09:28:03 +00:00
.github docs(CONTRIBUTING): correct + grammar ⬆️ 2020-12-21 22:43:43 +01:00
docs docs: move single run to CONTRIBUTING guide 2020-12-21 22:43:43 +01:00
lib fix(palette): activate globalConnect tool instead of toggling 2021-01-07 13:58:54 +00:00
resources chore(logo): update local file 2020-05-26 14:42:45 +02:00
tasks chore(release): simplify auto-generated commits 2020-12-18 00:27:33 +01:00
test test: do not double add test-container class 2021-01-15 09:28:03 +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
.npmignore chore(project): remove coverage directory from the package 2019-08-22 13:55:30 +02:00
.travis.yml chore: add ChromeHeadless to CI 2021-01-06 12:57:36 +00:00
CHANGELOG.md chore(CHANGELOG): update to v8.0.1 2021-01-08 16:10:57 +01:00
LICENSE chore(project): update license 2020-05-20 16:09:03 +00:00
README.md docs(README): rewrite building section 2020-12-21 22:43:43 +01:00
index.js fix(project): correct library default export 2018-04-05 09:47:37 +02:00
package-lock.json 8.0.1 2021-01-08 16:15:17 +01:00
package.json 8.0.1 2021-01-08 16:15:17 +01:00
rollup.config.js deps: bump development dependencies 2020-12-02 20:28:33 +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:

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.

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.