Mermaid Editor SDK

@mermaid-editor-sdk/ui

@mermaid-editor-sdk/ui / DiagramSessionBindings

Interface: DiagramSessionBindings

Defined in: package/ui/src/ui/hooks/useDiagramSession.ts:7

Observable session values and editing actions returned by useDiagramSession.

Properties

dispatch

readonly dispatch: (action) => string | undefined

Defined in: package/ui/src/ui/hooks/useDiagramSession.ts:11

Applies a diagram action and returns the resulting source when changed.

Parameters

ParameterType
actionDiagramAction

Returns

string | undefined

redo

readonly redo: () => string | undefined

Defined in: package/ui/src/ui/hooks/useDiagramSession.ts:15

Reapplies the next source change.

Returns

string | undefined

setSource

readonly setSource: (source, origin?) => boolean

Defined in: package/ui/src/ui/hooks/useDiagramSession.ts:17

Replaces source and optionally records its change origin. Defaults to 'source-editor'.

Parameters

ParameterType
sourcestring
origin?ChangeOrigin

Returns

boolean

snapshot

readonly snapshot: SessionSnapshot

Defined in: package/ui/src/ui/hooks/useDiagramSession.ts:9

Current session state.

undo

readonly undo: () => string | undefined

Defined in: package/ui/src/ui/hooks/useDiagramSession.ts:13

Reverts the last source change.

Returns

string | undefined