/web3-ui

A React UI library for Web3

Primary LanguageTypeScriptMIT LicenseMIT

web3-ui

All Contributors

In Development ๐Ÿ—๏ธ

A library of UI components specifically crafted for web3 use cases.

Package name Current version
@web3-ui/core npm version
@web3-ui/components npm version
@web3-ui/hooks npm version

Quick start

  1. Install the package
$ yarn add @web3-ui/core ethers
  1. Setup the Provider
import { Provider, NETWORKS } from '@web3-ui/core';

function MyApp({ Component, pageProps }) {
  return (
    <Provider network={NETWORKS.mainnet}>
      <Component {...pageProps} />
    </Provider>
  );
}
  1. Use the components and hooks
import { ConnectWallet, useWallet } from '@web3-ui/core';

function Home() {
  const { connection } = useWallet();

  return (
    <div>
      <ConnectWallet />
      <div>{connection.ens || connection.userAddress}</div>
    </div>
  );
}

Do note that you can also install & use the components and hooks packages separately. They are completely independent. The core package is an opinionated combination of the components and hooks packages.

How to Contribute

Read the CONTRIBUTING GUIDELINES.

The motive behind this package

Contributors โœจ

Thanks goes to these wonderful people (emoji key):


Erik Ritter

๐Ÿ’ป ๐Ÿ‘€

Camila Rondinini

๐Ÿ’ป ๐Ÿ‘€

Dhaiwat Pandya

๐Ÿ’ป ๐Ÿ‘€

Nazeeh Vahora

๐Ÿ’ป ๐Ÿ“–

Jose L. Velez

๐Ÿ“– ๐Ÿ’ป

with-heart

๐Ÿ‘€ ๐Ÿ’ป

Christian

๐Ÿ’ป

Alex

๐Ÿ’ป

Sam Wellander

๐Ÿ“–

Todor Tsankov

๐Ÿ’ป

Jovi De Croock

๐Ÿ’ป

Bonhomme

๐Ÿ’ป

hone1er

๐Ÿ’ป

Emanuel Lรณpez

๐Ÿ’ป

Greg Syme

๐Ÿ’ป

Casuneanu Catalin

๐Ÿ’ป

Jake Warren

๐Ÿ’ป

Carlo Miguel Dy

๐Ÿ’ป ๐Ÿ“–

Akshata Mohanty

๐Ÿ“–

Ibby E

๐Ÿ’ป

Sweta Shaw

๐Ÿ’ป

Snehit Paunikar

๐Ÿ“–

Nathan Ng

๐Ÿ’ป

manny

๐Ÿ’ป

fangjun

๐Ÿ“–

Julian Krispel-Samsel

๐Ÿ“–

Ikko Ashimine

๐Ÿ“–

Leonardo Berteotti

๐Ÿ’ป

Patrick Aljord

๐Ÿ’ป

Shamoil Arsiwala

๐Ÿ’ป

This project follows the all-contributors specification. Contributions of any kind welcome!

Special thanks

This project would not have been possible without these wonderful projects: