Skip to main content

@lexical/react/ReactPluginHostExtension

Interfaces​

DecoratorComponentProps​

Defined in: packages/lexical-react/src/shared/types.ts:21

Properties​

context​

context: LexicalComposerContextWithEditor

Defined in: packages/lexical-react/src/shared/types.ts:22

HostMountCommandArg​

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

Properties​

root​

root: Root

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

MountPluginCommandArg​

Defined in: packages/lexical-react/src/ReactPluginHostExtension.tsx:42

Properties​

domNode?​

optional domNode: null | Element | DocumentFragment

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

element​

element: null | Element

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

key​

key: string

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

Variables​

REACT_PLUGIN_HOST_MOUNT_PLUGIN_COMMAND​

const REACT_PLUGIN_HOST_MOUNT_PLUGIN_COMMAND: LexicalCommand<MountPluginCommandArg>

Defined in: packages/lexical-react/src/ReactPluginHostExtension.tsx:113

REACT_PLUGIN_HOST_MOUNT_ROOT_COMMAND​

const REACT_PLUGIN_HOST_MOUNT_ROOT_COMMAND: LexicalCommand<HostMountCommandArg>

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

ReactPluginHostExtension​

const ReactPluginHostExtension: LexicalExtension<ExtensionConfigBase, "@lexical/react/ReactPluginHost", { mountedPluginsStore: Signal<{ plugins: Map<string, MountPluginCommandArg>; }>; mountReactPlugin: (arg) => void; mountReactPluginHost: (container) => boolean; }, unknown>

Defined in: packages/lexical-react/src/ReactPluginHostExtension.tsx:164

This extension provides a React host for editors that are not built with LexicalExtensionComposer (e.g. you are using Vanilla JS or some other framework).

You must use mountReactPluginHost for any React content to work. Afterwards, you may use mountReactExtensionComponent to render UI for a specific React Extension. mountReactPluginComponent and mountReactPluginElement can be used to render legacy React plug-ins (or any React content).

Functions​

mountReactExtensionComponent()​

mountReactExtensionComponent<Extension>(editor, opts): void

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

Type Parameters​

Extension​

Extension extends AnyLexicalExtension

Parameters​

editor​

LexicalEditor

opts​

object & Omit<MountPluginCommandArg, "element">

Returns​

void

mountReactPluginComponent()​

mountReactPluginComponent<P>(editor, opts): void

Defined in: packages/lexical-react/src/ReactPluginHostExtension.tsx:75

Type Parameters​

P​

P extends Record<never, never> = Record<never, never>

Parameters​

editor​

LexicalEditor

opts​

object & Omit<MountPluginCommandArg, "element">

Returns​

void

mountReactPluginElement()​

mountReactPluginElement(editor, opts): void

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

Parameters​

editor​

LexicalEditor

opts​

MountPluginCommandArg

Returns​

void

mountReactPluginHost()​

mountReactPluginHost(editor, container): void

Defined in: packages/lexical-react/src/ReactPluginHostExtension.tsx:101

Parameters​

editor​

LexicalEditor

container​

Container

Returns​

void