OpenOOXML

Guide eigenpal → OpenOOXML

Migrating from eigenpal to OpenOOXML

eigenpal was deprecated when its maintainers moved to a commercial product. OpenOOXML maintains BetterOffice, an independent Apache 2.0 DOCX engine and React editor. Choose the package for your integration and use the current API examples below.

01 Integration

Choose the core or the React editor

Use @betteroffice/docx for the framework-free engine, or @betteroffice/docx-react for the React editor with its toolbar and document canvas. The JavaScript guide covers both entry points.

$npm install @betteroffice/docx-react @betteroffice/docx react react-dom

02 Full migration

Move to the @betteroffice scope

Replace the deprecated eigenpal packages with the published BetterOffice packages, then update your imports, editor props and event handlers to the current API.

$npm uninstall @eigenpal/docx-editor-core @eigenpal/docx-editor-react
$npm install @betteroffice/docx-react @betteroffice/docx react react-dom
Deprecated eigenpal packageBetterOffice replacement
@eigenpal/docx-editor-core@betteroffice/docx
@eigenpal/docx-editor-react@betteroffice/docx-react
React editor
import { DocxEditor } from "@betteroffice/docx-react";
import "@betteroffice/docx-react/styles.css";

<DocxEditor documentBuffer={bytes} />;

See the JavaScript guide for document inputs and framework setup, and the font configuration guide for matching document font metrics. Current changes are recorded in the React editor changelog.

03 FAQ

Frequently asked questions

Is the API identical to eigenpal?
The published packages expose BetterOffice's own API. Update your imports and integration code using the JavaScript guide. An npm alias only changes a dependency's name; it does not adapt its exports, props or events.
Can I use BetterOffice with Vue?
Use the framework-free @betteroffice/docx core and integrate your own UI. The packaged editor UI uses React; there is no published Vue adapter.
Is OpenOOXML actively maintained?
Yes. The packages receive regular fixes and releases, and the engines are written in Rust with WebAssembly builds for the web.
What license does it use?
Apache 2.0 — permissive and free for commercial use.
Who is behind OpenOOXML?
It was started by a contributor to the original eigenpal editor, together with a community of former eigenpal users. Development happens in the open on GitHub.

OpenOOXML home · GitHub