# @file-viewer/renderer-word 中文文档

规范地址：https://npmcn.com/package/%40file-viewer/renderer-word/

版本：3\.3\.3
npm 元数据更新时间：2026-10-31T11:11:45.463Z
中文译文更新时间：2026-11-14T17:42:08.326Z
软件包许可：Apache-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40file-viewer/renderer-word
原文对照：https://npmcn.com/package/%40file-viewer/renderer-word/?lang=original
项目主页：https://doc.file-viewer.app/guide/on-demand-renderers
源码仓库：https://github.com/flyfish-dev/file-viewer

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：120 kB，30 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：4 个
- 首次发布：2026-06-23T06:20:45.806Z
- 最新版本发布：2026-10-31T11:11:45.112Z
- 近 30 天下载量：159146（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：59（近 12 个月 59 个）

## 中文简介

独立的 DOCX, DOC, 以及文件查看器的 OpenDocument 渲染器; RTF 解析是一个明确的选入能力.

## 安装

```sh
npm install @file-viewer/renderer-word
```

也可以使用：`pnpm add @file-viewer/renderer-word`、`yarn add @file-viewer/renderer-word`、`bun add @file-viewer/renderer-word`

## README

# @file-viewer/renderer-word

[English](https://github.com/flyfish-dev/file-viewer/blob/main/packages/renderers/word/README.md) · [简体中文](https://github.com/flyfish-dev/file-viewer/blob/main/packages/renderers/word/README.zh-CN.md)

Flyfish File Viewer 的 Word / OpenDocument renderer 包。standard/full 默认承接 DOCX/DOCM/DOTX/DOTM、旧版 DOC/DOT 与 ODT/ODP；RTF 由 `@file-viewer/capability-rtf` 显式启用。

## 用法

```ts
import FileViewer from '@file-viewer/vue3'
import { wordRenderer } from '@file-viewer/renderer-word'

const options = {
  rendererMode: 'replace',
  renderers: wordRenderer,
}
```

也可以和其他 renderer 一起组合：

```ts
import { wordRenderer } from '@file-viewer/renderer-word'
import { pdfRenderer } from '@file-viewer/renderer-pdf'
import { presentationRenderer } from '@file-viewer/renderer-presentation'

const options = {
  rendererMode: 'replace',
  renderers: [wordRenderer, pdfRenderer, presentationRenderer],
}
```

官方 Demo 和完整格式矩阵可以直接使用 `@file-viewer/preset-all`。

## 能力边界

-   DOCX / DOCM / DOTX / DOTM 使用自研 `@file-viewer/docx`，默认 Worker 解析、连续流式阅读、目录字段缓存、异步分批渲染，并跟随 viewer 主题启用暗黑文档面。
-   DOC / DOT 使用 `@file-viewer/doc`，并套用 Word 风格纸张阅读面、缩放、打印和 HTML 导出适配。
-   安装 RTF capability 后才使用 `rtf.js`；未安装时会显示精确 CLI 启用命令。ODT / ODP 读取 OpenDocument 包内 `content.xml` 做安全结构预览。
-   继续复用 core 的统一搜索、缩放、打印、导出、生命周期和操作能力。

DOCX 的解析、分页、制表位、绘图锚点、VML 文本坐标、合并单元格边框、背景图和修订样式均由 `docxjs` 引擎负责。本包负责容器适配、交互与输出接入，不再对生成的文档节点做补救改写。

Word 2003 XML 按根元素及其完整命名空间识别，HTML 注释、正文中的示例或命名空间子串不会改变容器类型。未内置 JSZip 的 DOCX Worker 使用同源 HTTP(S) 或 Blob 库地址，拒绝跨源及含凭据的地址。

## 文本修订

`options.docx.reviewMode` 同时适用于 DOC 和 DOCX：`all`（默认）用下划线显示实际插入、用删除线显示实际删除；`final` 显示定稿，`original` 显示修订前文字。同一组件修改该参数后会更新预览，不需要重新选择文件，也不会接受、拒绝修订或重写原始文件。文本修订支持不等于完整支持 Word 审阅历史、格式修订或移动记录。

## 离线资产

DOCX Worker 默认读取 viewer assets 下的：

-   `vendor/docx/docx.worker.js`
-   `vendor/docx/jszip.min.js`

私有化部署时可以通过 `options.docx.workerUrl` 和 `options.docx.workerJsZipUrl` 覆盖：

```ts
const options = {
  docx: {
    workerUrl: '/file-viewer/vendor/docx/docx.worker.js',
    workerJsZipUrl: '/file-viewer/vendor/docx/jszip.min.js',
  },
}
```

DOCX 暗黑渲染默认由 `options.theme` 决定：`dark` 开启、`light` 关闭、`system` 跟随浏览器系统主题。需要业务固定效果时可传 `options.docx.darkMode: true / false`。

DOC、DOCX 与 RTF 的外部链接及 HTTP(S) 图片关系默认阻断。只有显式设置 `options.docx.externalLinkPolicy: 'allow'` 和 `options.docx.externalResourcePolicy: 'allow'` 才会启用；链接仍只接受 HTTP(S)、`mailto:`、`tel:` 和安全相对地址，未知协议与协议相对地址始终拒绝。内嵌图片、内部书签以及本地 `data:`/`blob:` 图片资源不受影响。

标准 renderer 会在挂载前净化 `rtf.js` 产生的 DOM。自定义 RTF 集成若直接消费 HTML，应先调用 `sanitizeFileViewerRtfHtml(document, markup, options)`；该边界与标准挂载使用同一链接策略和 DOMPurify 配置。严格 Trusted Types CSP 需允许 `file-viewer-document-sanitizer` 策略名。

## 嵌入 HTML

使用 `options.docx.renderAltChunks: false` 可以完全省略 DOCX 内嵌 HTML 部件，正文与普通内嵌图片不受影响。未指定或设为 `true` 时保留引擎原有沙箱渲染，不会开启脚本执行、同源权限或放宽外部链接/资源策略。该选项适用于 Worker 与主线程解析，不涉及旧二进制 DOC。

## 迁移说明

`@file-viewer/core` 已不再直接依赖 `@file-viewer/docx`、`@file-viewer/doc`、`rtf.js`、`linkedom` 或 `@xmldom/xmldom`。需要 Word 完整预览时，请安装本包并通过 `renderers` 传入，或使用 `@file-viewer/preset-all`。

## 打印页面

固定分页 DOCX 按每页原始纸张尺寸输出，支持横向分节和 A4／Letter 混排。 预览缩放不改变打印尺寸；通过具名 CSS 页面规则避免额外添加外层页边距， 文档本身的页边距保持不变。流式模式仍由浏览器分页，不按固定高度裁切。 打印驱动或打印对话框中的纸张设置仍可能覆盖浏览器提供的尺寸。

## 常见问题

### @file-viewer/renderer-word 是什么？

独立的 DOCX, DOC, 以及文件查看器的 OpenDocument 渲染器; RTF 解析是一个明确的选入能力\.

### 如何安装 @file-viewer/renderer-word？

在项目目录运行 npm install @file-viewer/renderer-word，或使用 pnpm add / yarn add / bun add。

### @file-viewer/renderer-word 支持 TypeScript 吗？

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

### @file-viewer/renderer-word 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @file-viewer/renderer-word 可以商用吗？

@file-viewer/renderer-word 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @file-viewer/renderer-word 的下载量有多少？

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

### @file-viewer/renderer-word 还在维护吗？

最新版本 3\.3\.3 发布于 2026/10/31（14 天前）；至今共发布 59 个版本，其中过去 12 个月发布了 59 个；首次发布于 2026/06/23。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。