Skip to content

Vizel API / react/src / VizelEditor

Function: VizelEditor()

ts
function VizelEditor(__namedParameters): ReactNode;

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

Renders the editable content area of the Vizel editor.

Can be used within an VizelProvider (no editor prop needed), or standalone with editor prop.

Parameters

ParameterType
__namedParametersVizelEditorProps

Returns

ReactNode

Example

tsx
// With VizelProvider
<VizelProvider editor={editor}>
  <VizelEditor className="prose" />
</VizelProvider>

// Or directly with editor prop
<VizelEditor editor={editor} className="prose" />

// With a ref to read the container DOM element
const containerRef = useRef<HTMLDivElement>(null);
<VizelEditor ref={containerRef} editor={editor} />

Released under the MIT License.