Skip to content

Vizel API / svelte/src / CreateVizelEditorOptions

Type Alias: CreateVizelEditorOptions

ts
type CreateVizelEditorOptions = Omit<VizelCreateEditorOptions, "editable"> & object;

Defined in: packages/svelte/src/runes/createVizelEditor.svelte.ts:21

Options for createVizelEditor rune.

editable accepts either a literal boolean or a getter () => boolean so the rune can mirror the value through editor.setEditable() when it changes. Other options are captured once at mount and ignored thereafter — Tiptap does not support runtime swapping of initialContent, extensions, etc.

Type Declaration

editable?

ts
optional editable?: boolean | (() => boolean);

Whether the editor accepts user input. Pass () => boolean to drive it from a $state rune; the effect resolves the getter on every change.

See

VizelCreateEditorOptions for available options.

Released under the MIT License.