Skip to content

Vizel API / vue/src / UseVizelMarkdownOptions

Interface: UseVizelMarkdownOptions ​

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

Options for Markdown synchronization

Extends ​

Properties ​

debounceMs? ​

ts
optional debounceMs?: number;

Defined in: packages/core/src/types.ts:336

Debounce delay in milliseconds for markdown export. Set to 0 for immediate export (not recommended for large documents).

Default ​

ts
300

Inherited from ​

VizelMarkdownSyncOptions.debounceMs


initialValue? ​

ts
optional initialValue?: string;

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

Initial markdown value. If provided, this will be set to the editor on mount.


transformDiagrams? ​

ts
optional transformDiagrams?: boolean;

Defined in: packages/core/src/types.ts:341

Automatically transform diagram code blocks when setting markdown content.

Default ​

ts
true

Inherited from ​

VizelMarkdownSyncOptions.transformDiagrams

Released under the MIT License.