@anvilco/anvil-embed-frame

中文文档
2.2.2发布于 2025/10/31MITTypeScriptCommonJS零依赖近 30 天下载 18.3万

嵌入式Etch签名和Workflows的AnvilEmbedFrame React组件.

中文使用文档
文档目录12 节
  1. 安维尔是什么?
  2. 使用量
  3. 从v1升级到v2
  4. 道具
  5. 框架
  6. 活动
  7. 滚动
  8. 文本文档
  9. 页:1
  10. 错误
  11. 问题或反馈
  12. 许可证

Anvil-EmbedFrame (英语)

AnvilEmbedFrame 一个非常微小的反应组件,允许您嵌入 Anvil 电子签名, (中文(简体) ), 工作流量,以及 嵌入式构建器 输入您的应用程序 iframe。它将通过回调方式向您提供信息 onEvent。 。 。 .

见 Etch 电子符号 现场演示 和开源 演示仓库 用于使用此组件的嵌入式 Etch 电子符号使用示例.

安维尔是什么?

安维尔 为所有文件提供方便的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/anvil-embed-frame
npm install @anvilco/anvil-embed-frame
import AnvilEmbedFrame from '@anvilco/anvil-embed-frame'

<AnvilEmbedFrame
  iframeURL={etchSignURL || workflowURL || editorURL}
  onEvent={(eventObject) => console.log('Event object:', eventObject)}
  className="anvil-embed-frame"
  style={{ border: 'none' }}
/>

从v1升级到v2

从v2.0开始 enableDefaultStyles 道具已被移除 。 现在有了 没有 嵌入其中的默认样式 AnvilEmbedFrame,框架将使用默认浏览器 iframe 发型. 您可以用 CSS 来样式化 Iframe 并添加 className 财务报告和审定财务报表 style 组件道具

道具

框架

字符串( 需要) - 嵌入Anvil页面的URL. 对于Etch电子签名, 参考这些文件 用于生成签名 URL 的指令. 对于工作流, 参考这些文件 用于获取工作流程 URL 的指令.

示例

// Etch e-signatures
<AnvilEmbedFrame
  iframeURL="https://app.useanvil.com/api/etch/verify/QL3RjmpXWBD4W6YCHSLr?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzaWduZXJJZCI6MTg3LCJjbGllbnRVc2VySWQiOiJzaWduZXIxIiwiY3JlYXRlZEF0IjoxNjY0NTY4NTkyNTk0LCJleHRyYSI6IkNVQlIiLCJpYXQiOjE2NjQ1Njg1OTIsImV4cCI6MTY2NDY1NDk5Mn0.RMpoBXdAU5k6ozX3y2xoI8ykqx2BXycIKNX7Kq0EFFs"
/>

// For Workflows
<AnvilEmbedFrame
  iframeURL="https://app.useanvil.com/weld/my-org/my-workflow"
/>

活动

函数 - 当事件被触发时,此函数被调用 . 可能的活动类型 Etch 电子符号包括数字 : signerComplete, (中文(简体) ), signerError。 。 。 . 可能的活动类型 工作流程包括:数字 : forgeSubmitPage, (中文(简体) ), forgeComplete, (中文(简体) ), weldComplete。 。 。 .

默认为 (eventObject) => {}

滚动

字符串 - 把卷轴放入框架

  • auto - 挂载时将窗口滚动到 iframe
  • smooth 挂载时将窗口顺利滚动到 iframe
  • null - 禁用滚动

文本文档

页:1

  • 要启用 Iframe 嵌入, 请访问您在 Anvil 中的组织设置, 在 API 部分启用 “ Iframe Embedding ” .
  • 请联系我们 支持@useanvil.com 使框架能够嵌入我们 嵌入式构建器 UIS: PDF 模板构建器, 电子签名包构建器, 或 Workflow 构建器 .
  • 反应 QQ v16.0 需要.

错误

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

问题或反馈

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

许可证

麻省理工学院

版本与发布记录

@anvilco/anvil-embed-frame 共发布 7 个版本,首次发布于 2022/10/06;过去 12 个月发布了 0 个版本。

版本发布日期距今
2.2.2latest2025/10/311 年前
2.2.02024/05/032 年前
2.1.12024/04/182 年前
2.1.02024/04/182 年前
2.0.02023/09/213 年前
2.0.0-alpha.02023/09/193 年前

关于 @anvilco/anvil-embed-frame 的常见问题

@anvilco/anvil-embed-frame 是什么?

嵌入式Etch签名和Workflows的AnvilEmbedFrame React组件.

如何安装 @anvilco/anvil-embed-frame?

在项目目录运行 npm install @anvilco/anvil-embed-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/anvil-embed-frame 支持 TypeScript 吗?

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

@anvilco/anvil-embed-frame 支持 ESM 还是 CommonJS?

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

@anvilco/anvil-embed-frame 可以商用吗?

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

@anvilco/anvil-embed-frame 的下载量有多少?

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

@anvilco/anvil-embed-frame 还在维护吗?

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