@open-egretta/lexical-export-docx

Export Lexical editor content to .docx format.

Installation

npm install @open-egretta/lexical-export-docx

Requires lexical >= 0.41.0 as a peer dependency.

Usage

Inside a React component

import { exportDocx } from "@open-egretta/lexical-export-docx";

// editor is a LexicalEditor instance
const blob = await exportDocx(editor);

const url = URL.createObjectURL(blob);
const a = document.createElement("a");
a.href = url;
a.download = "document.docx";
a.click();
URL.revokeObjectURL(url);

From JSON (SSR / Node.js)

import { exportDocxFromJSON } from "@open-egretta/lexical-export-docx";
import type { SerializedEditorState } from "lexical";

const json: SerializedEditorState = {
  /* ... */
};
const blob = await exportDocxFromJSON(json);

API

exportDocx(editor: LexicalEditor): Promise<Blob>

Reads the current editor state and returns a .docx Blob. Use this inside a React component where you have access to the LexicalEditor instance.

exportDocxFromJSON(json: SerializedEditorState): Promise<Blob>

Converts a serialized editor state directly to a .docx Blob. Has zero dependency on the Lexical runtime — suitable for SSR, testing, and Node.js environments.

Roadmap

Nodes

• [x] Paragraph
• [x] Heading (h1–h6)
• [x] Text (bold, italic, underline, strikethrough, subscript, superscript, highlight)
• [x] List (bullet, numbered)
• [x] Link (hyperlink)
• [x] Table (header rows, col/row span)
• [x] Horizontal rule
• [x] Page break
• [ ] Image
• [ ] Code block

Styling

• [x] Text formatting (bitmask: bold, italic, underline, strikethrough, subscript, superscript, highlight)
• [x] Block alignment (left, center, right, justify)
• [x] Block indent
• [ ] Inline style (font color, font size, font family, background color)
• [ ] Table styling (cell background, borders, padding)
• [ ] Document defaults (default font, page margins)

License

MIT