Skip to main content

@lexical/react/ExtensionComponent

Type Aliases​

ExtensionComponentProps<Extension>​

ExtensionComponentProps<Extension> = object & [LexicalExtensionOutput<Extension>] extends [{ Component: infer OutputComponentType; }] ? Omit<ComponentProps<OutputComponentType>, "lexical:extension"> : never

Defined in: packages/lexical-react/src/ExtensionComponent.tsx:17

The lexical:extension prop combined with the props of the given Extension's output Component.

Type Declaration​

lexical:extension​

lexical:extension: Extension

The Extension

Type Parameters​

Extension​

Extension extends AnyLexicalExtension

Functions​

ExtensionComponent()​

ExtensionComponent<Extension>(__namedParameters): Element

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

A convenient way to get an Extension's output Component with useExtensionComponent and construct it in one step.

Type Parameters​

Extension​

Extension extends AnyLexicalExtension

Parameters​

__namedParameters​

ExtensionComponentProps<Extension>

Returns​

Element

Examples​

Usage

return (
  <ExtensionComponent
    lexical:extension={TreeViewExtension}
    viewClassName="tree-view-output" />
);

Alternative without ExtensionComponent

const TreeViewComponent = useExtensionComponent(TreeViewExtension);
return (<TreeViewComponent viewClassName="tree-view-output" />);