Skip to main content

@lexical/react/LexicalNodeMenuPlugin

Classes​

Defined in: packages/lexical-react/src/shared/LexicalMenu.tsx:52

Extended by​

Constructors​

Constructor​

new MenuOption(key): MenuOption

Defined in: packages/lexical-react/src/shared/LexicalMenu.tsx:58

Parameters​
key​

string

Returns​

MenuOption

Properties​

icon?​

optional icon: Element

Defined in: packages/lexical-react/src/shared/LexicalMenu.tsx:55

key​

key: string

Defined in: packages/lexical-react/src/shared/LexicalMenu.tsx:53

ref?​

optional ref: RefObject<null | HTMLElement>

Defined in: packages/lexical-react/src/shared/LexicalMenu.tsx:54

title?​

optional title: string | Element

Defined in: packages/lexical-react/src/shared/LexicalMenu.tsx:56

Methods​

setRefElement()​

setRefElement(element): void

Defined in: packages/lexical-react/src/shared/LexicalMenu.tsx:64

Parameters​
element​

null | HTMLElement

Returns​

void

Type Aliases​

MenuRenderFn<TOption> = (anchorElementRef, itemProps, matchingString) => ReactPortal | JSX.Element | null

Defined in: packages/lexical-react/src/shared/LexicalMenu.tsx:69

Type Parameters​

TOption​

TOption extends MenuOption

Parameters​

anchorElementRef​

RefObject<HTMLElement | null>

itemProps​
options​

TOption[]

selectedIndex​

number | null

selectOptionAndCleanUp​

(option) => void

setHighlightedIndex​

(index) => void

matchingString​

string

Returns​

ReactPortal | JSX.Element | null

MenuResolution = object

Defined in: packages/lexical-react/src/shared/LexicalMenu.tsx:47

Properties​

getRect()​

getRect: () => DOMRect

Defined in: packages/lexical-react/src/shared/LexicalMenu.tsx:49

Returns​

DOMRect

match?​

optional match: MenuTextMatch

Defined in: packages/lexical-react/src/shared/LexicalMenu.tsx:48

NodeMenuPluginProps​

NodeMenuPluginProps<TOption> = object

Defined in: packages/lexical-react/src/LexicalNodeMenuPlugin.tsx:26

Type Parameters​

TOption​

TOption extends MenuOption

Properties​

anchorClassName?​

optional anchorClassName: string

Defined in: packages/lexical-react/src/LexicalNodeMenuPlugin.tsx:38

commandPriority?​

optional commandPriority: CommandListenerPriority

Defined in: packages/lexical-react/src/LexicalNodeMenuPlugin.tsx:39

optional menuRenderFn: MenuRenderFn<TOption>

Defined in: packages/lexical-react/src/LexicalNodeMenuPlugin.tsx:35

nodeKey​

nodeKey: NodeKey | null

Defined in: packages/lexical-react/src/LexicalNodeMenuPlugin.tsx:34

onClose()?​

optional onClose: () => void

Defined in: packages/lexical-react/src/LexicalNodeMenuPlugin.tsx:36

Returns​

void

onOpen()?​

optional onOpen: (resolution) => void

Defined in: packages/lexical-react/src/LexicalNodeMenuPlugin.tsx:37

Parameters​
resolution​

MenuResolution

Returns​

void

onSelectOption()​

onSelectOption: (option, textNodeContainingQuery, closeMenu, matchingString) => void

Defined in: packages/lexical-react/src/LexicalNodeMenuPlugin.tsx:27

Parameters​
option​

TOption

textNodeContainingQuery​

TextNode | null

closeMenu​

() => void

matchingString​

string

Returns​

void

options​

options: TOption[]

Defined in: packages/lexical-react/src/LexicalNodeMenuPlugin.tsx:33

parent?​

optional parent: HTMLElement

Defined in: packages/lexical-react/src/LexicalNodeMenuPlugin.tsx:40

Functions​

LexicalNodeMenuPlugin()​

LexicalNodeMenuPlugin<TOption>(__namedParameters): null | Element

Defined in: packages/lexical-react/src/LexicalNodeMenuPlugin.tsx:43

Type Parameters​

TOption​

TOption extends MenuOption

Parameters​

__namedParameters​

NodeMenuPluginProps<TOption>

Returns​

null | Element