Installing the Widget

Preparing to integrate the widget into your app

Installing the Squid Widget

Prerequisites

Before installing the Squid Widget, ensure you have:

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

2. Node.js and npm (or yarn) installed on your system.

Getting an Integrator ID

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

1. Complete the Integrator ID request form.

2. You will receive your Integrator ID via email.

Installation

Step 1: Install the package

Install the Squid Widget npm package using one of the following commands:

Using npm:

npm install @0xsquid/widget@^3.0.10

Using yarn:

yarn add @0xsquid/widget@^3.0.10

Step 2: Update dependencies (if necessary)

Squid v2.0 uses Wagmi v2 and ethers v6. If you have these packages in your project, update them:

yarn add wagmi@^2.12.8 ethers@^6

For more information on upgrading Wagmi, refer to the official Wagmi upgrade guide.

Next Steps

After installation, you'll need to integrate the widget into your project. We provide specific guides for different frameworks:

• React Integration Guide

• NextJS Integration Guide

• Vite Integration Guide

• iFrame Integration Guide

Choose the guide that matches your project's setup.

Support

If you have any questions or need assistance, please join our Discord server and post in the #⛛│developers channel.

Breaking Changes

Be aware that Squid v2.0 introduces several breaking changes, including:

• Updated API URL(apiplus)

• Renamed and removed properties

• New theming system

Refer to our Migration Guide for detailed information on these changes and how to adapt your integration.