@mermaid-editor-sdk/ui


@mermaid-editor-sdk/ui / DiagramPaletteProps

Interface: DiagramPaletteProps

Defined in: package/ui/src/ui/components/DiagramPalette.tsx:13

Properties

dispatch

readonly dispatch: (action) => string | undefined

Defined in: package/ui/src/ui/components/DiagramPalette.tsx:17

Applies a palette action and returns the new source when changed.

Parameters

ParameterType
actionDiagramAction

Returns

string | undefined


flowchartEdgeOptions?

readonly optional flowchartEdgeOptions?: object

Defined in: package/ui/src/ui/components/DiagramPalette.tsx:23

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/DiagramPalette.tsx:15

Current diagram model.


onArmConnection

readonly onArmConnection: (options) => void

Defined in: package/ui/src/ui/components/DiagramPalette.tsx:21

Starts or cancels relationship creation.

Parameters

ParameterType
optionsEdgeConnectionOptions | null

Returns

void


onFlowchartEdgeOptionsChange?

readonly optional onFlowchartEdgeOptionsChange?: (options) => void

Defined in: package/ui/src/ui/components/DiagramPalette.tsx:25

Updates the flowchart edge operator and label.

Parameters

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

Returns

void


pendingConnection?

readonly optional pendingConnection?: object

Defined in: package/ui/src/ui/components/DiagramPalette.tsx:19

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

diagramType

readonly diagramType: EditableDiagramType

source?

readonly optional source?: string