@docx-editor.dev/vue

中文文档
2.38.0发布于 2026/11/16Apache-2.0TypeScriptESM + CJS构建来源已验证近 30 天下载 1.5万

Vue 3 DOCX 编辑器适配器,用于@docx-editor.dev编辑合同.

中文使用文档
文档目录9 节
  1. 特征
  2. 安装
  3. 快开始
  4. 组成 API
  5. 安全部门改革和努克特
  6. 哪些 API 任务
  7. 文档和演示
  8. 许可证
  9. 自定义不支持的内容

DOCX Editor by EigenPal

@docx-editor.dev/vue (英语)

使用 Vue 3 组件和可堆肥来打开,编辑并保存 DOCX 文件.

共享引擎处理文档状态,编辑,布局和渲染.

特征

安装

安装适配器及其所需的引擎端点 :

npm install @docx-editor.dev/vue @docx-editor.dev/core

快开始

导入样式表一次, 并给编辑器一个有定义高度的容器 :

<script setup lang="ts">
import { DocxEditor } from '@docx-editor.dev/vue';
import '@docx-editor.dev/vue/styles.css';
</script>

<template>
  <div style="height: 100vh">
    <DocxEditor document="blank" />
  </div>
</template>

要打开文件,请通过文件 ArrayBuffer 或者说 Uint8Array 作为 :document。 。 。 .

组成 API

当您需要自己的界面时, 编写编辑器根, 视图和内容 。 在根内设置自定义控制 :

<script setup lang="ts">
import { DocxEditorRoot, DocxEditorViewport, DocxEditorContent } from '@docx-editor.dev/vue';
import '@docx-editor.dev/vue/styles.css';
import BoldButton from './BoldButton.vue';
</script>

<template>
  <DocxEditorRoot document="blank">
    <BoldButton />
    <DocxEditorViewport style="height: 80vh">
      <DocxEditorContent />
    </DocxEditorViewport>
  </DocxEditorRoot>
</template>

定义按钮 BoldButton.vue. 作曲体必须运行在以下的后人身上: DocxEditorRoot 访问编辑器。 解结构计算校对后, Vue 在模板中解开它们 :

<script setup lang="ts">
import { useEditorCommand } from '@docx-editor.dev/vue';

const { execute, isEnabled, isActive } = useEditorCommand('text.bold');
</script>

<template>
  <button @mousedown.prevent :disabled="!isEnabled" :aria-pressed="isActive" @click="execute()">
    Bold
  </button>
</template>

套件还出口 useDocxEditor, (中文(简体) ), useEditorState, (中文(简体) ), useEditorEvent,以及 useFontFamily。 。 。 .

安全部门改革和努克特

编辑器需要浏览器 API. 对于Nuxt,把它挂入里面 <ClientOnly> 并使用一个 .client.vue 进口部分。 对于其它服务器发送的应用程序,导入编辑器并在浏览器中挂载.

Nuxt模块仍然是私人工作空间软件包. 外部应用程序应遵循 坚果向导。 。 。 .

哪些 API 任务

使用 React 或 Vue 适配器钩, 复检钩,以及 DocxEditorReview 从 @docx-editor.dev/pro/react 或者说 @docx-editor.dev/pro/vue 用于构建浏览器审查控制。 使用编辑 API 在 @docx-editor.dev/editor-api 用于文档自动化。 它遵循Office.js对象模型,在浏览器和服务器主机中运行.

任务浏览器控制( React 或 Vue)文件自动化
对已找到文本的评论editor.findMatches, (中文(简体) ), editor.selectMatch,则 useReview().commentbody.search,则 Range.insertComment
对线索的答复useReview().reply(item, text)Comment.reply(text)
记录跟踪替换那么建议模式 editor.exec({ type: 'replaceMatch', match, text })document.changeTrackingMode = 'TrackMineOnly',则 Range.insertText(text, 'Replace')
提议将AI重写为已跟踪的更改prepareRewrite 结束 DocxEditor.createBrowserprepareRewrite 从 @docx-editor.dev/editor-api/agent
接受或拒绝更改useReview().accept(item) 或者说 useReview().reject(item)Revision.accept() 或者说 Revision.reject()
不滚动打开更改useReview().setActive(key, { reveal: false })不适用:无取景口
突出显示区域useHighlights(name, source, options)不适用
自定义审查铁路卡DocxEditorReview 与 preset 设置为 false, (中文(简体) ), useReviewCardHeights, (中文(简体) ), useStackedReviewPositions,以及 useReviewRailMetrics不适用
关于选择的注释按钮DocxEditorReview.AddComment 作为直系儿童 DocxEditorReview,或 useEditorCommand('review.addComment')不适用
页面设置和段落对话框DocxEditor.PageSetupDialog 或者说 DocxEditor.ParagraphDialogSection.pageSetup,以及 Paragraph 属性,例如 alignment

