activepieces
, which has a method called configure
that you should call after the container has been rendered.
async
or defer
attributes.configure
returns a promise which is resolved after authentication is done.Parameter Name | Required | Type | Description |
---|---|---|---|
instanceUrl | ✅ | string | The url of the instance hosting Activepieces, could be https://cloud.activepieces.com if you are a cloud user. |
jwtToken | ✅ | string | The jwt token you generated to authenticate your users to Activepieces. |
prefix | ❌ | string | Some customers have an embedding prefix, like this <embedding_url_prefix>/<Activepieces_url> . For example if the prefix is /automation and the Activepieces url is /flows the full url would be /automation/flows . |
embedding.containerId | ❌ | string | The html element’s id that is going to be containing Activepieces’s iframe. |
embedding.builder.disableNavigation | ❌ | boolean | “keep_home_button_only” | Hides the folder name, home button (if not set to “keep_home_button_only”) and delete option in the builder, by default it is false. |
embedding.builder.hideFlowName | ❌ | boolean | Hides the flow name and flow actions dropdown in the builder’s header, by default it is false. |
embedding.builder.homeButtonClickedHandler | ❌ | ()=>void | Callback that stops home button from navigating to dashboard and overrides it with this handler (added in 0.4.0) |
embedding.builder.homeButtonIcon | ❌ | ‘logo’ | ‘back’ | if set to ‘back’ the tooltip shown on hovering the home button is removed (added in 0.5.0) |
embedding.dashboard.hideSidebar | ❌ | boolean | Controls the visibility of the sidebar in the dashboard, by default it is false. |
embedding.dashboard.hideFlowsPageNavbar | ❌ | boolean | Controls the visibility of the navbar showing flows,issues and runs above the flows table in the dashboard, by default it is false. (added in 0.6.0) |
embedding.dashboard.hideSettings | ❌ | boolean | Controls the visibility of settings button next to the home button in the sidebar, by default it is false. (added in 0.7.0) |
embedding.hideFolders | ❌ | boolean | Hides all things related to folders in both the flows table and builder by default it is false. |
embedding.styling.fontUrl | ❌ | string | The url of the font to be used in the embedding, by default it is https://fonts.googleapis.com/css2?family=Roboto:wght@300;400;500;700&display=swap . |
embedding.styling.fontFamily | ❌ | string | The font family to be used in the embedding, by default it is Roboto . |
embedding.styling.mode | ❌ | ‘light’ | ‘dark’ | Controls light/dark mode (added in 0.5.0) |
embedding.hideExportAndImportFlow | ❌ | boolean | Hides the option to export or import flows (added in 0.4.0) |
embedding.hideDuplicateFlow | ❌ | boolean | Hides the option to duplicate a flow (added in 0.5.0) |
embedding.locale | ❌ | ‘en’ | ‘nl’ | ‘it’ | ‘de’ | ‘fr’ | ‘bg’ | ‘uk’ | ‘hu’ | ‘es’ | ‘ja’ | ‘id’ | ‘vi’ | ‘zh’ | ‘pt’ | it takes ISO 639-1 locale codes (added in 0.5.0) |
navigation.handler | ❌ | ({route:string}) => void | This callback will be triggered each time a route in Activepieces changes, you can read more about it here |
fontUrl
and fontFamily
properties.
If you only set one of them, the default font will be used.
The default font is Roboto
.
The font weights we use are the default font-weights from tailwind.