React + Vite

This guide will walk you through the process of integrating the Capsule Modal into a Vite-powered React application, providing a seamless way to manage user authentication and wallets.

If you haven’t already created a new Vite project, you can follow the official Vite docs to get started. Alternatively, you can fork our minimal starter that already includes the Capsule Modal setup: Capsule Vite Starter.

​

Prerequisites

To use Capsule, you need an API key. This key authenticates your requests to Capsule services and is essential for integration.

​

Installing Dependencies

First, install the Capsule React SDK using your preferred package manager:

​

Setting Up Polyfills with Vite

Some Node.js modules that Capsule relies on (e.g., crypto, buffer, stream) may need to be polyfilled in a Vite environment. One easy option is to use vite-plugin-node-polyfills:

import { defineConfig } from "vite";
import react from "@vitejs/plugin-react";
import { nodePolyfills } from "vite-plugin-node-polyfills";

export default defineConfig({
  plugins: [
    react(),
    nodePolyfills({
      // Whether to polyfill `global`, `process`, and `Buffer`.
      // By default, all are true.
      protocolImports: true,
    }),
  ],
  // Additional Vite configurations if needed
});

This ensures Node-specific modules are properly polyfilled in the browser environment.

​

Setting Up the Capsule SDK

Now that you’ve installed the necessary dependencies, let’s set up the Capsule SDK in your Vite project. This involves creating a client instance.

​

Creating a Capsule Client Instance

You can create the Capsule client instance in a dedicated file, such as clients/capsule.tsx, or as part of your state management logic. Below is a basic example:

import Capsule, { Environment } from "@usecapsule/react-sdk";

const capsule = new Capsule(Environment.BETA, process.env.NEXT_PUBLIC_CAPSULE_API_KEY);

export default capsule;

This step initializes the Capsule SDK with your API key and the chosen environment. If successful, you should see the Capsule instance logged in your console (if you choose to console.log it).

​

Integrating the Capsule Modal

Integrate the Capsule Modal into your React component by importing the CapsuleModal component from the Capsule SDK, adding a button to trigger the modal, and managing the modal’s state.

import React, { useState } from "react";
import { CapsuleModal } from "@usecapsule/react-sdk";
import capsule from "./clients/capsule"; // or the path to where you created your capsule instance
import "@usecapsule/react-sdk/styles.css";

function App() {
  const [isOpen, setIsOpen] = useState(false);

  return (
    <div>
      <button onClick={() => setIsOpen(true)}>Sign in with Capsule</button>
      <CapsuleModal
        capsule={capsule}
        isOpen={isOpen}
        onClose={() => setIsOpen(false)}
      />
    </div>
  );
}

export default App;

This creates a button that, when clicked, opens the Capsule Modal for user authentication. The Capsule Modal handles all aspects of user authentication and wallet management.

​

Customizing the Capsule Modal

To provide the best experience for your users, you can customize the appearance and behavior of the Capsule Modal to match your application’s branding.

When rendering the CapsuleModal component, you can pass props to customize its appearance and behavior:

<CapsuleModal
  capsule={capsule}
  isOpen={isOpen}
  onClose={() => setIsOpen(false)}
  appName="Your App Name"
  logo="https://yourapp.com/logo.png"
  theme={{
    backgroundColor: "#ffffff",
    foregroundColor: "#000000",
  }}
  oAuthMethods={["GOOGLE", "TWITTER", "DISCORD"]}
/>

For a full list of available CapsuleModalProps, refer to the customization guide:

​

Examples

For practical implementation of the Capsule SDK in Vite-based React applications, explore our example repository. This repository contains real-world examples to help you get started.

​

Next Steps

After integrating Capsule, you can explore other features and integrations to enhance your Capsule experience. Here are some resources to help you get started:

​

Ecosystems

Learn how to use Capsule with popular Web3 clients and wallet connectors. We’ll cover integration with key libraries for EVM, Solana, and Cosmos ecosystems.

If you’re ready to go live with your Capsule integration, make sure to review our go-live checklist:

​

Troubleshooting

If you encounter issues during the integration or usage of the Capsule Modal in a Vite-based app, here are some common problems and their solutions:

For a more comprehensive list of solutions, visit our troubleshooting guide:

​

Integration Support

If you’re experiencing issues that aren’t resolved by our troubleshooting resources, please contact our team for assistance. To help us resolve your issue quickly, please include the following information in your request:

1. 1

   A detailed description of the problem you’re encountering.

2. 2

   Any relevant error messages or logs.

3. 3

   Steps to reproduce the issue.

4. 4

   Details about your system or environment (e.g., device, operating system, software version).

Providing this information will enable our team to address your concerns more efficiently.