@eigenpal/docx-editor-vue 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.
- package/README.md +33 -2
- package/package.json +4 -4
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-vue"><img src="https://img.shields.io/npm/v/@eigenpal/docx-editor-vue.svg?style=flat-square&color=3B5BDB" alt="npm version" /></a>
|
|
9
|
+
<a href="https://www.npmjs.com/package/@eigenpal/docx-editor-vue"><img src="https://img.shields.io/npm/dm/@eigenpal/docx-editor-vue.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-vue
|
|
2
16
|
|
|
3
17
|
Vue 3 adapter for the [docx-editor](https://docx-editor.dev). WYSIWYG `.docx` editing with canonical OOXML, tracked changes, comments, and an AI agent bridge.
|
|
@@ -30,6 +44,18 @@ async function loadFile(e: Event) {
|
|
|
30
44
|
|
|
31
45
|
Import the stylesheet once at your app entry. Vite's library mode doesn't auto-inject CSS imports, so the toolbar will render unstyled without it.
|
|
32
46
|
|
|
47
|
+
## Packages
|
|
48
|
+
|
|
49
|
+
| Package | Description |
|
|
50
|
+
| -------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
51
|
+
| [`@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" /> React adapter. Toolbar, paged editor, plugins. |
|
|
52
|
+
| [`@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" /> Vue 3 adapter. Toolbar, paged editor, plugins. |
|
|
53
|
+
| [`@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. |
|
|
54
|
+
| [`@eigenpal/docx-editor-i18n`](https://www.npmjs.com/package/@eigenpal/docx-editor-i18n) | Shared locale strings and types consumed by both adapters. |
|
|
55
|
+
| [`@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. |
|
|
56
|
+
|
|
57
|
+
> **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.
|
|
58
|
+
|
|
33
59
|
## Imperative mounting
|
|
34
60
|
|
|
35
61
|
```ts
|
|
@@ -55,6 +81,11 @@ editor.destroy();
|
|
|
55
81
|
|
|
56
82
|
For lower-level mounting on your own DOM, use the `useDocxEditor` composable.
|
|
57
83
|
|
|
58
|
-
##
|
|
84
|
+
## Contributing
|
|
85
|
+
|
|
86
|
+
Contributions welcome. See [CONTRIBUTING.md](https://github.com/eigenpal/docx-editor/blob/main/CONTRIBUTING.md) for setup, tests, and the one-time CLA signature.
|
|
87
|
+
|
|
88
|
+
## Commercial Support
|
|
59
89
|
|
|
60
|
-
|
|
90
|
+
> [!TIP]
|
|
91
|
+
> 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-vue",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "1.0.0",
|
|
4
4
|
"description": "Vue 3 DOCX editor adapter for @eigenpal/docx-editor-core.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/index.cjs",
|
|
@@ -83,9 +83,9 @@
|
|
|
83
83
|
"vue": "^3.3.0"
|
|
84
84
|
},
|
|
85
85
|
"dependencies": {
|
|
86
|
-
"@eigenpal/docx-editor-agents": "^0.
|
|
87
|
-
"@eigenpal/docx-editor-core": "^0.0
|
|
88
|
-
"@eigenpal/docx-editor-i18n": "^0.0
|
|
86
|
+
"@eigenpal/docx-editor-agents": "^1.0.0",
|
|
87
|
+
"@eigenpal/docx-editor-core": "^1.0.0",
|
|
88
|
+
"@eigenpal/docx-editor-i18n": "^1.0.0"
|
|
89
89
|
},
|
|
90
90
|
"keywords": [
|
|
91
91
|
"docx",
|