Skip to content

Vizel API / react/src / UseVizelMarkdownResult

Interface: UseVizelMarkdownResult

Defined in: packages/react/src/hooks/useVizelMarkdown.ts:19

Properties

flush

ts
flush: () => void;

Defined in: packages/react/src/hooks/useVizelMarkdown.ts:37

Force immediate export (flush pending debounced export).

Returns

void


isPending

ts
isPending: boolean;

Defined in: packages/react/src/hooks/useVizelMarkdown.ts:33

Whether markdown export is currently pending (debounced).


markdown

ts
markdown: string;

Defined in: packages/react/src/hooks/useVizelMarkdown.ts:24

Current markdown content (reactive). Updates with debounce when editor content changes.


setMarkdown

ts
setMarkdown: (markdown) => void;

Defined in: packages/react/src/hooks/useVizelMarkdown.ts:29

Set markdown content to the editor. Automatically transforms diagram code blocks if transformDiagrams is enabled.

Parameters

ParameterType
markdownstring

Returns

void

Released under the MIT License.