@lexical/react/useExtensionComponent
Functions
useExtensionComponent()
useExtensionComponent<
OutputComponent>(extension):OutputComponent
Defined in: packages/lexical-react/src/useExtensionComponent.tsx:75
Use a Component from the given Extension that uses the ReactExtension convention of exposing a Component property in its output.
Type Parameters
OutputComponent
OutputComponent extends ComponentType<any>
Parameters
extension
OutputComponentExtension<OutputComponent>
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:27
Returns the resolved LexicalExtensionDependency for extension from
the current editor (read from the composer context), giving access to its
config and output. The editor must include this extension.
Type Parameters
Extension
Extension extends AnyLexicalExtension
Parameters
extension
Extension
Returns
LexicalExtensionDependency<Extension>
The extension's dependency record.
useOptionalExtensionDependency()
useOptionalExtensionDependency<
Extension>(extension):LexicalExtensionDependency<Extension> |undefined
Defined in: packages/lexical-react/src/useExtensionComponent.tsx:43
Like useExtensionDependency, but returns undefined instead of
throwing when extension is not present on the current editor. Useful for
optionally integrating with an extension that may or may not be configured.
Type Parameters
Extension
Extension extends AnyLexicalExtension
Parameters
extension
Extension
Returns
LexicalExtensionDependency<Extension> | undefined
The extension's dependency record, or undefined if absent.
usePeerExtensionDependency()
usePeerExtensionDependency<
Extension>(extensionName):LexicalExtensionDependency<Extension> |undefined
Defined in: packages/lexical-react/src/useExtensionComponent.tsx:57
Returns the LexicalExtensionDependency for a peer extension looked up
by extensionName, or undefined if no extension with that name is present
on the current editor. Use this when you only have the peer extension's name
(for example to avoid a hard dependency on its module).
Type Parameters
Extension
Extension extends AnyLexicalExtension
Parameters
extensionName
Extension["name"]
Returns
LexicalExtensionDependency<Extension> | undefined
The peer extension's dependency record, or undefined if absent.