connectkit

ConnectKit

ConnectKit is a powerful React component library for connecting a wallet to your dApp. It supports the most popular connectors and chains out of the box and provides a beautiful, seamless experience.

Features

• 💡 TypeScript Ready — Get types straight out of the box.
• 🌱 Ecosystem Standards — Uses top libraries such as wagmi.
• 🖥️ Simple UX — Give users a simple, attractive experience.
• 🎨 Beautiful Themes — Predesigned themes or full customization.

and much more...

Quick Start

Get started with a ConnectKit + wagmi + ethers.js project by running one of the following in your terminal:

npm

npx create-react-app my-app --template cra-template-connectkit

yarn

yarn create react-app my-app --template cra-template-connectkit

pnpm

pnpm dlx create-react-app ./my-app --template cra-template-connectkit

Documentation

You can find the full ConnectKit documentation in the Family docs here.

API Reference

You can find the full API Reference in the Family docs here.

Examples

There are various runnable examples included in this repository in the examples folder:

• Create React App Example (TypeScript)
• Next.js Example (TypeScript)
• Vite Example (TypeScript)

Try in CodeSandbox

You can try out some ConnectKit examples directly in your browser through CodeSandbox:

• Create React App Example (TypeScript)
• Next.js (TypeScript)
• Vite Example (TypeScript)

Running Examples Locally

Clone the ConnectKit project and install the necessary dependencies:

$ git clone [e-mail]:family/connectkit.git
$ cd connectkit
$ yarn install

and start the code bundler:

$ yarn dev:connectkit

and then simply select the example you'd like to run:

$ yarn dev:vite # Vite
$ yarn dev:nextjs # Next.js
$ yarn dev:cra # Create React App

Contribute

Before starting on anything, please have a read through our Contribution Guidelines.

Twitter

Follow @family on Twitter for the latest updates on ConnectKit.

License

See LICENSE for more information.

Changelog

1.1.2

This update moves the peer dependency wagmi up to the latest version (0.10.x). This does not yet include support for WalletConnect 2.0.

New

• Update peer dependency wagmi to version 0.10.x.
• New options for ethereumOnboardingUrl and walletOnboardingUrl to custom change the Learn More and About Wallets call to actions.

Fixed

• Remove sunset ethhub.io links and replace with ethereum.org links.

Improved

• Update to chain handling to allow devs access to the configured chains using getGlobalChains.
• Update to allow turning off the default targeted chainId to let wallets connect using their currently active chain.
• • This can be done by setting initialChainId to 0 within the getDefaultClient helper function.