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.2.2

This update improves the functionality and developer experience of using ConnectKit and moves the peer dependency wagmi up a version to 0.12.x.

Note

This update does not yet include support for WalletConnect 2.0.

New

• Adds a Recent badge to the most recently used connector button by a user. This helps returning users reconnect easily and save time.
• Introduce SafeConnector into the default configuration for better support for Safe Apps. Learn more about this connector in the wagmi docs.
• Convenient onConnect and onDisconnect callbacks on the ConnectKitProvider component and useModal Hook.
• Added dedicated overlayBlur prop to ConnectKitProvider to allow for blurring the background when the modal is open.
• Update peer dependency wagmi to version 0.12.x.

Improved

• Added support for Node 14.
• Improved aria-labels on buttons for better accessibility.
• Icons within buttons are now properly horizontally centered on FireFox.
• Optimise some of the SVGs used in ConnectKit.

Fixed

• Fixed a bug where changing accounts when signed-in with Ethereum would cause an infinite loop (thanks JamieLottering).