Examples

Runnable DOCX editor starters for React, Vue, server-rendered frameworks, collaboration, agents, and export.

Choose an example

Each starter lives in the repository's examples/ directory.

TaskExample
Mount the packaged editorHappy path
Start from a frameworkVite, Next.js, Remix, Astro, Vue, Nuxt
Build custom chromeIgloo Editor
Embed custom nodes in content controlsCustom nodes
Replace a document at runtimeDocument refresh
Scroll to and highlight paragraph referencesAnchor navigation
Move the editor into another windowPop-out window
Automate a documentDocument automation
Connect an agentRoast My Doc, Writer agent, Server agent review
Collaborate in real timePeer-to-peer, Server-backed
Export a documentDOCX to Markdown, DOCX to PDF

Run a repository starter

Clone the repository, then install dependencies and build the packages from the root:

git clone https://github.com/eigenpal/docx-editor.git
cd docx-editor
bun install
bun run build:packages

Run the bun run dev:* command from the starter README. The Vite with React and Vite with Vue starters alias package source and do not need build:packages.

Use published packages

  • Web starters use workspace:* dependencies for @docx-editor.dev/* packages, not published npm versions.
  • To use published packages, replace the workspace:* versions in the starter's package.json.
  • The Vue adapter is published to npm. The Nuxt module is a private workspace package.

Try the live demo

This demo runs <DocxEditor> on this page. Open one of your .docx files in it.

Next steps