Skip to content

Vizel API / react/src / VizelEditorProps

Interface: VizelEditorProps

Defined in: packages/react/src/components/VizelEditor.tsx:6

Properties

className?

ts
optional className?: string;

Defined in: packages/react/src/components/VizelEditor.tsx:20

Optional className for the editor container


editor?

ts
optional editor?: Editor | null;

Defined in: packages/react/src/components/VizelEditor.tsx:18

Editor instance. Falls back to the editor from VizelProvider / Vizel context if omitted.


ref?

ts
optional ref?: Ref<HTMLDivElement>;

Defined in: packages/react/src/components/VizelEditor.tsx:16

Forwarded ref to the editable container element.

The ref resolves to the rendered <div>. React 19 treats ref as a regular prop, so the consumer passes a standard Ref<HTMLDivElement> and reads the element directly. To reach the editor instance, call useVizelEditor or useVizelContext rather than routing the editor through this ref.

Released under the MIT License.