嵌入 Builder

本文档说明如何将 Activepieces iframe 嵌入到您的应用程序中并进行自定义。

配置 SDK

添加嵌入 SDK 脚本将在您的 window 中初始化一个名为 activepieces 的对象,该对象有一个 configure 方法,您应在容器渲染完成后调用它。

以下脚本不应包含 `async` 或 `defer` 属性。 这些步骤假设您已从后端生成了 JWT 令牌。如果没有,请查看[配置用户](/docs/activepieces/embedding/provision-users)页面。
<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>
`configure` 返回一个 promise,在身份验证完成后 resolve。 请查看[导航](/docs/activepieces/embedding/navigation)部分,了解导航工作原理以及如何提供自动同步体验非常重要。

配置参数:

参数名称必需类型描述
instanceUrlstring托管 Activepieces 的实例 URL,如果您是云用户,可以是 https://cloud.activepieces.com
jwtTokenstring您生成的用于向 Activepieces 验证用户身份的 JWT 令牌。
prefixstring部分客户有嵌入前缀,格式为 <embedding_url_prefix>/<Activepieces_url>。例如,如果前缀是 /automation,Activepieces URL 是 /flows,则完整 URL 为 /automation/flows
embedding.containerIdstring将包含 Activepieces iframe 的 HTML 元素 ID。
embedding.builder.disableNavigationboolean | keep_home_button_only隐藏 Builder 中的文件夹名称、首页按钮(如果未设置为 keep_home_button_only)和删除选项,默认为 false。
embedding.builder.hideFlowNameboolean隐藏 Builder 头部的工作流名称和工作流操作下拉菜单,默认为 false。
embedding.builder.homeButtonClickedHandler()=>void阻止首页按钮导航到控制面板并用此处理程序覆盖的回调(从 0.4.0 版本添加)。
embedding.builder.homeButtonIconlogo | back如果设置为 back,将移除悬停在首页按钮上时显示的工具提示(从 0.5.0 版本添加)。
embedding.dashboard.hideSidebarboolean控制控制面板中侧边栏的可见性,默认为 false。
embedding.dashboard.hideFlowsPageNavbarboolean控制控制面板中工作流表格上方显示工作流、问题和运行记录导航栏的可见性,默认为 false。(从 0.6.0 版本添加)。
embedding.dashboard.hidePageHeaderboolean隐藏控制面板中的页面标题,默认为 false。(从 0.8.0 版本添加)。
embedding.hideFoldersboolean隐藏工作流表格和 Builder 中所有与文件夹相关的内容,默认为 false。
embedding.hideTablesboolean隐藏控制面板中的表格 UI(树形视图、筛选器、创建/导入按钮)并阻止直接访问表格编辑器路由。工作流中使用的 Tables Piece 不受影响。默认为 false。(从 0.9.0 版本添加)。
embedding.styling.fontUrlstring嵌入中使用的字体 URL,默认为 https://fonts.googleapis.com/css2?family=Roboto:wght@300;400;500;700&display=swap
embedding.styling.fontFamilystring嵌入中使用的字体系列,默认为 Roboto
embedding.styling.modelight | dark控制亮色/暗色模式(从 0.5.0 版本添加)。
embedding.hideExportAndImportFlowboolean隐藏导出或导入工作流的选项(从 0.4.0 版本添加)。
embedding.hideDuplicateFlowboolean隐藏复制工作流的选项(从 0.5.0 版本添加)。
embedding.localeen | nl | de | fr | es | ja | zh | pt | zh-TW | ru接受 ISO 639-1 语言代码(从 0.5.0 版本添加)。
navigation.handler({route:string}) => void每次 Activepieces 中的路由发生变化时触发的回调,您可以在此了解更多信息。
要加载字体,您需要同时设置 `fontUrl` 和 `fontFamily` 属性。 如果只设置其中一个,将使用默认字体。 默认字体为 `Roboto`。 我们使用的字体权重是 [tailwind](https://tailwindcss.com/docs/font-weight) 的默认字体权重。