Examples
Runnable DOCX editor starters for Vite, Next.js, Remix, and Astro, plus a fully themed editor and a headless editing script. Clone one and run it.
Two kinds of examples. The starters are complete apps in the repo, one per framework or feature; clone and run them. The live demo runs right here on this page.
Runnable starters
Every starter lives under examples/ in the repo and runs with bun install followed by the bun run dev:* script in its README. All of them resolve @docx-editor.dev/* from the monorepo workspace rather than from npm. Most need the packages built once first (bun run build:packages from the repo root); the Vite starter aliases package source directly and needs no build step. To run a starter against the published npm packages instead, replace the workspace:* versions in its package.json.
Vite + React
Plain Vite + React SPA, and the fullest example in the repo: composed chrome, the review sidebar, and a custom node, all on the public primitives.
Next.js
App Router integration. One dynamic() import with ssr: false; the rest of the page stays server-rendered.
Remix
Remix (Vite) with the editor gated behind a mount check and a lazy() import.
Astro
The editor as a React island with client:only="react", skipping Astro's SSR for the component.
Igloo
A fully themed editor. Every control is host markup over the hooks, so nothing of the packaged look remains.
Custom nodes
Define, insert, edit, and round-trip a citation node stored as a Word content control.
Headless editing
A script that fills a template with no browser and no framework, plus what the browser entry adds when an editor is already open.
Each starter's README has the exact commands.
Live demo
<DocxEditor> running in this page. Open one of your own files in it.
Next steps
- Quickstart: build the load → edit → save loop yourself
- Installation: per-framework setup behind each starter
- Composition: the primitives the Igloo starter is built on
- Editing API: the object model behind the headless starter
Word fidelity
Word feature support matrix for the DOCX editor: what renders, what edits, what round-trips with structural fidelity, plus the security model and API stability policy.
@docx-editor.dev/react
React adapter for the DOCX editor: the packaged root component, provider primitives, shared hooks, and compound chrome, all from the package root.