Vizel API / vue/src / UseVizelEditorOptions

Type Alias: UseVizelEditorOptions

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

Defined in: packages/vue/src/composables/useVizelEditor.ts:23

Options for useVizelEditor composable.

editable accepts either a literal boolean or a reactive source (Ref<boolean> or () => boolean) so the composable can mirror the value through editor.setEditable() whenever 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?

optional editable?: MaybeRefOrGetter<boolean>;

Whether the editor accepts user input. Pass a Ref<boolean> or () => boolean to drive it from reactive state; the composable resolves the value with toValue() on every change.

See

VizelCreateEditorOptions for available options.