@mermaid-editor-sdk/ui

@mermaid-editor-sdk/ui / MermaidCanvasProps

Interface: MermaidCanvasProps

Defined in: package/ui/src/ui/components/MermaidCanvas.tsx:16

Properties

autoFit?

readonly optional autoFit?: boolean

Defined in: package/ui/src/ui/components/MermaidCanvas.tsx:44

Fits after rendering and resizing; the resulting zoom is clamped to 0.1–4.

Default

false

flowchartEdgeOptions?

readonly optional flowchartEdgeOptions?: object

Defined in: package/ui/src/ui/components/MermaidCanvas.tsx:50

Flowchart relationship operator and label used for the next edge.

label

readonly label: string

operator

readonly operator: string

Default

{ operator: '-->', label: '' }

isSaving?

readonly optional isSaving?: boolean

Defined in: package/ui/src/ui/components/MermaidCanvas.tsx:36

Disables Save and displays its pending state.

Default

false

model

readonly model: RendererModel

Defined in: package/ui/src/ui/components/MermaidCanvas.tsx:20

Parsed diagram model used for interactions.

onEditSelection

readonly onEditSelection: () => void

Defined in: package/ui/src/ui/components/MermaidCanvas.tsx:40

Opens the selection editor.

Returns

void

onParseResult

readonly onParseResult: (sourceRevision, valid) => void

Defined in: package/ui/src/ui/components/MermaidCanvas.tsx:30

Reports whether a source revision parsed successfully.

Parameters

Returns

void

onRenderState

readonly onRenderState: (state, message, cause?) => void

Defined in: package/ui/src/ui/components/MermaidCanvas.tsx:24

Reports render state, message, and optional underlying cause.

Parameters

Returns

void

onReset

readonly onReset: () => void

Defined in: package/ui/src/ui/components/MermaidCanvas.tsx:38

Handles the canvas Reset action.

Returns

void

onSave?

readonly optional onSave?: () => void

Defined in: package/ui/src/ui/components/MermaidCanvas.tsx:32

Handles the canvas Save action.

Returns

void

onSelection

readonly onSelection: (selection) => void

Defined in: package/ui/src/ui/components/MermaidCanvas.tsx:22

Reports the selected node, edge, or subgraph, or null when selection clears.

Parameters

Returns

void

onSourceMutation

readonly onSourceMutation: (mutate, remove?) => boolean

Defined in: package/ui/src/ui/components/MermaidCanvas.tsx:26

Applies a source-preserving mutation; remove marks a removal operation.

Parameters

Returns

boolean

pendingConnection?

readonly optional pendingConnection?: object

Defined in: package/ui/src/ui/components/MermaidCanvas.tsx:46

Active relationship creation, with an optional selected source node.

diagramType

readonly diagramType: EditableDiagramType

source?

readonly optional source?: string

source

readonly source: string

Defined in: package/ui/src/ui/components/MermaidCanvas.tsx:18

Mermaid source to render.

sourceRevision

readonly sourceRevision: number

Defined in: package/ui/src/ui/components/MermaidCanvas.tsx:28

Revision associated with source.