Skip to content

Vizel API / react/src / VizelMentionMenuProps

Interface: VizelMentionMenuProps

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

Properties

className?

ts
optional className?: string;

Defined in: packages/react/src/components/VizelMentionMenu.tsx:24

Custom class name for the menu container


items

ts
items: VizelMentionItem[];

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

Mention items to display


locale?

ts
optional locale?: VizelLocale;

Defined in: packages/react/src/components/VizelMentionMenu.tsx:26

Locale for translated UI strings


onSelect

ts
onSelect: (item) => void;

Defined in: packages/react/src/components/VizelMentionMenu.tsx:22

Callback when an item is selected

Parameters

ParameterType
itemVizelMentionItem

Returns

void


ref?

ts
optional ref?: Ref<VizelMentionMenuRef>;

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

Ref to access menu methods


renderEmpty?

ts
optional renderEmpty?: () => ReactNode;

Defined in: packages/react/src/components/VizelMentionMenu.tsx:38

Custom empty state component. Mirrors VizelSlashMenu.renderEmpty.

Returns

ReactNode


renderItem?

ts
optional renderItem?: (props) => ReactNode;

Defined in: packages/react/src/components/VizelMentionMenu.tsx:32

Custom render function for items. Receives the item, the selection state, and a click handler that selects the item. Mirrors the renderItem seam on VizelSlashMenu.

Parameters

ParameterType
props{ isSelected: boolean; item: VizelMentionItem; onClick: () => void; }
props.isSelectedboolean
props.itemVizelMentionItem
props.onClick() => void

Returns

ReactNode

Released under the MIT License.