Skip to content

bpmn-io/diagram-js-minimap

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

diagram-js Minimap

Build Status

A minimap for diagram-js.

Minimap

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

About

A minimap for diagram-js

Topics

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks