Installing the Widget

Preparing to integrate the Deposit Widget into your app

Installing the Squid Deposit Widget

Prerequisites

Before installing the Deposit Widget, ensure you have:

  1. Registered for an Integrator ID with the Squid Team.

  2. Node.js and a package manager (npm, yarn or pnpm) installed.

  3. A React 18 or React 19 app to host the widget.

Getting an Integrator ID

To use the Deposit Widget, you need to register for an Integrator ID:

  1. You will receive your Integrator ID via email.

Installation

Step 1: Install the package

Using npm:

npm install @0xsquid/deposit-widget

Using yarn:

Step 2: Provide React 18+ in your app

The widget declares react and react-dom (^18 || ^19) as peer dependencies — make sure your app satisfies one of these versions.

Next Steps

After installation, follow the framework-specific guide:

Once the widget is rendered, head to Configuration to customize destination, branding and theme.

Support

When you receive your Integrator ID, we'll follow up by email to set up a dedicated Telegram group with your team. That group is your direct line to the Squid team for any questions or assistance during integration.

Last updated