Skip to main content

@lexical/react/useExtensionComponent

Functions​

useExtensionComponent()​

useExtensionComponent<Props, OutputComponent, Extension>(extension): OutputComponent

Defined in: packages/lexical-react/src/useExtensionComponent.tsx:52

Use a Component from the given Extension that uses the ReactExtension convention of exposing a Component property in its output.

Type Parameters​

Props​

Props extends Record<never, never>

OutputComponent​

OutputComponent extends ComponentType<Props>

Extension​

Extension extends OutputComponentExtension<OutputComponent>

Parameters​

extension​

Extension

An extension with a Component property in the output

Returns​

OutputComponent

getExtensionConfigFromEditor(useLexicalComposerContext()[0], extension).Component

useExtensionDependency()​

useExtensionDependency<Extension>(extension): LexicalExtensionDependency<Extension>

Defined in: packages/lexical-react/src/useExtensionComponent.tsx:19

Type Parameters​

Extension​

Extension extends AnyLexicalExtension

Parameters​

extension​

Extension

Returns​

LexicalExtensionDependency<Extension>

useOptionalExtensionDependency()​

useOptionalExtensionDependency<Extension>(extension): undefined | LexicalExtensionDependency<Extension>

Defined in: packages/lexical-react/src/useExtensionComponent.tsx:28

Type Parameters​

Extension​

Extension extends AnyLexicalExtension

Parameters​

extension​

Extension

Returns​

undefined | LexicalExtensionDependency<Extension>

usePeerExtensionDependency()​

usePeerExtensionDependency<Extension>(extensionName): undefined | LexicalExtensionDependency<Extension>

Defined in: packages/lexical-react/src/useExtensionComponent.tsx:34

Type Parameters​

Extension​

Extension extends AnyLexicalExtension

Parameters​

extensionName​

Extension["name"]

Returns​

undefined | LexicalExtensionDependency<Extension>