@lexical/react/LexicalTypeaheadMenuPlugin

Type Aliases

MenuTextMatch

MenuTextMatch = object

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

Properties

leadOffset

leadOffset: number

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

matchingString

matchingString: string

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

replaceableString

replaceableString: string

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

---

TriggerFn()

TriggerFn = (text, editor) => MenuTextMatch | null

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

Parameters

text

string

editor

LexicalEditor

Returns

MenuTextMatch | null

---

TypeaheadMenuPluginProps

TypeaheadMenuPluginProps<TOption> = object

Defined in: packages/lexical-react/src/LexicalTypeaheadMenuPlugin.tsx:196

Type Parameters

TOption

TOption extends MenuOption

Properties

anchorClassName?

optional anchorClassName: string

Defined in: packages/lexical-react/src/LexicalTypeaheadMenuPlugin.tsx:209

commandPriority?

optional commandPriority: CommandListenerPriority

Defined in: packages/lexical-react/src/LexicalTypeaheadMenuPlugin.tsx:210

ignoreEntityBoundary?

optional ignoreEntityBoundary: boolean

Defined in: packages/lexical-react/src/LexicalTypeaheadMenuPlugin.tsx:213

menuRenderFn

menuRenderFn: MenuRenderFn<TOption>

Defined in: packages/lexical-react/src/LexicalTypeaheadMenuPlugin.tsx:205

onClose()?

optional onClose: () => void

Defined in: packages/lexical-react/src/LexicalTypeaheadMenuPlugin.tsx:208

Returns

void

onOpen()?

optional onOpen: (resolution) => void

Defined in: packages/lexical-react/src/LexicalTypeaheadMenuPlugin.tsx:207

Parameters

resolution

MenuResolution

Returns

void

onQueryChange()

onQueryChange: (matchingString) => void

Defined in: packages/lexical-react/src/LexicalTypeaheadMenuPlugin.tsx:197

Parameters

matchingString

string | null

Returns

void

onSelectOption()

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

Defined in: packages/lexical-react/src/LexicalTypeaheadMenuPlugin.tsx:198

Parameters

option

TOption

textNodeContainingQuery

TextNode | null

closeMenu

() => void

matchingString

string

Returns

void

options

options: TOption[]

Defined in: packages/lexical-react/src/LexicalTypeaheadMenuPlugin.tsx:204

parent?

optional parent: HTMLElement

Defined in: packages/lexical-react/src/LexicalTypeaheadMenuPlugin.tsx:211

preselectFirstItem?

optional preselectFirstItem: boolean

Defined in: packages/lexical-react/src/LexicalTypeaheadMenuPlugin.tsx:212

triggerFn

triggerFn: TriggerFn

Defined in: packages/lexical-react/src/LexicalTypeaheadMenuPlugin.tsx:206

Variables

PUNCTUATION

const PUNCTUATION: "\.,\+\*\?\$\@\|#{}\(\)\^\-\[\]\\/!%'"~=<>_:;" = '\\.,\\+\\*\\?\\$\\@\\|#{}\\(\\)\\^\\-\\[\\]\\\\/!%\'"~=<>_:;'

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

---

SCROLL_TYPEAHEAD_OPTION_INTO_VIEW_COMMAND

const SCROLL_TYPEAHEAD_OPTION_INTO_VIEW_COMMAND: LexicalCommand<{ index: number; option: MenuOption; }>

Defined in: packages/lexical-react/src/LexicalTypeaheadMenuPlugin.tsx:143

Functions

getScrollParent()

getScrollParent(element, includeHidden): HTMLElement | HTMLBodyElement

Defined in: packages/lexical-react/src/LexicalTypeaheadMenuPlugin.tsx:111

Parameters

element

HTMLElement

includeHidden

boolean

Returns

HTMLElement | HTMLBodyElement

---

LexicalTypeaheadMenuPlugin()

LexicalTypeaheadMenuPlugin<TOption>(__namedParameters): null | Element

Defined in: packages/lexical-react/src/LexicalTypeaheadMenuPlugin.tsx:216

Type Parameters

TOption

TOption extends MenuOption

Parameters

__namedParameters

TypeaheadMenuPluginProps<TOption>

Returns

null | Element

---

useBasicTypeaheadTriggerMatch()

useBasicTypeaheadTriggerMatch(trigger, __namedParameters): TriggerFn

Defined in: packages/lexical-react/src/LexicalTypeaheadMenuPlugin.tsx:148

Parameters

trigger

string

__namedParameters

allowWhitespace?

boolean = false

maxLength?

number = 75

minLength?

number = 1

punctuation?

string = PUNCTUATION

Returns

TriggerFn

---

useDynamicPositioning()

useDynamicPositioning(resolution, targetElement, onReposition, onVisibilityChange?): void

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

Parameters

resolution

null | MenuResolution

targetElement

null | HTMLElement

onReposition

() => void

onVisibilityChange?

(isInView) => void

Returns

void

References

MenuOption

Re-exports MenuOption

---

MenuRenderFn

Re-exports MenuRenderFn

---

MenuResolution

Re-exports MenuResolution