Vizel API / vue/src / UseVizelMarkdownResult

Interface: UseVizelMarkdownResult

Defined in: packages/vue/src/composables/useVizelMarkdown.ts:20

Properties

flush

flush: () => void;

Defined in: packages/vue/src/composables/useVizelMarkdown.ts:42

Force immediate export (flush pending debounced export).

Returns

void

---

isPending

isPending: ComputedRef<boolean>;

Defined in: packages/vue/src/composables/useVizelMarkdown.ts:38

Whether markdown export is currently pending (debounced).

---

markdown

markdown: Readonly<ShallowRef<string>>;

Defined in: packages/vue/src/composables/useVizelMarkdown.ts:29

Current markdown content (reactive, read-only).

Updates with debounce when editor content changes. Use setMarkdown to write — the ref is intentionally read-only so accidental writes via markdown.value = "..." cannot desynchronize the editor and the cached markdown.

---

setMarkdown

setMarkdown: (markdown) => void;

Defined in: packages/vue/src/composables/useVizelMarkdown.ts:34

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

Parameters

Parameter	Type
markdown	string

Returns

void