Introduction

Options are optional parameters that you can pass to some hotglue functions in React and Javascript. You can use options to fit many unique use cases, including modifying widget functionality and appearance, adding listeners, and filtering visible connectors.

Customizing appearance and text

breadcrumbs

• Type: Boolean
• Description: Enables or disables the usage of breadcrumbs in the widget interface.

{"breadcrumbs": false}

helperText

• Type: String
• Description: Overrides the helper text on the connection screen of the widget. Markdown is supported.

{"helperText": "Need help? [Read our docs](https://docs.hotglue.com/)"}

hideBackButtons

• Type: Boolean
• Description: Allows hiding of the 'Back' buttons on the widget interface.

{"hideBackButtons": true}

localization

• Type: Object
• Description: Provides locale-specific strings to customize the widget for different regions or languages.

Guiding user behavior and configuration

demo

• Type: Boolean
• Description: Launches the widget in a demo mode that disables linking or unlinking.

jwtToken

• Type: String
• Description: JWT token created with your private signing key

nextStep

• Type: String
• Description: Determines the next widget screen to be shown after a tenant successfully links.

multipleSources

• Type: Boolean
• Description: Lets users link multiple sources within the widget, in one-way flows.

multipleConnectors

• Type: Boolean
• Description: Lets users link multiple connectors in the widget, in two-way flows.

tenantMetadata

• Type: Object
• Description: Adds additional metadata related to the tenant using key-value pairs.

schemas

• Type: Object
• Description: Enables a mapping UI in the widget to map your customers' custom fields to your system.

flowFilter

• Type: String
• Description: Applies a filter to only display specific flows.

listener

• Type: Function
• Description: Defines a callback function that will respond to events from the widget.

flow

• Type: String
• Description: Jumps to a predefined flow when using hotglue.open().