@lexical/headless

@lexical/headless

This package allows you to interact with Lexical in a headless environment (one that does not rely on DOM, e.g. for Node.js environment), and use its main features like editor.update(), editor.registerNodeTransform(), editor.registerUpdateListener() to create, update or traverse state.

Install @lexical/headless:

npm install --save @lexical/headless

const { createHeadlessEditor } = require('@lexical/headless');

const editor = createHeadlessEditor({
  nodes: [],
  onError: () => {},
});

editor.update(() => {
  $getRoot().append(
    $createParagraphNode().append(
      $createTextNode('Hello world')
    )
  )
});

Any plugins that do not rely on DOM could also be used. Here's an example of how you can convert lexical editor state to markdown on server:

const { createHeadlessEditor } = require('@lexical/headless');
const { $convertToMarkdownString, TRANSFORMERS } = require('@lexical/markdown');

app.get('article/:id/markdown', async (req, res) => {
  const editor = createHeadlessEditor({
    nodes: [],
    onError: () => {},
  });

  const articleEditorStateJSON = await loadArticleBody(req.query.id);
  editor.setEditorState(editor.parseEditorState(articleEditorStateJSON));

  editor.update(() => {
    const markdown = $convertToMarkdownString(TRANSFORMERS);
    res.send(markdown);
  });
});

Similar packages

Other packages similar to @lexical/headless

slate

Slate is a completely customizable framework for building rich text editors. It provides a more comprehensive set of tools for building complex editors with a focus on extensibility and customization, similar to @lexical/headless.

draft-js

Draft.js is a framework for building rich text editors in React. It offers a more opinionated approach with built-in components and styles, whereas @lexical/headless provides a more minimalistic, headless approach.

prosemirror

ProseMirror is a toolkit for building rich text editors with a focus on performance and flexibility. It offers a more structured approach to document editing compared to the headless nature of @lexical/headless.