NavigatorProps
Props for the Navigator component.
Extends
NavigatorSupportedOptions<ElementData,LinkData>.HTMLAttributes<HTMLDivElement>
Type Parameters
| Type Parameter | Default type |
|---|---|
ElementData | unknown |
LinkData | unknown |
Properties
dynamicZoom?
readonly optional dynamicZoom?: boolean;
Keeps the minimap fitted to the content as the main paper grows or shrinks.
Default
true
elementStyle?
readonly optional elementStyle?: NavigatorElementStyleCallback<ElementData>;
Customizes how each element looks in the minimap. Called with the
element's size, model, and resolved record, and returns a style map
applied to its rendered node. See NavigatorElementStyleCallback.
linkStyle?
readonly optional linkStyle?: NavigatorLinkStyleCallback<LinkData>;
Customizes how each link looks in the minimap. Called with the link's
model and resolved record, and returns a style map applied to its
rendered <path>. See NavigatorLinkStyleCallback.
options?
readonly optional options?: Partial<Options>;
Escape hatch to the raw NavigatorOptions for anything without a
dedicated prop, including paperOptions (the minimap's dia.Paper
config: elementView, cellVisibility, …), zoomOptions, and mvc
internals (theme, events, attributes, tagName, …).
Avoid overriding options that joint-react-plus controls itself
(paperScroller, paperConstructor).
padding?
readonly optional padding?: number;
Inner padding, in px, between the minimap content and its edges. The
minimap's outer size comes from the host element — set it with style
or className.
Default
10
paper?
readonly optional paper?: PaperTarget;
The paper to mirror: a paper id, dia.Paper instance, or paper ref.
Defaults to the nearest <PaperScroller> context when omitted.
showLinks?
readonly optional showLinks?: boolean;
Whether links are drawn in the minimap. Set false to show only elements.
For finer control, pass your own options.paperOptions.cellVisibility.
Default
true
useContentBBox?
readonly optional useContentBBox?: boolean;
Fits the minimap to the content's bounding box (computed from model geometry, so CSS-driven sizes are ignored) instead of the full paper area.
Default
true
zoom?
readonly optional zoom?: boolean;
Enables drag-to-zoom on the minimap. The zoom bounds always come from the
owning <PaperScroller> (its minZoom / maxZoom props); the Navigator
does not override them.
Default
false