Summary

This project provides an open-source WYSIWYG .docx editor library, designed for React and Vue applications. It offers core features like canonical OOXML handling, tracked changes, and real-time collaboration, enabling developers to embed robust document editing capabilities into their platforms. The library is also agent-ready, with an SDK for AI integration.

How It Works

The editor leverages a framework-agnostic core (@eigenpal/docx-editor-core) that includes an OOXML parser, serializer, and layout engine, built upon a ProseMirror schema. This core is then adapted for specific frontend frameworks (React, Vue, Nuxt) via dedicated packages, allowing for a consistent editing experience while maintaining flexibility. This modular approach facilitates easier forking and customization.

Quick Start & Requirements

Installation is managed via npm:

• React: npm install @eigenpal/docx-editor-react
• Vue: npm install @eigenpal/docx-editor-vue
• Nuxt: npm install @eigenpal/nuxt-docx-editor Official documentation and quick-start guides are available for each framework. The editor requires a DOM environment, necessitating dynamic imports for Server-Side Rendering (SSR) frameworks like Next.js. Development utilizes bun.

Highlighted Details

• Full-featured WYSIWYG .docx editing.
• Support for canonical OOXML, tracked changes, and real-time collaboration.
• Agent SDK and chat UI components for AI integration.
• Extensible plugin architecture for custom functionality.
• Framework adapters for React, Vue, and Nuxt.

Maintenance & Community

The project encourages contributions via CONTRIBUTING.md and requires a one-time CLA signature. It actively supports internationalization (i18n) with a guide for adding new languages. Commercial support and custom feature inquiries can be directed to docx-editor@eigenpal.com. A live preview of the main branch is auto-deployed at latest.docx-editor.dev.

Licensing & Compatibility

The provided README does not explicitly state the project's license. Potential adopters should verify licensing terms, especially concerning commercial use or integration into closed-source applications.

Limitations & Caveats

Server-Side Rendering (SSR) requires dynamic imports due to the editor's reliance on a DOM environment. No other specific limitations, known bugs, or alpha status were mentioned in the provided documentation.