跳至主要内容

模組: @lexical/react/LexicalTypeaheadMenuPlugin

參考

重新匯出 MenuOption


重新匯出 MenuRenderFn


重新匯出 MenuResolution

類型別名

Ƭ MenuTextMatch: Object

類型聲明

名稱類型
leadOffsetnumber
matchingStringstring
replaceableStringstring

定義於

packages/lexical-react/src/shared/LexicalMenu.ts:37


TriggerFn

Ƭ TriggerFn: (text: string, editor: LexicalEditor) => MenuTextMatch | null

類型聲明

▸ (text, editor): MenuTextMatch | null

參數
名稱類型
textstring
editorLexicalEditor
返回

MenuTextMatch | null

定義於

packages/lexical-react/src/shared/LexicalMenu.ts:581


TypeaheadMenuPluginProps

Ƭ TypeaheadMenuPluginProps<TOption>: Object

類型參數

名稱類型
TOption擴展 MenuOption

類型聲明

名稱類型
anchorClassName?string
commandPriority?CommandListenerPriority
menuRenderFnMenuRenderFn<TOption>
onClose?() => void
onOpen?(resolution: MenuResolution) => void
onQueryChange(matchingString: string | null) => void
onSelectOption(option: TOption, textNodeContainingQuery: TextNode | null, closeMenu: () => void, matchingString: string) => void
optionsTOption[]
parent?HTMLElement
triggerFnTriggerFn

定義於

packages/lexical-react/src/LexicalTypeaheadMenuPlugin.tsx:191

變數

PUNCTUATION

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

定義於

packages/lexical-react/src/LexicalTypeaheadMenuPlugin.tsx:34


SCROLL_TYPEAHEAD_OPTION_INTO_VIEW_COMMAND

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

定義於

packages/lexical-react/src/LexicalTypeaheadMenuPlugin.tsx:149

函數

LexicalTypeaheadMenuPlugin

LexicalTypeaheadMenuPlugin<TOption>(«destructured»): JSX.Element | null

類型參數

名稱類型
TOption擴展 MenuOption

參數

名稱類型
«destructured»TypeaheadMenuPluginProps<TOption>

返回

JSX.Element | null

定義於

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


getScrollParent

getScrollParent(element, includeHidden): HTMLElement | HTMLBodyElement

參數

名稱類型
elementHTMLElement
includeHiddenboolean

返回

HTMLElement | HTMLBodyElement

定義於

packages/lexical-react/src/LexicalTypeaheadMenuPlugin.tsx:117


useBasicTypeaheadTriggerMatch

useBasicTypeaheadTriggerMatch(trigger, «destructured»): TriggerFn

參數

名稱類型預設值
triggerstringundefined
«destructured»Objectundefined
› maxLength?number75
› minLength?number1

返回

TriggerFn

定義於

packages/lexical-react/src/LexicalTypeaheadMenuPlugin.tsx:154


useDynamicPositioning

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

參數

名稱類型
resolutionnull | MenuResolution
targetElementnull | HTMLElement
onReposition() => void
onVisibilityChange?(isInView: boolean) => void

返回

void

定義於

packages/lexical-react/src/shared/LexicalMenu.ts:198