这个包装了任务秘方 docs/index.md.这些网站还有: 任务配方。 。 。 .

文档和演示

许可证

阿帕奇 - 2.0

自定义不支持的内容

登记组件 DocxEditor 或者说 DocxEditor.Root。每个声明处理匹配不支持的内容,包括不透明的内线和块元素.

<DocxEditor :document="bytes">
  <DocxEditor.UnsupportedElement
    :match="(element) => element.namespaceUri === 'urn:my-widgets'"
    :layout="{ width: 180, height: 48 }"
  >
    <template #default="{ element }">
      <MyWidget :element="element" />
    </template>
  </DocxEditor.UnsupportedElement>
  <DocxEditor.UnsupportedElement>
    <template #default="{ element }">
      <MyPlaceholder :label="element.label" />
    </template>
  </DocxEditor.UnsupportedElement>
</DocxEditor>

首个挂载匹配声明取胜. 提案更新保留其优先级. 取消和提出宣言再次给予后来的优先地位。 要暂时禁用特定渲染器, 请保持挂载并更改 match,或使用不相重叠的匹配器。 奥米 match 为了一个全面。 在上游使用源元数据; 在 pagination 之前没有几何数据 。 返回空位内容以保留默认占位符 。 空结果不选择下一个声明 .

UnsupportedElement 曝光情况 nodeId, (中文(简体) ), ownerPartName, (中文(简体) ), namespaceUri, (中文(简体) ), localName, (中文(简体) ), source, (中文(简体) ), placement,以及 label。 。 。 . bounds 在布局后描述保留框。 可选 drawing 财务报告和审定财务报表 equation 记录提供专门的元数据。 将源内容视为只读且不可信 .

layout 在文档点中保留不透明元素的宽度和高度。 源入会决定内入或块流. 无 layout,不透明入内元素预留120×24分;区块预留240×96分. 尺寸必须是正的、有限度的,最多10万分。 绘图和等式回落保留了现有的几何学. 无比不透明的内容保留了它现有的隐形行为. 无支持元素内部的属性、元数据和嵌入式有效载荷不是独立的内容事件.

组成部分保留框架背景和同一页再油漆的当地状态。 当 pagination,虚拟化,或文档更改去除一个发生时,它们可以重挂. 将持久应用数据保存在组件外。 支持更新和声明删除保留文档编辑并取消历史。 自定义渲染不会改变保存的 DOCX 内容 .

版本与发布记录

@docx-editor.dev/vue 共发布 56 个版本,首次发布于 2026/07/16;过去 12 个月发布了 56 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
2.38.0latest2026/11/16今天
2.38.0-canary.20261116033356.sha-2662bd1canary2026/11/16今天
2.38.0-canary.20261115032819.sha-05856f62026/11/151 天前
2.38.0-canary.20261114032659.sha-cdc64af2026/11/142 天前
2.38.0-canary.20261113032851.sha-e2cbc552026/11/133 天前
2.37.02026/11/115 天前

关于 @docx-editor.dev/vue 的常见问题

@docx-editor.dev/vue 是什么?

Vue 3 DOCX 编辑器适配器,用于@docx-editor.dev编辑合同.

如何安装 @docx-editor.dev/vue?

在项目目录运行 npm install @docx-editor.dev/vue,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:@docx-editor.dev/core(~2.38.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@docx-editor.dev/vue 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@docx-editor.dev/vue 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@docx-editor.dev/vue 可以商用吗?

@docx-editor.dev/vue 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@docx-editor.dev/vue 的下载量有多少?

根据 npm 官方下载统计,@docx-editor.dev/vue 在 2026/10/13 – 2026/11/11 这 30 天内被下载 15,335 次,日均约 511 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@docx-editor.dev/vue 还在维护吗?

最新版本 2.38.0 发布于 2026/11/16(今天);至今共发布 56 个版本,其中过去 12 个月发布了 56 个;首次发布于 2026/07/16。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。