# @castandcrew/document-signer-react 中文文档

规范地址：https://npmcn.com/package/%40castandcrew/document-signer-react/

版本：3\.0\.14
npm 元数据更新时间：2026-11-05T18:31:34.461Z
中文译文更新时间：2026-11-09T06:27:57.580Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40castandcrew/document-signer-react
原文对照：https://npmcn.com/package/%40castandcrew/document-signer-react/?lang=original
项目主页：https://github.com/cast-and-crew/document-signer-react
源码仓库：https://github.com/cast-and-crew/document-signer-react

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

- 包体积（解压后）：30.4 MB，430 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- 运行依赖：10 个
- peer 依赖：react ^17\.0\.0 \|\| ^18\.0\.0 \|\| ^19\.0\.0，react-dom ^17\.0\.0 \|\| ^18\.0\.0 \|\| ^19\.0\.0，@mui/styles ^5\.16\.14，@mui/system ^5\.16\.14，@mui/material ^5\.16\.14，react-router-dom ^6\.25\.1，@mui/icons-material ^5\.16\.14
- 首次发布：2020-12-07T20:01:15.568Z
- 最新版本发布：2026-10-26T15:36:03.056Z
- 近 30 天下载量：4909（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：84（近 12 个月 42 个）

## 中文简介

文档- 符号反应组件

## 安装

```sh
npm install @castandcrew/document-signer-react
```

也可以使用：`pnpm add @castandcrew/document-signer-react`、`yarn add @castandcrew/document-signer-react`、`bun add @castandcrew/document-signer-react`

## README

# 文档符号反应组件

