@docx-editor.dev/vue 2.21.1 → 2.23.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 +17 -3
- package/dist/index.cjs +3 -3
- package/dist/index.d.cts +535 -211
- package/dist/index.d.ts +535 -211
- package/dist/index.js +3 -3
- package/package.json +4 -4
package/README.md
CHANGED
|
@@ -6,9 +6,9 @@
|
|
|
6
6
|
|
|
7
7
|
# @docx-editor.dev/vue
|
|
8
8
|
|
|
9
|
-
Vue 3
|
|
9
|
+
Use Vue 3 components and composables to open, edit, and save DOCX files.
|
|
10
10
|
|
|
11
|
-
The
|
|
11
|
+
The shared engine handles document state, editing, layout, and rendering.
|
|
12
12
|
|
|
13
13
|
## Install
|
|
14
14
|
|
|
@@ -78,7 +78,7 @@ The package also exports `useDocxEditor`, `useEditorState`, `useEditorEvent`, an
|
|
|
78
78
|
|
|
79
79
|
## SSR and Nuxt
|
|
80
80
|
|
|
81
|
-
The editor requires browser APIs. For Nuxt, mount it inside `<ClientOnly>` and use a `.client.vue` component for its imports. For other server-rendered applications,
|
|
81
|
+
The editor requires browser APIs. For Nuxt, mount it inside `<ClientOnly>` and use a `.client.vue` component for its imports. For other server-rendered applications, import and mount the editor in the browser.
|
|
82
82
|
|
|
83
83
|
The Nuxt module remains a private workspace package. External applications should follow the [Nuxt guide](https://www.docx-editor.dev/docs/2.x/frameworks/nuxt).
|
|
84
84
|
|
|
@@ -89,6 +89,20 @@ The Nuxt module remains a private workspace package. External applications shoul
|
|
|
89
89
|
- [Composables reference](https://www.docx-editor.dev/docs/2.x/vue/composables)
|
|
90
90
|
- Live demo: `bun run dev:vue` in the monorepo (`examples/vue`)
|
|
91
91
|
|
|
92
|
+
## Export Markdown and PDF
|
|
93
|
+
|
|
94
|
+
The adapter does not install either converter. Install only the formats your application uses.
|
|
95
|
+
|
|
96
|
+
Configure `menu.exporters` to enable **File > Export** with the conversion packages. Markdown downloads as one continuous document. PDF conversion requires a Node.js server. Missing converter handlers show an error with setup instructions. See [Export Markdown and PDF](https://www.docx-editor.dev/docs/2.x/guides/export).
|
|
97
|
+
|
|
98
|
+
**File > Print** uses the same PDF handler and opens the browser print dialog. Press Ctrl+P, or Cmd+P on macOS. See [Print documents](https://www.docx-editor.dev/docs/2.x/guides/print).
|
|
99
|
+
|
|
100
|
+
## Accept server updates
|
|
101
|
+
|
|
102
|
+
Use `createDocumentRefresh(editor)` to accept complete DOCX results from your server. The controller preserves the editor instance and scroll position. Each accepted file resets selection and undo history. Results after local edits and collaborative sessions are refused.
|
|
103
|
+
|
|
104
|
+
For highlights, change navigation, and recovery, see [Document refresh API](https://www.docx-editor.dev/docs/2.x/guides/document-refresh).
|
|
105
|
+
|
|
92
106
|
## License
|
|
93
107
|
|
|
94
108
|
Apache-2.0
|