Guide
EVM
Adapters
Rainbowkit V1

RainbowKit

RainbowKit ↗ (opens in a new tab) is a React library that makes it easy to add wallet connection to your dapp. It's intuitive, responsive and customizable. JoyID can be used as a Custom Wallet ↗ (opens in a new tab) for RainbowKit by using @joyid/rainbowkit package.

Installation

Since @joyid/rainbowkit has a peer dependency on @rainbow-me/rainbowkit, and @rainbow-me/rainbowkit has a peer dependency on viem and wagmi, you must have wagmi, viem and @rainbow-me/rainbowkit installed.

npm install @joyid/rainbowkit@0.1.1 @rainbow-me/rainbowkit@1 wagmi@1 viem@1

Usage

Use JoyID with RainbowKit is easy than you think, just need to import JoyIdWallet from @joyid/rainbowkit and pass it to wallets in connectorsForWallets function.

The joyidAppURL parameter is the JoyID App URL that your app will connect to.

provider.tsx
import { WagmiConfig, createConfig, configureChains } from 'wagmi';
import { publicProvider } from 'wagmi/providers/public';
import { sepolia, polygonMumbai } from 'wagmi/chains';
import {
    connectorsForWallets,
    RainbowKitProvider,
} from '@rainbow-me/rainbowkit';
import { JoyIdWallet } from '@joyid/rainbowkit'
import { injectedWallet, coinbaseWallet } from '@rainbow-me/rainbowkit/wallets';
import '@rainbow-me/rainbowkit/styles.css';
 
export const { chains, publicClient } = configureChains(
    [sepolia, polygonMumbai],
    [publicProvider()]
);
 
const connectors = connectorsForWallets([
    {
        groupName: 'Recommended',
        wallets: [
            JoyIdWallet({
                chains,
                options: {
                  // name of your app
                  name: "JoyID demo",
                  // logo of your app
                  logo: "https://fav.farm/🆔",
                  // JoyID app url that your app is integrated with
                  joyidAppURL: "https://testnet.joyid.dev",
                },
            }),
            injectedWallet({ chains, shimDisconnect: true }),
            coinbaseWallet({ chains, appName: 'JoyID Demo' }),
            // rainbowWallet({ chains, shimDisconnect: true }),
        ],
    },
]);
 
const config = createConfig({
    autoConnect: true,
    publicClient,
    connectors,
});
 
export const Provider: React.FC<React.PropsWithChildren> = ({ children }) => {
    return (
        <WagmiConfig config={config}>
            <RainbowKitProvider chains={chains}>{children}</RainbowKitProvider>
        </WagmiConfig>
    );
};

Demo

For a complete demo, you may check GitHub ↗ (opens in a new tab) and JoyID RainbowKit Demo ↗ (opens in a new tab) .

RainbowKitEthereum Provider