Vizel API / react/src / VizelProps

Interface: VizelProps

Defined in: packages/react/src/components/Vizel.tsx:23

Properties

autofocus?

optional autofocus?: number | boolean | "all" | "start" | "end";

Defined in: packages/react/src/components/Vizel.tsx:46

Auto focus on mount

---

bubbleMenuContent?

optional bubbleMenuContent?: (props) => ReactNode;

Defined in: packages/react/src/components/Vizel.tsx:80

Custom bubble menu content as a render prop. Receives the bound editor instance so the consumer can drive Tiptap commands from custom controls. Mirrors the Vue <slot name="bubble-menu" :editor> and the Svelte bubbleMenu: Snippet<[{ editor }]>.

Parameters

Parameter	Type
props	{ editor: Editor; }
props.editor	Editor

Returns

ReactNode

---

children?

optional children?: ReactNode;

Defined in: packages/react/src/components/Vizel.tsx:82

Additional children to render inside the editor root

---

className?

optional className?: string;

Defined in: packages/react/src/components/Vizel.tsx:60

Custom class name for the editor container

---

editable?

optional editable?: boolean;

Defined in: packages/react/src/components/Vizel.tsx:44

Whether the editor is editable (default: true)

---

enableEmbed?

optional enableEmbed?: boolean;

Defined in: packages/react/src/components/Vizel.tsx:73

Enable embed option in bubble menu link editor (requires Embed extension)

---

extensions?

optional extensions?: Extensions;

Defined in: packages/react/src/components/Vizel.tsx:58

Additional Tiptap extensions

---

features?

optional features?: VizelFeatureOptions;

Defined in: packages/react/src/components/Vizel.tsx:48

Feature configuration

---

flavor?

optional flavor?: VizelMarkdownFlavor;

Defined in: packages/react/src/components/Vizel.tsx:54

Markdown output flavor. Controls how Markdown is serialized when exporting content.

Default

"gfm"

---

initialContent?

optional initialContent?: JSONContent;

Defined in: packages/react/src/components/Vizel.tsx:25

Initial content in JSON format

---

initialMarkdown?

optional initialMarkdown?: string;

Defined in: packages/react/src/components/Vizel.tsx:34

Initial content in Markdown format. If both initialContent and initialMarkdown are provided, initialMarkdown takes precedence.

Example

<Vizel initialMarkdown="# Hello World\n\nThis is **bold** text." />

---

locale?

optional locale?: VizelLocale;

Defined in: packages/react/src/components/Vizel.tsx:56

Locale for translated UI strings

---

markdown?

optional markdown?: string;

Defined in: packages/react/src/components/Vizel.tsx:93

Controlled markdown content. When set, the editor content will be synchronized with this value. Use together with onMarkdownChange for controlled mode.

Example

const [md, setMd] = useState("# Hello");
<Vizel markdown={md} onMarkdownChange={setMd} />

---

onBlur?

optional onBlur?: (props) => void;

Defined in: packages/react/src/components/Vizel.tsx:111

Callback when editor loses focus

Parameters

Parameter	Type
props	{ editor: Editor; }
props.editor	Editor

Returns

void

---

onCreate?

optional onCreate?: (props) => void;

Defined in: packages/react/src/components/Vizel.tsx:103

Callback when editor is created

Parameters

Parameter	Type
props	{ editor: Editor; }
props.editor	Editor

Returns

void

---

onDestroy?

optional onDestroy?: () => void;

Defined in: packages/react/src/components/Vizel.tsx:105

Callback when editor is destroyed

Returns

void

---

onError?

optional onError?: (error) => void;

Defined in: packages/react/src/components/Vizel.tsx:116

Callback when an error occurs during editor operations. Provides structured error information for logging or user feedback.

Parameters

Parameter	Type
error	VizelError

Returns

void

---

onFocus?

optional onFocus?: (props) => void;

Defined in: packages/react/src/components/Vizel.tsx:109

Callback when editor gets focus

Parameters

Parameter	Type
props	{ editor: Editor; }
props.editor	Editor

Returns

void

---

onMarkdownChange?

optional onMarkdownChange?: (markdown) => void;

Defined in: packages/react/src/components/Vizel.tsx:99

Callback when markdown content changes. Called with the current markdown string when the editor content is updated. Use together with markdown for controlled mode.

Parameters

Parameter	Type
markdown	string

Returns

void

---

onSelectionUpdate?

optional onSelectionUpdate?: (props) => void;

Defined in: packages/react/src/components/Vizel.tsx:107

Callback when selection changes

Parameters

Parameter	Type
props	{ editor: Editor; }
props.editor	Editor

Returns

void

---

onUpdate?

optional onUpdate?: (props) => void;

Defined in: packages/react/src/components/Vizel.tsx:101

Callback when content changes

Parameters

Parameter	Type
props	{ editor: Editor; }
props.editor	Editor

Returns

void

---

placeholder?

optional placeholder?: string;

Defined in: packages/react/src/components/Vizel.tsx:42

Placeholder text when editor is empty

---

showBubbleMenu?

optional showBubbleMenu?: boolean;

Defined in: packages/react/src/components/Vizel.tsx:71

Whether to show the bubble menu (default: true)

---

showToolbar?

optional showToolbar?: boolean;

Defined in: packages/react/src/components/Vizel.tsx:62

Whether to show the toolbar (default: false)

---

toolbarContent?

optional toolbarContent?: (props) => ReactNode;

Defined in: packages/react/src/components/Vizel.tsx:69

Custom toolbar content as a render prop. Receives the bound editor instance so the consumer can drive Tiptap commands from custom controls. Mirrors the Vue <slot name="toolbar" :editor> and the Svelte toolbar: Snippet<[{ editor }]>.

Parameters

Parameter	Type
props	{ editor: Editor; }
props.editor	Editor

Returns

ReactNode

---

transformDiagramsOnImport?

optional transformDiagramsOnImport?: boolean;

Defined in: packages/react/src/components/Vizel.tsx:40

Automatically transform diagram code blocks (mermaid, graphviz) to diagram nodes when importing markdown content. Only applies when initialMarkdown is provided.

Default

true