@lexical/react/LexicalContextMenuPlugin

Classes

MenuOption

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

Extended by

• AutoEmbedOption

Constructors

Constructor

new MenuOption(key): MenuOption

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

Parameters

key

string

Returns

MenuOption

Properties

key

key: string

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

ref?

optional ref: RefObject<null | HTMLElement>

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

Methods

setRefElement()

setRefElement(element): void

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

Parameters

element

null | HTMLElement

Returns

void

Type Aliases

ContextMenuRenderFn()<TOption>

ContextMenuRenderFn<TOption> = (anchorElementRef, itemProps, menuProps) => ReactPortal | JSX.Element | null

Defined in: packages/lexical-react/src/LexicalContextMenuPlugin.tsx:24

Type Parameters

TOption

TOption extends MenuOption

Parameters

anchorElementRef

RefObject<HTMLElement | null>

itemProps

options

TOption[]

selectedIndex

number | null

selectOptionAndCleanUp

(option) => void

setHighlightedIndex

(index) => void

menuProps

setMenuRef

(element) => void

Returns

ReactPortal | JSX.Element | null

---

LexicalContextMenuPluginProps<TOption>

LexicalContextMenuPluginProps<TOption> = object

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

Type Parameters

TOption

TOption extends MenuOption

Properties

anchorClassName?

optional anchorClassName: string

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

commandPriority?

optional commandPriority: CommandListenerPriority

Defined in: packages/lexical-react/src/LexicalContextMenuPlugin.tsx:50

menuRenderFn

menuRenderFn: ContextMenuRenderFn<TOption>

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

onClose()?

optional onClose: () => void

Defined in: packages/lexical-react/src/LexicalContextMenuPlugin.tsx:45

Returns

void

onOpen()?

optional onOpen: (resolution) => void

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

Parameters

resolution

MenuResolution

Returns

void

onSelectOption()

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

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

Parameters

option

TOption

textNodeContainingQuery

LexicalNode | null

closeMenu

() => void

matchingString

string

Returns

void

onWillOpen()?

optional onWillOpen: (event) => void

Defined in: packages/lexical-react/src/LexicalContextMenuPlugin.tsx:46

Parameters

event

MouseEvent

Returns

void

options

options: TOption[]

Defined in: packages/lexical-react/src/LexicalContextMenuPlugin.tsx:44

parent?

optional parent: HTMLElement

Defined in: packages/lexical-react/src/LexicalContextMenuPlugin.tsx:51

---

MenuRenderFn()<TOption>

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

Defined in: packages/lexical-react/src/shared/LexicalMenu.ts: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 | null

Returns

ReactPortal | JSX.Element | null

---

MenuResolution

MenuResolution = object

Defined in: packages/lexical-react/src/shared/LexicalMenu.ts:46

Properties

getRect()

getRect: () => DOMRect

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

Returns

DOMRect

match?

optional match: MenuTextMatch

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

Functions

LexicalContextMenuPlugin()

LexicalContextMenuPlugin<TOption>(__namedParameters): null | Element

Defined in: packages/lexical-react/src/LexicalContextMenuPlugin.tsx:59

Type Parameters

TOption

TOption extends MenuOption

Parameters

__namedParameters

LexicalContextMenuPluginProps<TOption>

Returns

null | Element

Deprecated

Use LexicalNodeContextMenuPlugin instead.