Skip to content

Developer-DAO/web3-ui

Repository files navigation

web3-ui

All Contributors

In Development - Refactoring in Progress πŸ—οΈ

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

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

Quick start

Note: This is for the current public release. This library is being refactored and instructions will change.

  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>
  );
}

Roadmap

Please see the Roadmap for more details

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

πŸ’»

Ernesto GarcΓ­a

πŸ’»

David

πŸ’»

Eric Roupe

πŸ’»

Ricardo Seromenho

πŸ’»

James Charlesworth

πŸ’»

Diego Alzate

πŸ’»

Andrii Shupta

πŸ’»

meowy

πŸ’»

RΓ©mi Roycourt

πŸ’»

Ajinkya Shinde

πŸ’»

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: