@eigenpal/docx-editor-react 0.0.0 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +35 -0
  2. package/package.json +4 -5
package/README.md CHANGED
@@ -1,3 +1,17 @@
1
+ <p align="center">
2
+ <a href="https://www.docx-editor.dev/">
3
+ <img src="https://raw.githubusercontent.com/eigenpal/docx-editor/main/assets/header.png" alt="DOCX Editor — .docx in, .docx out. Open source, agent ready, client-side." width="500" />
4
+ </a>
5
+ </p>
6
+
7
+ <p align="center">
8
+ <a href="https://www.npmjs.com/package/@eigenpal/docx-editor-react"><img src="https://img.shields.io/npm/v/@eigenpal/docx-editor-react.svg?style=flat-square&color=3B5BDB" alt="npm version" /></a>
9
+ <a href="https://www.npmjs.com/package/@eigenpal/docx-editor-react"><img src="https://img.shields.io/npm/dm/@eigenpal/docx-editor-react.svg?style=flat-square&color=3B5BDB" alt="npm downloads" /></a>
10
+ <a href="https://github.com/eigenpal/docx-editor/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-Apache_2.0-blue.svg?style=flat-square&color=3B5BDB" alt="license" /></a>
11
+ <a href="https://docx-editor.dev/editor"><img src="https://img.shields.io/badge/Live_Demo-3B5BDB?style=flat-square&logo=vercel&logoColor=white" alt="Demo" /></a>
12
+ <a href="https://www.docx-editor.dev/docs"><img src="https://img.shields.io/badge/Docs-3B5BDB?style=flat-square&logo=readthedocs&logoColor=white" alt="Documentation" /></a>
13
+ </p>
14
+
1
15
  # @eigenpal/docx-editor-react
2
16
 
3
17
  React adapter for the [docx-editor](https://docx-editor.dev). WYSIWYG `.docx` editing with canonical OOXML, tracked changes, comments, real-time collaboration, and an AI agent bridge.
@@ -31,6 +45,18 @@ export function App() {
31
45
 
32
46
  > **Next.js / SSR:** Use dynamic import. The editor requires the DOM.
33
47
 
48
+ ## Packages
49
+
50
+ | Package | Description |
51
+ | -------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
52
+ | [`@eigenpal/docx-editor-react`](https://www.npmjs.com/package/@eigenpal/docx-editor-react) | <img src="https://cdn.simpleicons.org/react/61DAFB" width="20" align="middle" /> &nbsp; React adapter. Toolbar, paged editor, plugins. |
53
+ | [`@eigenpal/docx-editor-vue`](https://www.npmjs.com/package/@eigenpal/docx-editor-vue) | <img src="https://cdn.simpleicons.org/vuedotjs/4FC08D" width="20" align="middle" /> &nbsp; Vue 3 adapter. Toolbar, paged editor, plugins. |
54
+ | [`@eigenpal/docx-editor-core`](https://www.npmjs.com/package/@eigenpal/docx-editor-core) | Framework-agnostic core: OOXML parser, serializer, layout engine, ProseMirror schema. Depend on this if you fork the React or Vue adapter. |
55
+ | [`@eigenpal/docx-editor-i18n`](https://www.npmjs.com/package/@eigenpal/docx-editor-i18n) | Shared locale strings and types consumed by both adapters. |
56
+ | [`@eigenpal/docx-editor-agents`](https://www.npmjs.com/package/@eigenpal/docx-editor-agents) | Agent SDK and chat UI: framework-agnostic bridge, MCP server, AI SDK adapters, plus React UI. |
57
+
58
+ > **Forking the adapter?** Keep your fork thin. Depend on `@eigenpal/docx-editor-core` directly so parser, serializer, and rendering fixes land in your build automatically, without backporting each upstream change by hand.
59
+
34
60
  ## Imperative mounting
35
61
 
36
62
  ```ts
@@ -68,3 +94,12 @@ Full props and ref reference: **[docx-editor.dev/docs/props](https://www.docx-ed
68
94
  `@eigenpal/docx-editor-core` is installed transitively. Add it to your `package.json` only if your own code imports core APIs directly. Strict installers like pnpm with peer auto-install disabled may also need the ProseMirror peers listed in `package.json`.
69
95
 
70
96
  Examples: [Vite](https://github.com/eigenpal/docx-editor/tree/main/examples/vite) · [Next.js](https://github.com/eigenpal/docx-editor/tree/main/examples/nextjs) · [Remix](https://github.com/eigenpal/docx-editor/tree/main/examples/remix) · [Astro](https://github.com/eigenpal/docx-editor/tree/main/examples/astro)
97
+
98
+ ## Contributing
99
+
100
+ Contributions welcome. See [CONTRIBUTING.md](https://github.com/eigenpal/docx-editor/blob/main/CONTRIBUTING.md) for setup, tests, and the one-time CLA signature.
101
+
102
+ ## Commercial Support
103
+
104
+ > [!TIP]
105
+ > Questions or custom features? Email **[docx-editor@eigenpal.com](mailto:docx-editor@eigenpal.com)**.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@eigenpal/docx-editor-react",
3
- "version": "0.0.0",
3
+ "version": "1.0.0",
4
4
  "description": "React DOCX editor adapter for @eigenpal/docx-editor-core.",
5
5
  "main": "./dist/index.js",
6
6
  "module": "./dist/index.mjs",
@@ -66,7 +66,6 @@
66
66
  "scripts": {
67
67
  "build": "tsup && bun run build:css && node ../../scripts/inject-package-doc.mjs --package @eigenpal/docx-editor-react",
68
68
  "build:css": "tailwindcss -c ../../tailwind.config.lib.js -i ./src/styles/editor.css -o ./dist/styles.css --minify",
69
- "prepublishOnly": "bun run build",
70
69
  "typecheck": "tsc --noEmit",
71
70
  "api:extract": "node ../../scripts/api-extractor.mjs --package @eigenpal/docx-editor-react --local",
72
71
  "api:check": "node ../../scripts/api-extractor.mjs --package @eigenpal/docx-editor-react"
@@ -93,9 +92,9 @@
93
92
  }
94
93
  },
95
94
  "dependencies": {
96
- "@eigenpal/docx-editor-agents": "^0.5.1",
97
- "@eigenpal/docx-editor-core": "^0.0.28",
98
- "@eigenpal/docx-editor-i18n": "^0.0.1",
95
+ "@eigenpal/docx-editor-agents": "^1.0.0",
96
+ "@eigenpal/docx-editor-core": "^1.0.0",
97
+ "@eigenpal/docx-editor-i18n": "^1.0.0",
99
98
  "@radix-ui/react-select": "^2.2.6",
100
99
  "clsx": "^2.1.0",
101
100
  "sonner": "^2.0.7"