# @beyondwork/docx-react-component 中文文档

规范地址：https://npmcn.com/package/%40beyondwork/docx-react-component/

版本：1\.0\.352
npm 元数据更新时间：2026-11-08T08:11:09.184Z
中文译文更新时间：2026-11-08T00:40:31.374Z
软件包许可：SEE LICENSE IN LICENSE\.md

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

原始 npm 页面：https://www.npmjs.com/package/%40beyondwork/docx-react-component
原文对照：https://npmcn.com/package/%40beyondwork/docx-react-component/?lang=original
项目主页：https://github.com/bwllaming/React-OOXML-Office#readme
源码仓库：https://github.com/bwllaming/React-OOXML-Office

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

- 包体积（解压后）：808 MB，1493 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：11 个
- peer 依赖：yjs ^13\.6\.0，react ^19\.2\.0，react-dom ^19\.2\.0，tailwindcss ^4\.2\.2，y-protocols ^1\.0\.0，y-prosemirror ^1\.2\.0，prosemirror-view ^1\.41\.7，prosemirror-model ^1\.25\.4，prosemirror-state ^1\.4\.4，prosemirror-keymap ^1\.2\.3，prosemirror-tables ^1\.8\.5，prosemirror-commands ^1\.7\.1，prosemirror-transform ^1\.11\.0
- 首次发布：2026-04-07T15:29:34.711Z
- 最新版本发布：2026-11-08T08:11:09.006Z
- 近 30 天下载量：9729（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：337（近 12 个月 337 个）

## 中文简介

嵌入可回放的Word(docx)编辑器,并附有评论,评论,跟踪变化,和圆通OOXML忠心.

## 安装

```sh
npm install @beyondwork/docx-react-component
```

也可以使用：`pnpm add @beyondwork/docx-react-component`、`yarn add @beyondwork/docx-react-component`、`bun add @beyondwork/docx-react-component`

## README

* * *

## 标题: 组合 摘要:作曲家,导出者,和克立地——集成出品家族,执行边界,开发者入场点. 观众:消费者、包装者、代理者、维护者 稳定:主要途径 docRole: 主路径 犬科:真实

# 组合

