@lexical/extension/LexicalBuilder

Functions

buildEditorFromExtensions()

buildEditorFromExtensions(...extensions): LexicalEditorWithDispose

Defined in: packages/lexical-extension/src/LexicalBuilder.ts:81

Build a LexicalEditor by combining together one or more extensions, optionally overriding some of their configuration.

Parameters

extensions

...AnyLexicalExtensionArgument[]

Extension arguments (extensions or extensions with config overrides)

Returns

LexicalEditorWithDispose

An editor handle

Examples

A single root extension with multiple dependencies

const editor = buildEditorFromExtensions(
  defineExtension({
    name: "[root]",
    dependencies: [
      RichTextExtension,
      configExtension(EmojiExtension, { emojiBaseUrl: "/assets/emoji" }),
    ],
    register: (editor: LexicalEditor) => {
      console.log("Editor Created");
      return () => console.log("Editor Disposed");
    },
  }),
);

A very similar minimal configuration without the register hook

const editor = buildEditorFromExtensions(
  RichTextExtension,
  configExtension(EmojiExtension, { emojiBaseUrl: "/assets/emoji" }),
);