Go to file

NWalker4483 fdd6b75c99 Initial Commit		2021-06-03 01:45:51 -04:00
assets	Initial Commit	2021-06-03 01:45:51 -04:00
lib	Initial Commit	2021-06-03 01:45:51 -04:00
resources	Initial Commit	2021-06-03 01:45:51 -04:00
test	Initial Commit	2021-06-03 01:45:51 -04:00
.eslintignore	Initial Commit	2021-06-03 01:45:51 -04:00
.eslintrc	Initial Commit	2021-06-03 01:45:51 -04:00
.gitignore	Initial Commit	2021-06-03 01:45:51 -04:00
.npmignore	Initial Commit	2021-06-03 01:45:51 -04:00
.travis.yml	Initial Commit	2021-06-03 01:45:51 -04:00
CHANGELOG.md	Initial Commit	2021-06-03 01:45:51 -04:00
LICENSE	Initial Commit	2021-06-03 01:45:51 -04:00
README.md	Initial Commit	2021-06-03 01:45:51 -04:00
karma.conf.js	Initial Commit	2021-06-03 01:45:51 -04:00
package-lock.json	Initial Commit	2021-06-03 01:45:51 -04:00
package.json	Initial Commit	2021-06-03 01:45:51 -04:00
rollup.config.js	Initial Commit	2021-06-03 01:45:51 -04:00

README.md

diagram-js Minimap

A minimap for diagram-js.

Features

See the whole diagram in the minimap
Highlight current viewport
Click/drag/scroll the minimap to navigate the diagram

Usage

Extend your diagram-js application with the minimap module. We'll use bpmn-js as an example:

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

import minimapModule from 'diagram-js-minimap';

var bpmnModeler = new BpmnModeler({
  additionalModules: [
    minimapModule
  ]
});

For proper styling integrate the embedded style sheet:

<link rel="stylesheet" href="diagram-js-minimap/assets/diagram-js-minimap.css" />

Please see this example for a more detailed instruction.

License

MIT