Vizel API / core/src / VizelMarkdownSyncHandlers

Interface: VizelMarkdownSyncHandlers

Defined in: packages/core/src/utils/markdown.ts:143

Create debounced markdown sync handlers. This is a framework-agnostic helper that frameworks can use to implement their own hooks.

Param

options

Sync options

Example

const sync = createVizelMarkdownSyncHandlers({
  debounceMs: 300,
  transformDiagrams: true,
});

// In onUpdate callback:
sync.handleUpdate(editor);

// Get current markdown:
console.log(sync.getMarkdown());

// Set markdown:
sync.setMarkdown(editor, "# New content");

// Cleanup:
sync.destroy();

Properties

destroy

destroy: () => void;

Defined in: packages/core/src/utils/markdown.ts:155

Cleanup (cancel pending timers)

Returns

void

---

flush

flush: (editor) => void;

Defined in: packages/core/src/utils/markdown.ts:153

Force immediate export (flush pending)

Parameters

Parameter	Type
editor	Editor

Returns

void

---

getMarkdown

getMarkdown: () => string;

Defined in: packages/core/src/utils/markdown.ts:147

Get current markdown content

Returns

string

---

handleUpdate

handleUpdate: (editor) => void;

Defined in: packages/core/src/utils/markdown.ts:145

Handle editor update (call in onUpdate callback)

Parameters

Parameter	Type
editor	Editor

Returns

void

---

isPending

isPending: () => boolean;

Defined in: packages/core/src/utils/markdown.ts:151

Check if export is pending

Returns

boolean

---

setMarkdown

setMarkdown: (editor, markdown) => void;

Defined in: packages/core/src/utils/markdown.ts:149

Set markdown content to editor

Parameters

Parameter	Type
editor	Editor
markdown	string

Returns

void