Skip to content

eigenpal/docx-editor

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

589 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

DOCX JS Editor

npm version npm downloads license Live Demo Documentation

docx-editor

Open-source WYSIWYG DOCX editor for the browser. No server required. Live demo | Documentation

DOCX JS Editor screenshot

  • WYSIWYG editing with Word fidelity — formatting, tables, images, hyperlinks
  • Track changes (suggestion mode) with accept/reject
  • Comments with replies, resolve/reopen, scroll-to-highlight
  • Realtime collaboration with Yjs
  • Internationalization (i18n) - community-contributed translations welcome
  • Plugin system
  • Client-side only, zero server dependencies

Quick Start

npm install @eigenpal/docx-js-editor
import { useRef } from 'react';
import { DocxEditor, type DocxEditorRef } from '@eigenpal/docx-js-editor';
import '@eigenpal/docx-js-editor/styles.css';

function Editor({ file }: { file: ArrayBuffer }) {
  const editorRef = useRef<DocxEditorRef>(null);
  return <DocxEditor ref={editorRef} documentBuffer={file} mode="editing" onChange={() => {}} />;
}

Next.js / SSR: Use dynamic import — the editor requires the DOM.

Packages

Package Description
@eigenpal/docx-js-editor React UI — toolbar, paged editor, plugins. Install this.
@eigenpal/docx-editor-vue Vue.js scaffold — contributions welcome

Plugins

import { DocxEditor, PluginHost, templatePlugin } from '@eigenpal/docx-js-editor';

<PluginHost plugins={[templatePlugin]}>
  <DocxEditor documentBuffer={file} />
</PluginHost>;

See the plugin documentation for the full plugin API.

Development

bun install
bun run dev        # localhost:5173
bun run build
bun run typecheck

Examples: Vite | Next.js | Remix | Astro | Vue

Documentation | Props & Ref Methods | Plugins | Architecture

Translations

Help translate the editor into your language! See the full i18n contribution guide.

bun run i18n:new de      # scaffold German locale
bun run i18n:status      # check translation coverage

Commercial Support

Tip

Questions or custom features? Email docx-editor@eigenpal.com.