[@ castandcrew/ 文档签名器- 反应](https://www.npmjs.com/package/@castandcrew/document-signer-react) 国家防范机制组合提供以下反应部分:

-   [文档查看器](https://npmcn.com/package/%40castandcrew/document-signer-react/#readme-documentviewer)
-   [文档符号](https://npmcn.com/package/%40castandcrew/document-signer-react/#readme-documentsigner)
-   [移动文档纸](https://npmcn.com/package/%40castandcrew/document-signer-react/#readme-mobiledocumentpane)

## 文档查看器

导入 :

```javascript
import DocumentViewer from '@castandcrew/document-signer-react/DocumentViewer';
or;
import { DocumentViewer } from '@castandcrew/document-signer-react';
```

道具 :

| 名称 | 类型 | 默认 | 说明 |
| :-- | :-- | :-- | :-- |
| 动作窗口 | `ActionBar.props` |  | 行动 边框组件属性 |
| 动作按钮 | `Array<React.Component>` |  | 行动 按钮 |
| 活动RoleId |  | `null` |  |
| 活动规则组d |  | `null` |  |
| 类 | `Object` |  |  |
| 类Name | `String` |  |  |
| 当前文档 | `Object` |  |  |
| 文档映射模式 | `Boolean` | `false` |  |
| 获取文档 图像Urls | `func(documentId: String, page: Integer)` |  |  |
| 转到外地 | `func(String)` |  |  |
| 下一个文件 | `String` |  |  |
| 预览文件 | `String` |  |  |
| 变成字段 | `func(Object)` |  |  |
| 设置当前文档 | `func(String)` |  |  |
| 侧边栏 | `React.Component` |  |  |
| 丢入 Fatal 错误 | `func` |  | 致命错误处理器 |
| 带Sidebar | `Boolean` | `false` | 侧边栏? |
| 所选文件 | “箭头” | \[ |  |
| 预览文件 | `Boolean` | 虚假 |  |

## 文档符号

导入 :

```javascript
import DocumentSigner from '@castandcrew/document-signer-react/DocumentSigner';
or;
import { DocumentSigner } from '@castandcrew/document-signer-react';
```

道具 :

| 名称 | 类型 | 默认 | 说明 |
| :-- | :-- | :-- | :-- |
| 动作 | `{ submit?: Action, cancel?: Action, save?: Action }` |  | 动作对象定义为 `{ text: String, action: func(docs: [Object])}` |
| 演员 | `{ name: String, initials: String }` |  | 文档代理数据 |
| 可证明操作 | `Boolean` |  | 演员能批准提议吗? (我们要删除这个) |
| 类 | `{ root?: CSSObject, busyOverlay?: CSSObject, busyContainer?: CSSObject, documentSelector?: CSSObject, documentViewer?: CSSObject }` |  | CSS Object 是定义 CSS 规则的对象 |
| 类Name | `String` |  | Root HTML 元素的额外 CSS 类名称 |
| 文档 | `Array<Object>` |  | 从文档- Signer API 应用程序收到的文档对象矩阵 |
| 特性标记 | `Array<String>` |  | 启用的地物标记名称阵列 |
| 获取文档 图像Urls | `func(documentId: UUID, page: Int)` |  | 用于对特定文档页面进行图像折叠的函数 |
| 是文件一 | `Bool` | `false` | 只有一个文件要签字吗? (我们要删除这个) |
| 已保存签名 | `Bool` |  | 我们是否应该提出保留会议期间的签名? |
| и | `Object` |  | 经认证的用户信息 |
| 提议 | `Object` |  | 提供信息 |
| 文件完成时 | `func({ documentId, hasNextIncompleteDocument, continue })` |  | 惟还相. 见 [文件完成时](https://npmcn.com/package/%40castandcrew/document-signer-react/#readme-ondocumentcomplete) |
| 显示I9 注解 | `Bool` |  | 我们是否应该显示 I -9 文件的通知信息? |
| 第一个引擎插入 | `Boolean` | `false` | StyledEngine Provider应首先注入CSS吗? |
| 模板 知识说明 | `String` |  | 致谢说明 |
| 模板 知识题 | `String` |  | 鸣谢标题 |
| 丢入 Fatal 错误 | `func(message: String)` |  | 致命错误处理器 |

仅用于还原的道具( R)`DocumentSigner.reskin`:

| 名称 | 类型 | 默认 | 说明 |
| :-- | :-- | :-- | :-- |
| 待审查文件 | `Array<String | Number>` | `[]` | 文件在签字人外等待审查。 它们显示"格式不完整"并带有警告图标,并禁用提交按钮. |
| 渲染文档库 | `func(currentDocument: Object) => Node` |  | 在当前文档的页面图像上显示的内容, 例如提醒 。 返回时 `null` 没有旗帜. |

### 文件完成时

可选的桌面后皮( T)`DocumentSigner.reskin`仅此而已。 每次打一次电话 文档变得完整和有效(所有需要填入的字段,没有文档或 字段出错,不待审查). 重新打开或重新编辑已经完整的文档不调用 ; 只有在文档不完整或无效时才再次调用 然后再次完成。 有效载荷是:

-   `documentId`: 已完成的文件编号.
-   `hasNextIncompleteDocument`:文件是否不完整.
-   `continue()`: 导航到后面的下一个不完整的文档,解决 若无,则不作任何事.

当提供这种道具时,内置成功通知没有显示,所以 消费者对自己的通知负责。 错误和保存通知为 不变。 没有它,签名者的行为就像以前.

## 移动文档纸

导入 :

```javascript
import MobileDocumentPane from '@castandcrew/document-signer-react/MobileDocumentPane';
or;
import { MobileDocumentPane } from '@castandcrew/document-signer-react';
```

道具 :

| 名称 | 类型 | 默认 | 说明 |
| :-- | :-- | :-- | :-- |
| 演员 | `Object` |  |  |
| 类Name | `String` |  |  |
| 自动符号 | `Boolean` |  |  |
| 变化输入 | `func(inputId, value)` |  |  |
| 双点 | `func(Event)` |  |  |
| 焦点输入 | `func(inputId)` |  |  |
| 需求页面 | `func(pageIndex)` |  |  |
| 页面错误 | `func(index, error, tryCount)` |  |  |
| 页面高度 | `Integer` |  |  |
| 页次 | `Integer` |  |  |
| 页面窗口 | `Integer` |  |  |
| 滚动容器 | `HTMLElement` |  |  |
| 选中输入 | `String` |  |  |
| 缩放 | `Integer` |  |  |

## 常见问题

### @castandcrew/document-signer-react 是什么？

文档- 符号反应组件

### 如何安装 @castandcrew/document-signer-react？

在项目目录运行 npm install @castandcrew/document-signer-react，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（^17\.0\.0 \|\| ^18\.0\.0 \|\| ^19\.0\.0）、react-dom（^17\.0\.0 \|\| ^18\.0\.0 \|\| ^19\.0\.0）、@mui/styles（^5\.16\.14）、@mui/system（^5\.16\.14）、@mui/material（^5\.16\.14）、react-router-dom（^6\.25\.1）、@mui/icons-material（^5\.16\.14）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @castandcrew/document-signer-react 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/castandcrew\_\_document-signer-react 是否存在。

### @castandcrew/document-signer-react 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @castandcrew/document-signer-react 可以商用吗？

@castandcrew/document-signer-react 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @castandcrew/document-signer-react 的下载量有多少？

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

### @castandcrew/document-signer-react 还在维护吗？

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