Skip to content

Vizel API / react/src / VizelBubbleMenuProps

Interface: VizelBubbleMenuProps ​

Defined in: packages/react/src/components/VizelBubbleMenu.tsx:13

Properties ​

children? ​

ts
optional children?: ReactNode;

Defined in: packages/react/src/components/VizelBubbleMenu.tsx:19

Custom menu items (overrides default menu)


className? ​

ts
optional className?: string;

Defined in: packages/react/src/components/VizelBubbleMenu.tsx:17

Custom class name for the menu container


editor? ​

ts
optional editor?: Editor | null;

Defined in: packages/react/src/components/VizelBubbleMenu.tsx:15

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


enableEmbed? ​

ts
optional enableEmbed?: boolean;

Defined in: packages/react/src/components/VizelBubbleMenu.tsx:29

Enable embed option in link editor (requires Embed extension)


locale? ​

ts
optional locale?: VizelLocale;

Defined in: packages/react/src/components/VizelBubbleMenu.tsx:31

Locale for translated UI strings


pluginKey? ​

ts
optional pluginKey?: string;

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

Plugin key for the bubble menu


shouldShow? ​

ts
optional shouldShow?: (props) => boolean;

Defined in: packages/react/src/components/VizelBubbleMenu.tsx:27

Custom shouldShow function

Parameters ​

ParameterType
props{ editor: Editor; from: number; to: number; }
props.editorEditor
props.fromnumber
props.tonumber

Returns ​

boolean


showDefaultMenu? ​

ts
optional showDefaultMenu?: boolean;

Defined in: packages/react/src/components/VizelBubbleMenu.tsx:21

Whether to show the default formatting menu


updateDelay? ​

ts
optional updateDelay?: number;

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

Delay in ms before updating the menu position

Released under the MIT License.