Skip to main content

Plugins

React-based plugins are using Lexical editor instance from <LexicalComposer> context:

<LexicalComposer initialConfig={initialConfig}>
  <LexicalPlainTextPlugin
    contentEditable={<LexicalContentEditable />}
    placeholder={<div>Enter some text...</div>}
  />
  <LexicalHistoryPlugin />
  <LexicalOnChangePlugin onChange={onChange} />
  ...
</LexicalComposer>

LexicalPlainTextPlugin​

React wrapper for @lexical/plain-text that adds major features for plain text editing, including typing, deletion and copy/pasting

<LexicalPlainTextPlugin
  contentEditable={<LexicalContentEditable />}
  placeholder={<div>Enter some text...</div>}
/>

LexicalRichTextPlugin​

React wrapper for @lexical/rich-text that adds major features for rich text editing, including typing, deletion, copy/pasting, indent/outdent and bold/italic/underline/strikethrough text formatting

<LexicalRichTextPlugin
  contentEditable={<LexicalContentEditable />}
  placeholder={null}
/>

LexicalOnChangePlugin​

Plugin that calls onChange whenever Lexical state is updated. Using ignoreInitialChange (true by default) and ignoreSelectionChange (false by default) can give more granular control over changes that are causing onChange call

<LexicalOnChangePlugin onChange={onChange} />

LexicalHistoryPlugin​

React wrapper for @lexical/history that adds support for history stack management and undo / redo commands

<LexicalHistoryPlugin />

LexicalLinkPlugin​

React wrapper for @lexical/link that adds support for links, including toggleLink command support that toggles link for selected text

<LexicalLinkPlugin />

LexicalListPlugin​

React wrapper for @lexical/list that adds support for lists (ordered and unordered)

<LexicalLinkPlugin />

LexicalCheckListPlugin​

React wrapper for @lexical/list that adds support for check lists. Note that it requires some css to render check/uncheck marks. See PlaygroundEditorTheme.css for details.

<LexicalLinkPlugin />

LexicalTablePlugin​

React wrapper for @lexical/table that adds support for tables

<LexicalTablePlugin />

LexicalAutoLinkPlugin​

Plugin will convert text into links based on passed matchers list. In example below whenever user types url-like string it will automaticaly convert it into a link node

const URL_MATCHER =
  /((https?:\/\/(www\.)?)|(www\.))[-a-zA-Z0-9@:%._+~#=]{1,256}\.[a-zA-Z0-9()]{1,6}\b([-a-zA-Z0-9()@:%_+.~#?&//=]*)/;

const MATCHERS = [
  (text) => {
    const match = URL_MATCHER.exec(text);
    return (
      match && {
        index: match.index,
        length: match[0].length,
        text: match[0],
        url: match[0],
      }
    );
  },
];

...

<LexicalAutoLinkPlugin matchers=[MATCHERS] />

LexicalAutoScrollPlugin​

Lexical auto-scrolls its contenteditable container while typing. This plugin can be used for cases when other element up in a DOM tree needs to be scrolled (e.g. when editor is rendered within dialog with limited height):

<div ref={containerWithScrollRef}>
  <LexicalComposer>
    ...
    <LexicalAutoScrollPlugin scrollRef={containerWithScrollRef} />
  </LexicalComposer>
</div>

LexicalClearEditorPlugin​

Adds clearEditor command support to clear editor's content

LexicalMarkdownShortcutPlugin​

Adds markdown shortcut support: headings, lists, code blocks, quotes, links and inline styles (bold, italic, strikethrough)