Vite DOCX editor example

The demo combines packagedFonts() with googleFonts(). Packaged substitutes load first. A document can cause CDN requests for other declared font families.

Run the example

From the repository root, run:

bun install
bun run dev:react

Open http://localhost:5173.

The default document is public/sample.docx. In development, ?fixture=<name>.docx resolves a file with that name from e2e/fixtures/. Production builds include only the fixtures listed in vite.config.ts.

Add the editor to Vite

Install the adapter and its engine peer:

npm install @docx-editor.dev/react @docx-editor.dev/core

Import @docx-editor.dev/core/styles/editor.css once in your application entry. Then render the editor:

import '@docx-editor.dev/core/styles/editor.css';
import { useRef } from 'react';
import { DocxEditor, type DocxEditorRef } from '@docx-editor.dev/react';

function Editor({ file }: { file: ArrayBuffer }) {
  const editorRef = useRef<DocxEditorRef>(null);

  const handleSave = async () => {
    const buffer = await editorRef.current?.save();
    if (buffer) await fetch('/api/documents/1', { method: 'PUT', body: buffer });
  };

  return <DocxEditor ref={editorRef} document={file} onSave={handleSave} />;
}

document takes an ArrayBuffer, a Uint8Array, or an existing DocumentHandle. The editor loads embedded fonts without a resolver.

Pass usable font bytes for Word-accurate measurement. Without them, fallback measurement does not guarantee Word-compatible layout. Use packagedFonts() for local substitutes. googleFonts() opts your application into CDN requests.

Build custom chrome

src/ComposedEditorDemo.tsx uses the editor primitives and hooks directly.

<DocxEditor.Root document={bytes}>
  <YourHeader />
  <DocxEditor.Toolbar t={t} />
  <DocxEditor.Viewport>
    <DocxEditor.Content />
  </DocxEditor.Viewport>
</DocxEditor.Root>

For more information, see the React adapter guide.

Review changes in batches

Open http://localhost:5173/?bulkReview=1&fixture=bulk-review.docx after running bun run dev:react from the repository root. Filter by author or select individual changes, then accept or reject them. Check the skipped-change report and try Undo, Redo, and Save and reopen. The main-story API controls use RevisionCollection.resolve() without a selection, so they include changes hidden by the editor filter.

Run the browser checks with:

bunx playwright test --config e2e/editor-smoke.config.ts bulk-review.interaction.spec.ts

See Resolve a batch of changes for selection, result handling, and strict batches.