![Ensemble.](https://npmcn.com/package/%40beyondwork/docx-react-component/assets/ensemble/ensemble-wordmark-ink.svg)

**让你的工作重要.** 《超越实验室》发行.

集成在 " 超越工作 " 平台上将作曲家、导师和清晰的可工作建筑汇集在一起。 该数据库载有文件和工作手册执行情况以及Clarity项目脚手架.

这个寄存器为后台文档工作构建可嵌入的回放组件,一个原则是: **高级任务对于人工智能特工和人类用户同样应当容易.** 通过UI曝光的每个能力也通过结构化的API提供,因此人类点击"接受改变"和代理呼叫 `api.runtime.review.getChanges()` 运行在相同的运行时间,相同的命令,相同的读取模型,以及相同的回程OOXML忠诚保证.

| 构成部分 | 这是什么 | 状态 |
| --- | --- | --- |
| **作曲家** | 单词( E)`.docx`评论编辑器——值得信赖的WYSIWYG、跟踪变化、评论、工作流程范围、往返OOXML忠诚度 | 发表于 [`@beyondwork/docx-react-component`](https://www.npmjs.com/package/@beyondwork/docx-react-component) |
| **指挥员** | 模型和工作手册——本土的Rust计算引擎,帆布网格,审查工作流程,和往返保存 | 于此还原( I)`crates/sheets-*`, (中文(简体) ), `services/xlsx-conductor`; 软件包特性保持稳定 |
| **清晰度** | 论点和交流:索赔、证据、叙述和针对具体受众的形式 | 项目支点在 [`services/clarity`](https://npmcn.com/package/%40beyondwork/docx-react-component/services/clarity/README.md); PDF 审查、甲板编写和 HTML 输出计划 |

## 快速启动( composer)

作曲家是Ensemble的文档作者身份和审查面. 其包装身份仍存 `@beyondwork/docx-react-component`。 。 。 .

```bash
pnpm add @beyondwork/docx-react-component react react-dom tailwindcss \
  prosemirror-commands prosemirror-keymap prosemirror-model prosemirror-state \
  prosemirror-tables prosemirror-transform prosemirror-view
```

```tsx
import "@beyondwork/docx-react-component/ui-tailwind/theme/editor-theme.css";
import { WordReviewEditor } from "@beyondwork/docx-react-component";

export function Review({ docx }: { docx: Uint8Array }) {
  return (
    <div style={{ height: "80vh" }}>
      <WordReviewEditor
        documentId="contract-1"
        currentUser={{ userId: "u1", displayName: "Taylor Shaw" }}
        initialDocx={docx}
      />
    </div>
  );
}
```

您的应用程序的 CSS 管道必须已经配置为 Tailwind v4 。 精确使用一个负载路径( E)`initialDocx`, (中文(简体) ), `initialSnapshot`, (中文(简体) ), `initialSessionState`, (中文(简体) ), `hostAdapter`,或 `datastore`);运行时间拥有会话从此开始.

## 下一个去哪里

| 没错 | 转到 |
| --- | --- |
| 做这行的人工智能特工 | [`/skills`](https://npmcn.com/package/%40beyondwork/docx-react-component/skills/) ——任务形操作指令 |
| 阅读详细指南 | [维基语录链接:名人名言](https://wiki.beyondwork.ai/) ——权威深度 |
| 正在寻找可运行代码 | [`/examples`](https://npmcn.com/package/%40beyondwork/docx-react-component/examples/) ——无铬取景器,无头工具栏,无头服务 |
| 操纵者工作( xlsx) | [`crates/`](https://npmcn.com/package/%40beyondwork/docx-react-component/crates/) 钙发动机和电网; [`docs/architecture.md`](https://npmcn.com/package/%40beyondwork/docx-react-component/docs/architecture.md) 覆盖两堆 |
| 捐款 | [`docs/contributing.md`](https://npmcn.com/package/%40beyondwork/docx-react-component/docs/contributing.md) |

## 工具/建造

在共享的 Ceobox 工作空间上继续编辑、搜索、格式化和小 元数据检查本地 。 将昂贵的汇编和测试食谱发送给 下方有合适的跑道 选择覆盖更改的最小检查; 为寄存器所需的门保留全套套房.

庄园管理的建设客户端安装于 `~/.local/bin/buildctl` 打开 Ceobox;它与多克·BuildKit的同名命令相分离. 没错 非此寄存器安装的依赖 。 先检查现场部署情况:

```sh
~/.local/bin/buildctl doctor
```

仅在客户端打开时使用以下示例 `PATH` 和所需的资源 配置文件已启用 。 已安装的运行本、配置合格结果和 工作空间/运行器库存在 `~/.local/share/agent-build/` (单位:千美元)`README.md`, (中文(简体) ), `ROLLOUT.md`, (中文(简体) ), `VALIDATION.md`, (中文(简体) ), `WORKSPACE-AUDIT.md`) (中文(简体) ). 在这个庄园外面,用 存储器的正常 CI 或明确提供跑道.

### 选择跑者

| 工作 | 路线 |
| --- | --- |
| 没有浏览器或办公室依赖关系的 Rust 计算/ OOXML 检查 | 管理 `rust-node`,在检查所需的工具链和输入后. |
| 浏览器、 渲染、 dev- server 和 abus 任务 | 通过 [`scripts/run-tool-workspace-command.sh`](https://npmcn.com/package/%40beyondwork/docx-react-component/scripts/run-tool-workspace-command.sh)。管理下浏览器适配器不合格. |
| 单词/Excel COM | 现有的Windows车队和COM包装;没有管理的Office适配器合格. |

例如,从这个工作树上放出一个范围拉斯特检查:

```sh
buildctl run --profile rust-node --lane ensemble-my-task -- \
  cargo test --locked -p sheets-engine
```

当前所管理的图像提供了Rust 1.97.1和Node 22.14.0. 一个不同的 工具链、浏览器依赖性或所需证书需求 专家跑道; 不更改测试以适应图像.

对于工具工作空间,使用现有的同步程序并核实准确性 在引用其包装之前正在测试源. `DOCX_TOOL_RUNNER_EXPECTED_HEAD` 仅检查 HEAD: 它不能证明肮脏的工作树内容是同步的 . 读取 [`word-evidence-tools`](https://npmcn.com/package/%40beyondwork/docx-react-component/skills/word-evidence-tools/SKILL.md) 联 合 国 命令特定的工作流程.

将Word/Excel COM改为: [视窗编队指南](https://npmcn.com/package/%40beyondwork/docx-react-component/skills/word-oracle-vm-fleet/SKILL.md) 相关 [单词](https://npmcn.com/package/%40beyondwork/docx-react-component/scripts/word-com-runner-wrapper.mjs) 或者说 [埃克塞尔](https://npmcn.com/package/%40beyondwork/docx-react-component/scripts/xlsx/excel-com-runner-wrapper.mjs) 包装 明确选择一个 核准时间档,确定所有权并使用跑者超时/清理规则. 不要假设对未处理的工作可使用包装器的默认槽; a 互动席位不是多余的建设能力.

### 从工作树上提交;保留结果

从您正在验证的工作树根中运行 。 管理下的划界案 抓取其 Git Head/ History, 索引, 舞台和未预演的更改, 无污名 未跟踪的文件和子模块. 初始化子模块于其被钉入的连接 提交前(`git submodule update --init --recursive`) (中文(简体) ). 编辑期间 抓取导致拒绝:完成编辑并重试。 宣告需要忽略输入 `--include relative/path`· ; 不包括全权证书。 需要外部投入和自定义的工具链包装 明确支持的映射,而不是沉默的替代.

提交 **整个外方食谱** 一项工作,包括先决条件安装 和儿童编译器。 保存编译器版本,功能,优化级别, 选定测试和独立的验证符执行 。 再次使用稳定的任务/路线 温暖缓存的名称。 将候选本地目标目录分开; 永远不会 将所有的工作树指向一个可变的货运目标目录.

`buildctl run` 提交和等待; `buildctl submit` 接受相同的工作选项 并返回一个工作身份。 用那个身份证:

```sh
buildctl status JOB_ID
buildctl logs JOB_ID
buildctl wait JOB_ID
buildctl cancel JOB_ID       # explicitly stop the job and its descendants
buildctl fetch JOB_ID        # retrieve declared artifacts and receipt
```

Ctrl-C 解析等待客户端; 它确实 **没有** 取消远程任务 . 报告后加 `--artifact @results` 在此之前 `--` 并写出食谱 改为 `/build-results` (亦作为 `BUILD_ARTIFACT_DIR`) (中文(简体) ). 获取创建新 目录 `~/.local/state/agent-build/results/JOB_ID/`· ; `--out` 必须名称 一个新的目的地。 它不覆盖编辑过的源 。 记录工作身份, 源修订,准确指令,退出状态和收到,并附有验证结果. 使用收件比较队列时间和执行时间; 不显示 未计量的食谱作为建设时间或吞吐量的保证.

### 资源和故障规则

管理 Linux 工作有执行内存, CPU, PID, 磁盘和最后期限限制 , 加上基于预订和东道方压力的接纳。 货物/测试货币 默认为当前 Rust/Node 工人的四; 这些线程计数不是 记忆边界. `doctor` 和已安装的 runbook 本身的当前容量.

如果任务队列、配置文件被禁用或资源限制被击中,请检查 状态和接收,更正输入或路由,并刻意重试。 别 在Ceobox上启动第二个无限制的建设,自动提出平行主义, 或留下背景重试循环。 保持抓取磁盘,只清理工作 你拥有。 直接SSH/ Docker 命令和现有的专家跑道可以绕行 管理服务;其限制和所有权规则仍然分开.

## 干这行的 特工从这里开始

按此顺序读取知识层. 每一个都比下一个便宜,大多数问题在到达底部之前都会得到回答.

| 读取 | 对于 | 费用 |
| --- | --- | --- |
| [`CLAUDE.md`](https://npmcn.com/package/%40beyondwork/docx-react-component/CLAUDE.md) 财务报告和审定财务报表 [`AGENTS.md`](https://npmcn.com/package/%40beyondwork/docx-react-component/AGENTS.md) | 政策与路线:工作如何在这里运行,犬科真理秩序,你是什么座位,切片如何降落 | 两个文件 |
| [`skills/`](https://npmcn.com/package/%40beyondwork/docx-react-component/skills/) | 任务形状指令. 将混凝土触发器匹配到一种技能并加载它;索引是 [`skills/README.md`](https://npmcn.com/package/%40beyondwork/docx-react-component/skills/README.md) | 一个文件 |
| [`docs/wiki/`](https://npmcn.com/package/%40beyondwork/docx-react-component/docs/wiki/) | 权威的详细指南——关于每一层的实际真实性. 特工通过MCP(`knowledge_overview` - > (中文) `knowledge_topic` - > (中文) `knowledge_files`(中文(简体) ) | 几页 |
| [`src/`](https://npmcn.com/package/%40beyondwork/docx-react-component/src/) | 最终授权。 当上面的地层不能解决问题时,请读一下 | 整个分系统 |

人类读取相同的维基百科内容 [维基语录链接:名人名言](https://wiki.beyondwork.ai/)它是为双方服务的一种指南,而不是人类文件的代理副本.

**真理流出一个方向.** 在作曲器中: OOXML 包字节 - > `CanonicalDocument` - > 运行时间派生状态 - > `EditorSurfaceSnapshot` - > ProseMirror - > DOM. (英语). 指挥者在其工作手册模型和帆布网格上反射同样的顺序. 每一层都可以投放或缓存其下方的东西;任何一层都不得发明权威. 读取 DOM 或 ProseMirror 状态作为内容,布局,几何,可编辑性的来源,或页面真实性是一个错误,而不是快捷键.

**这里的工作如何运行.** 课会无人出席,因此研究直到证据决定,而不是停止要求——只打断一些不安全的,不可逆的,或者真正无法从回购中回答的东西. 就你们自己收集的证据作出决定:进行测试、阅读资料来源、检查登记、测量。 在绿色处完成 —— 大门经过和更改打开 `pe2` ——因为"有道","有道","有道","有道","有道","有道"等州没有完成.

## 状况、执照、分支模式

Ensemble是一个Beyond Labs发行. 作曲家和指挥者在引入家庭身份的同时保留了他们现有的套件,API,和服务名. 见 [品牌指南](https://npmcn.com/package/%40beyondwork/docx-react-component/docs/brand/README.md)。 。 。 .

作曲家以 `@beyondwork/docx-react-component` 根据《超越工作使用许可证》(参见 [`LICENSE.md`](https://npmcn.com/package/%40beyondwork/docx-react-component/LICENSE.md)反应19和Tailwind v4是同伴依赖关系; `yjs`, (中文(简体) ), `y-prosemirror`,以及 `y-protocols` 仅是协作所需的可选同伴.

`main` 是内部已公布的投影 `pe2` 分支并有效只读; PRs 反对 `main` 将在下一个投影时结束;转而打开一个问题.

## 常见问题

### @beyondwork/docx-react-component 是什么？

嵌入可回放的Word\(docx\)编辑器,并附有评论,评论,跟踪变化,和圆通OOXML忠心\.

### 如何安装 @beyondwork/docx-react-component？

在项目目录运行 npm install @beyondwork/docx-react-component，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（^19\.2\.0）、react-dom（^19\.2\.0）、tailwindcss（^4\.2\.2）、prosemirror-view（^1\.41\.7）、prosemirror-model（^1\.25\.4）、prosemirror-state（^1\.4\.4）、prosemirror-keymap（^1\.2\.3）、prosemirror-tables（^1\.8\.5）、prosemirror-commands（^1\.7\.1）、prosemirror-transform（^1\.11\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @beyondwork/docx-react-component 支持 TypeScript 吗？

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

### @beyondwork/docx-react-component 支持 ESM 还是 CommonJS？

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

### @beyondwork/docx-react-component 可以商用吗？

@beyondwork/docx-react-component 使用 SEE LICENSE IN LICENSE\.md 许可。许可条款写在包内的独立文件中，请阅读该文件确认可否商用。以上为概括，不构成法律意见，请以许可原文为准。

### @beyondwork/docx-react-component 的下载量有多少？

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

### @beyondwork/docx-react-component 还在维护吗？

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

