Looking for v1.x readme? It is available on V1 Branch
Your on-ramp to web3 multichain.
Web3Modal is an easy-to-use library to help developers add support for multiple providers in their apps with a simple customizable configuration. This library leverages WalletConnect V2 client (repo, docs) and Wagmi.
By default Web3Modal library supports providers like:
- Metamask
- Injected
- WalletConnect
- Coinbase Wallet
- Ledger
- and many more to be added
Getting started with web3modal is as easy as installing few packages, one for your prefared front-end framework i.e. @web3modal/react and chain ecosystem you are working with i.e @web3modal/ethereum. We will be expanding support to more choices very soon.
Head over to cloud.walletconnect.com to sign up and generate your projectId, which will be required to allow interactions with our explorer api and v2 protocol sdk's in the future.
- React Docs / React Example
- Vue Docs / Vue Example (coming soon)
- Angular Docs / Angular Example (coming soon)
- Vanilla JS Docs / Vanila JS Example (coming soon)
Web3Modal exposes some config options that allow you to personalise it and make it fit in better with your dapp's ui. As of now supported config options are specified below, but more are on the way!
| Option | Values |
|---|---|
| theme | dark, light |
| accentColor | blackWhite, blue, default, green, magenta, orange, teal |