Mermaid Editor SDK

@mermaid-editor-sdk/ui

@mermaid-editor-sdk/ui / ToolSidebarProps

Interface: ToolSidebarProps

Defined in: package/ui/src/ui/components/ToolSidebar.tsx:6

Properties

dispatch

readonly dispatch: (action) => string | undefined

Defined in: package/ui/src/ui/components/ToolSidebar.tsx:10

Applies an editing action and returns the resulting source when changed.

Parameters

ParameterType
actionDiagramAction

Returns

string | undefined

flowchartEdgeOptions?

readonly optional flowchartEdgeOptions?: object

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

Current flowchart edge operator and label.

label

readonly label: string

operator

readonly operator: string

model

readonly model: RendererModel

Defined in: package/ui/src/ui/components/ToolSidebar.tsx:8

Current diagram model.

onArmConnection

readonly onArmConnection: (options) => void

Defined in: package/ui/src/ui/components/ToolSidebar.tsx:14

Starts or cancels relationship creation.

Parameters

ParameterType
optionsEdgeConnectionOptions | null

Returns

void

onFlowchartEdgeOptionsChange?

readonly optional onFlowchartEdgeOptionsChange?: (options) => void

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

Updates the flowchart edge operator and label.

Parameters

ParameterType
options{ label: string; operator: string; }
options.labelstring
options.operatorstring

Returns

void

paletteComponent?

readonly optional paletteComponent?: ComponentType<DiagramPaletteProps>

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

Replaces the palette inside the SDK sidebar.

Default

DiagramPalette

pendingConnection?

readonly optional pendingConnection?: object

Defined in: package/ui/src/ui/components/ToolSidebar.tsx:12

Active relationship creation; source is set after choosing its source node.

diagramType

readonly diagramType: EditableDiagramType

source?

readonly optional source?: string