@anvilco/react-signature-frame

中文文档
1.9.2发布于 2025/10/31MITTypeScriptCommonJS零依赖近 30 天下载 9826

嵌入式 Etch 签名的 AnvilSignatureFrame 反应组件

中文使用文档
文档目录17 节
  1. 安维尔是什么?
  2. 使用量
  3. 道具
  4. 签名
  5. 滚动
  6. 登录
  7. 完成签名
  8. 错误
  9. 完成( 过期)
  10. 启用默认
  11. iframewarning 方案
  12. 样式
  13. Anvil Etch 电子签名文件
  14. 链接 QQ
  15. 页:1
  16. 错误
  17. 问题或反馈

(已删除) AnvilSignalFrame

允许您嵌入的最小组件 电子签名 在您的应用程序中 iframe。它将通过签名过程生命周期的回调方式向您提供信息.

见 现场演示 和开源 演示仓库 以用法为例.

image

安维尔是什么?

安维尔 为所有文件提供方便的API.

  1. PDF 填补 API - 填写一个PDF模板,其中包含网络请求和结构化的JSON数据.
  2. PDF 生成 API - 发送标记下来或HTML和Anvil会把它变成PDF.
  3. Etch 带有 API 的 E 签名 - 可自定义的、可嵌入的、带有API的电子签名平台,以控制签名过程的端到端.
  4. 工作流量(w/ API) - Webforms + PDF + E- sign 带有强大的无码构建器. 轻松地收集结构化数据,生成PDF,并请求签名.

学着点 Anvil 开发者页面。 。 。 .

使用量

yarn add @anvilco/react-signature-frame
npm install @anvilco/react-signature-frame
import AnvilSignatureFrame from '@anvilco/react-signature-frame'

<AnvilSignatureFrame
  signURL={signURL}
  scroll="smooth"
  onLoad={() => setLoading(true)}
  onFinishSigning={(payload) => console.log(payload)}
  onError={(errorPayload) => console.log(errorPayload)}
/>

道具

签名

字符串( 需要) - 从该数据库生成的Anvil签名页面的URL generateEtchSignURL 图QL 变异。签名框将通过此 URL 显示签名页面.

示例

signURL={`https://app.useanvil.com/etch/8iJDbq8dkEmjrsNw7Dnb/sign?token=dsa...`}

滚动

字符串 qq 无效 - 可选滚动到签名框

  • auto - 将窗口滚动到挂载时的签名框
  • smooth - 安装时将窗口顺利地滚动到签名框
  • null - 禁用滚动

登录

函数 - 当签名页面装入完成时,此函数被调用 .

示例

onLoad={() => setLoading(false)}

完成签名

函数 - 调用函数 payload 作为参数。 当一个用户成功完成签名时,它就会被调用 .

示例

onFinishSigning={(payload) => console.log(payload)}

/*
{
  action: "signerComplete",
  signerEid: "kJzR6mcIWKoZs6KOxV4w",
  signerStatus: "completed",
  nextSignerEid: "HRLhx4khticpfxsUFSpj",
  documentGroupEid: "9fQnvfy51p7oKrEYajMh",
  documentGroupStatus: "partial",
  etchPacketEid: "J1phQTO6WQH6gZcMJAG5", // If from an EtchPacket
  weldDataEid: "J1phQTO6WQH6gZcMJAG5", // If from a workflow
}
*/

错误

函数 - 有特定错误的召回功能 payload 作为参数。 当用户在尝试签名时遇到错误时,它被称作. 详情见文件 如何从错误中恢复。 。 。 .

示例

onError={(payload) => console.log(payload)}

/*
{
  action: "signerError",
  errorType: "tokenExpired", tokenExpired || tokenInvalid || notFound
  error: "Token Expired",
  message: "Error specific message",
  signerEid: "kJzR6mcIWKoZs6KOxV4w",

  // depending on the errorType, you may or may not receive the following
  signerStatus: "sent",
  nextSignerEid: "HRLhx4khticpfxsUFSpj",
  documentGroupEid: "9fQnvfy51p7oKrEYajMh",
  documentGroupStatus: "sent",
  etchPacketEid: "J1phQTO6WQH6gZcMJAG5", // If from an EtchPacket
  weldDataEid: "J1phQTO6WQH6gZcMJAG5", // If from a workflow
}
*/

完成( 过期)

函数 - 这个函数将具有 redirectURL 作为参数; 当用户完成签名或体验和出错时调用。 请使用 onFinishSigning 财务报告和审定财务报表 onError 见上文.

示例

onFinish={(redirectURL) => console.log(redirectURL)}

启用默认

布尔( 默认: 真) - 设定为假以禁用组件的默认内行样式.

iframewarning 方案

对象 - 如果用户的浏览器不支持iframes,将自定义道具传入显示的段落标记.

示例

iframeWarningProps={{ className: 'warning-text' }}

样式

通过禁用自定义组件 enableDefaultStyles 并导入 CSS 或通过内置样式。 将ID或类名通过作为道具传递来取代.

Anvil Etch 电子签名文件

阅读文档

页:1

  • 要启用 Iframe 嵌入: 请访问您在 Anvil 中的组织设置, 并启用 API 部分的 “ Iframe Embedding ” .
  • 反应 QQ v16.0 需要.

错误

请为错误、 缺少文档或意外行为存档 .

问题或反馈

请发电子邮件给我们 支持@useanvil.com。 。 。 .

版本与发布记录

@anvilco/react-signature-frame 共发布 17 个版本,首次发布于 2020/11/13;过去 12 个月发布了 0 个版本。

版本发布日期距今
1.9.2latest2025/10/311 年前
1.9.02024/05/032 年前
1.8.32022/10/064 年前
1.8.22022/05/264 年前
1.8.12022/04/194 年前
1.8.02022/04/194 年前

关于 @anvilco/react-signature-frame 的常见问题

@anvilco/react-signature-frame 是什么?

嵌入式 Etch 签名的 AnvilSignatureFrame 反应组件

如何安装 @anvilco/react-signature-frame?

在项目目录运行 npm install @anvilco/react-signature-frame,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:react(>=16)、react-dom(>=16)、prop-types(^15.6.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@anvilco/react-signature-frame 支持 TypeScript 吗?

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

@anvilco/react-signature-frame 支持 ESM 还是 CommonJS?

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

@anvilco/react-signature-frame 可以商用吗?

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

@anvilco/react-signature-frame 的下载量有多少?

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

@anvilco/react-signature-frame 还在维护吗?

最新版本 1.9.2 发布于 2025/10/31(1 年前);至今共发布 17 个版本,其中过去 12 个月发布了 0 个;首次发布于 2020/11/13。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。