嵌入 Builder
本文档说明如何将 Activepieces iframe 嵌入到您的应用程序中并进行自定义。
配置 SDK
添加嵌入 SDK 脚本将在您的 window 中初始化一个名为 activepieces 的对象,该对象有一个 configure 方法,您应在容器渲染完成后调用它。
<script src="https://cdn.activepieces.com/sdk/embed/0.9.0.js">
</script>
<script>
const instanceUrl = 'YOUR_INSTANCE_URL';
const jwtToken = 'GENERATED_JWT_TOKEN';
const containerId = 'YOUR_CONTAINER_ID';
activepieces.configure({
instanceUrl,
jwtToken,
prefix: "/",
embedding: {
containerId,
builder: {
disableNavigation: false,
hideFlowName: false
},
dashboard: {
hideSidebar: false
},
hideFolders: false,
navigation: {
handler: ({ route }) => {
// iframe 路由已更改,请务必查看导航部分。
}
}
},
});
</script>
配置参数:
| 参数名称 | 必需 | 类型 | 描述 |
|---|---|---|---|
| instanceUrl | ✅ | string | 托管 Activepieces 的实例 URL,如果您是云用户,可以是 https://cloud.activepieces.com。 |
| jwtToken | ✅ | string | 您生成的用于向 Activepieces 验证用户身份的 JWT 令牌。 |
| prefix | ❌ | string | 部分客户有嵌入前缀,格式为 <embedding_url_prefix>/<Activepieces_url>。例如,如果前缀是 /automation,Activepieces URL 是 /flows,则完整 URL 为 /automation/flows。 |
| embedding.containerId | ❌ | string | 将包含 Activepieces iframe 的 HTML 元素 ID。 |
| embedding.builder.disableNavigation | ❌ | boolean | keep_home_button_only | 隐藏 Builder 中的文件夹名称、首页按钮(如果未设置为 keep_home_button_only)和删除选项,默认为 false。 |
| embedding.builder.hideFlowName | ❌ | boolean | 隐藏 Builder 头部的工作流名称和工作流操作下拉菜单,默认为 false。 |
| embedding.builder.homeButtonClickedHandler | ❌ | ()=>void | 阻止首页按钮导航到控制面板并用此处理程序覆盖的回调(从 0.4.0 版本添加)。 |
| embedding.builder.homeButtonIcon | ❌ | logo | back | 如果设置为 back,将移除悬停在首页按钮上时显示的工具提示(从 0.5.0 版本添加)。 |
| embedding.dashboard.hideSidebar | ❌ | boolean | 控制控制面板中侧边栏的可见性,默认为 false。 |
| embedding.dashboard.hideFlowsPageNavbar | ❌ | boolean | 控制控制面板中工作流表格上方显示工作流、问题和运行记录导航栏的可见性,默认为 false。(从 0.6.0 版本添加)。 |
| embedding.dashboard.hidePageHeader | ❌ | boolean | 隐藏控制面板中的页面标题,默认为 false。(从 0.8.0 版本添加)。 |
| embedding.hideFolders | ❌ | boolean | 隐藏工作流表格和 Builder 中所有与文件夹相关的内容,默认为 false。 |
| embedding.hideTables | ❌ | boolean | 隐藏控制面板中的表格 UI(树形视图、筛选器、创建/导入按钮)并阻止直接访问表格编辑器路由。工作流中使用的 Tables Piece 不受影响。默认为 false。(从 0.9.0 版本添加)。 |
| embedding.styling.fontUrl | ❌ | string | 嵌入中使用的字体 URL,默认为 https://fonts.googleapis.com/css2?family=Roboto:wght@300;400;500;700&display=swap。 |
| embedding.styling.fontFamily | ❌ | string | 嵌入中使用的字体系列,默认为 Roboto。 |
| embedding.styling.mode | ❌ | light | dark | 控制亮色/暗色模式(从 0.5.0 版本添加)。 |
| embedding.hideExportAndImportFlow | ❌ | boolean | 隐藏导出或导入工作流的选项(从 0.4.0 版本添加)。 |
| embedding.hideDuplicateFlow | ❌ | boolean | 隐藏复制工作流的选项(从 0.5.0 版本添加)。 |
| embedding.locale | ❌ | en | nl | de | fr | es | ja | zh | pt | zh-TW | ru | 接受 ISO 639-1 语言代码(从 0.5.0 版本添加)。 |
| navigation.handler | ❌ | ({route:string}) => void | 每次 Activepieces 中的路由发生变化时触发的回调,您可以在此了解更多信息。 |