@office-kit/docx

项目简介

docx 是 Office Kit 推出的 TypeScript 库，用于读取、编辑和写入 Word .docx 文件。它可以通过 createDocx 从零构建文档，也可以用 openDocx 打开现有 .docx，然后修改段落、文本运行、列表、表格、图片、页眉、页脚、批注、脚注、尾注、超链接、书签和修订。它可在 Node.js 和现代浏览器中运行，未建模的元素会原样写回。

核心功能

• 使用 createDocx 从零创建 .docx 文件，并追加标题、段落、项目符号和编号列表、表格、内联图片、页眉、页脚、脚注和目录。
• 使用 openDocx 打开现有 .docx 文件，以替换正文、页眉、页脚、脚注、尾注和批注中的文本；按替换文本交换图片；并接受或拒绝修订插入和删除。
• 借助配套的 @office-kit/docx-preview 包，在浏览器中将 Docx 值或原始字节渲染到 DOM 元素中。
• 支持页面设置、样式、表格、域、批注、书签、超链接、核心和应用属性、查找替换、大纲、统计、纯文本提取以及 validate()。
• 使用独立的 tree-shakeable 函数，仅提供 ESM 并附带 .d.ts 类型，有一个运行时依赖，可在 Node.js 和浏览器中运行。

适用场景

• 填充 Word 模板：打开现有 .docx，替换 {{name}} 等占位符，并保存结果。
• 从 Node.js 或浏览器代码中以编程方式生成报告、合同、信头和其他结构化文档。
• 编辑现有文档：更改文本、图片、页眉、页脚、注释、批注或修订，同时保留未建模的内容。
• 使用浏览器预览包在网页中预览 Word 文档，无需上传文件。

快速开始

• 使用 npm i @office-kit/docx、pnpm add @office-kit/docx 或 yarn add @office-kit/docx 进行安装。
• 导入 createDocx 从零构建文档，或导入 openDocx 打开现有 .docx 模板。
• 使用 appendParagraph、addBulletList、addTable、setPageSize、replaceTextEverywhere 和 toUint8Array 等函数来构建或修改文档。
• 如需浏览器预览，请将库与 @office-kit/docx-preview 配对，并调用 previewToDOM。

部署与要求

• 可在现代浏览器和 Node.js 中运行。
• 仅提供 ESM 并附带 .d.ts 类型。
• 没有仅限 Node 的依赖，可在浏览器中运行，包括使用 Blob 和 File API。
• 一个运行时依赖：用于 ZIP 处理的 fflate。
• @office-kit/docx-preview 封装了开源 docx-preview 渲染器，并在浏览器中运行。

采用前须知

• 许可证：MIT。在使用、修改或分发项目前，请确认其具体条款。