@castandcrew/document-signer-react

中文文档
3.0.14发布于 2026/10/26MITCommonJS近 30 天下载 4909

文档- 符号反应组件

中文使用文档
文档目录4 节
  1. 文档查看器
  2. 文档符号
  3. 文件完成时
  4. 移动文档纸

文档符号反应组件

@ castandcrew/ 文档签名器- 反应 国家防范机制组合提供以下反应部分:

文档查看器

导入 :

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

道具 :

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

文档符号

导入 :

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 规则的对象
类NameStringRoot HTML 元素的额外 CSS 类名称
文档Array<Object>从文档- Signer API 应用程序收到的文档对象矩阵
特性标记Array<String>启用的地物标记名称阵列
获取文档 图像Urlsfunc(documentId: UUID, page: Int)用于对特定文档页面进行图像折叠的函数
是文件一Boolfalse只有一个文件要签字吗? (我们要删除这个)
已保存签名Bool我们是否应该提出保留会议期间的签名?
иObject经认证的用户信息
提议Object提供信息
文件完成时func({ documentId, hasNextIncompleteDocument, continue })惟还相. 见 文件完成时
显示I9 注解Bool我们是否应该显示 I -9 文件的通知信息?
第一个引擎插入BooleanfalseStyledEngine 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(): 导航到后面的下一个不完整的文档,解决 若无,则不作任何事.

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

移动文档纸

导入 :

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

道具 :

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

版本与发布记录

@castandcrew/document-signer-react 共发布 84 个版本,首次发布于 2020/12/08;过去 12 个月发布了 42 个版本。

版本发布日期距今
3.0.14latest2026/10/2613 天前
3.0.132026/10/2119 天前
3.0.122026/10/2119 天前
3.0.112026/10/1327 天前
3.0.10-alpha.222026/09/261 个月前
3.0.10-alpha.212026/09/241 个月前

其他发布通道:alpha → 3.0.10-alpha.18。

关于 @castandcrew/document-signer-react 的常见问题

@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 和提交记录判断。