Skip to main content

@lexical/react/LexicalAutoEmbedPlugin

Classes

AutoEmbedOption

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

Extends

Constructors

Constructor

new AutoEmbedOption(title, options): AutoEmbedOption

Defined in: packages/lexical-react/src/LexicalAutoEmbedPlugin.tsx:67

Parameters
title

string

options
onSelect

(targetNode) => void

Returns

AutoEmbedOption

Overrides

MenuOption.constructor

Properties

key

key: string

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

Inherited from

MenuOption.key

onSelect()

onSelect: (targetNode) => void

Defined in: packages/lexical-react/src/LexicalAutoEmbedPlugin.tsx:66

Parameters
targetNode

null | LexicalNode

Returns

void

ref?

optional ref: MutableRefObject<null | HTMLElement>

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

Inherited from

MenuOption.ref

title

title: string

Defined in: packages/lexical-react/src/LexicalAutoEmbedPlugin.tsx:65

Methods

setRefElement()

setRefElement(element): void

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

Parameters
element

null | HTMLElement

Returns

void

Inherited from

MenuOption.setRefElement

Interfaces

EmbedConfig<TEmbedMatchResultData, TEmbedMatchResult>

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

Type Parameters

TEmbedMatchResultData

TEmbedMatchResultData = unknown

TEmbedMatchResult

TEmbedMatchResult = EmbedMatchResult<TEmbedMatchResultData>

Properties

insertNode()

insertNode: (editor, result) => void

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

Parameters
editor

LexicalEditor

result

TEmbedMatchResult

Returns

void

parseUrl()

parseUrl: (text) => null | TEmbedMatchResult | Promise<null | TEmbedMatchResult>

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

Parameters
text

string

Returns

null | TEmbedMatchResult | Promise<null | TEmbedMatchResult>

type

type: string

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

Type Aliases

EmbedMatchResult<TEmbedMatchResult>

EmbedMatchResult<TEmbedMatchResult> = object

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

Type Parameters

TEmbedMatchResult

TEmbedMatchResult = unknown

Properties

data?

optional data: TEmbedMatchResult

Defined in: packages/lexical-react/src/LexicalAutoEmbedPlugin.tsx:41

id

id: string

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

url

url: string

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

Variables

INSERT_EMBED_COMMAND

const INSERT_EMBED_COMMAND: LexicalCommand<EmbedConfig["type"]>

Defined in: packages/lexical-react/src/LexicalAutoEmbedPlugin.tsx:61


URL_MATCHER

const URL_MATCHER: RegExp

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

Functions

LexicalAutoEmbedPlugin()

LexicalAutoEmbedPlugin<TEmbedConfig>(__namedParameters): null | Element

Defined in: packages/lexical-react/src/LexicalAutoEmbedPlugin.tsx:91

Type Parameters

TEmbedConfig

TEmbedConfig extends EmbedConfig<unknown, EmbedMatchResult<unknown>>

Parameters

__namedParameters

LexicalAutoEmbedPluginProps<TEmbedConfig>

Returns

null | Element