Skip to content
On this page

MiniMap

Usage

To use the minimap simply pass the MiniMap component as a child to the VueFlow component.

<template>
  <VueFlow>
    <MiniMap />
  </VueFlow>
</template>

Interactive MiniMap

The minimap can be made interactive by using the pannable and zoomable props.

<template>
  <VueFlow>
    <MiniMap pannable zoomable />
  </VueFlow>
</template>

When enabled, these props allow you to pan on drag and zoom on scroll using the MiniMap.

Props

NameDefinitionTypeOptionalDefault
nodeColorNode(s) Background colorstring, MiniMapNodeFunctrue#fff
nodeStrokeColorBorder colorstring, MiniMapNodeFunctrue#555
nodeClassNameExtra classesstring, MiniMapNodeFunctrue-
nodeBorderRadiusBorder radiusnumbertrue5
nodeStrokeWidthStroke widthnumbertrue2
maskColorMinimap Background colorstringtruergb(240, 242, 243, 0.7)
pannableUse Minimap to pan on dragbooleantruefalse
zoomableUse Minimap to zoom on wheelbooleantruefalse

Slots

NameDefinitionPropsDefault
node-${node.type}MiniMap Node slotMiniMapNodePropsMiniMapNode

Released under the MIT License.