Skip to main content

Interface: NavigatorProps

Props for Navigator component.

See

Navigator

Properties

PropertyTypeDescription

autoCollapseFraction?

number

Specifies a maximum allowed fraction of occupied canvas width or height by the navigator before it will auto-collapse.

Only applicable if expanded is set to auto.

Default

0.4

backgroundFill?

string

CSS color for the minimap underlying background.

Default is set by --reactodia-navigator-background-fill CSS property.

dock

DockDirection

Dock direction on the canvas viewport.

dockOffsetX?

number

Horizontal offset from the dock direction.

Default

0

dockOffsetY?

number

Vertical offset from the dock direction.

Default

0

expanded?

boolean | "auto"

Whether the navigator should be initially expanded.

If specified as auto the navigator will expand or collapse when the canvas is resized depending on autoCollapseFraction property until manually expanded or collapsed.

Default

"auto"

height?

number

Vertical size of the navigator in px.

Default

160

overflowStroke?

NavigatorStrokeStyle

Stroke style for the viewport area overflow border (displayed when the viewport is cutoff at the minimap border).

Default is set by these CSS properties:

  • color by --reactodia-navigator-overflow-stroke-color
  • width by --reactodia-navigator-overflow-stroke-width
  • dash by --reactodia-navigator-overflow-stroke-dash

scalePadding?

number

Fraction of the diagram content size to add as padding to the minimap.

Default

0.2

scrollablePaneFill?

string

CSS color for the scrollable pane background.

Default is set by --reactodia-navigator-scrollable-pane-fill CSS property.

viewportFill?

string

CSS color for the viewport area background.

Default is set by --reactodia-navigator-viewport-fill CSS property.

viewportStroke?

NavigatorStrokeStyle

Stroke style for the viewport area border.

Default is set by these CSS properties:

  • color by --reactodia-navigator-viewport-stroke-color
  • width by --reactodia-navigator-viewport-stroke-width
  • dash by --reactodia-navigator-viewport-stroke-dash

width?

number

Horizontal size of the navigator in px.

Default

300