README.md

bpmn-js Minimap Example

This example uses bpmn-js and diagram-js-minimap. It implements a BPMN 2.0 modeler with a minimap that lets you navigate the diagram.

Usage

Add diagram-js-minimap to your project:

npm install --save diagram-js-minimap

Now load the minimap module along with the bpmn-js instance:

import BpmnModeler from 'bpmn-js/lib/Modeler';

import minimapModule from 'diagram-js-minimap';

var bpmnModeler = new BpmnModeler({
  container: '#canvas',
  additionalModules: [
    minimapModule
  ]
});

bpmnModeler.importXML(xml, function(err) {

  if (err) {
    console.error(err);
  } else {
    console.log('Awesome! Ready to navigate!');
  }
});

Checkout app/app.js for details.

Run the Example

You need a NodeJS development stack with npm installed to build the project.

To install all project dependencies execute

npm install

To start the example execute

npm start

To build the example into the public folder execute

npm run all