Vizel API / core/src / VizelEditorSubscriptionOptions

Interface: VizelEditorSubscriptionOptions

Defined in: packages/core/src/controllers/editorSubscription.ts:14

Options for createVizelEditorSubscription.

Properties

event

event: VizelEditorEventName;

Defined in: packages/core/src/controllers/editorSubscription.ts:18

Event to attach the listener to.

---

fireImmediately?

optional fireImmediately?: boolean;

Defined in: packages/core/src/controllers/editorSubscription.ts:26

If true, the handler is invoked once synchronously after the subscription attaches (when the editor is available). Useful for "initial load + update" patterns. Default: false.

---

getEditor

getEditor: () => Editor | null | undefined;

Defined in: packages/core/src/controllers/editorSubscription.ts:16

Lazy editor accessor. Re-read on every subscription refresh.

Returns

Editor | null | undefined

---

handler

handler: () => void;

Defined in: packages/core/src/controllers/editorSubscription.ts:20

Listener body.

Returns

void