web3uikit
web3uikit copied to clipboard
Lightweight reusable Web3 UI components for dapps.
Web3UIKit!
Beautiful and lightweight UI components for web3 developers. This UI library will speed up your dapp development no matter which chain you build on.
Live StoryBook DEMO: https://web3ui.github.io/web3uikit/
âī¸ Star us
If this ui-kit helps you build your dApps faster - please star this project, every star makes us very happy!
đ¤ Need help?
If you need help with setting up the boilerplate or have other questions - don't hesitate to write in our community forum and we will check asap. Forum link. The best thing about this boilerplate is the super active community ready to help at any time! We help each other.
đ Quick Start
đŋ Installation
npm install @web3uikit/core @web3uikit/web3 @web3uikit/icons
or
yarn add @web3uikit/core @web3uikit/web3 @web3uikit/icons
âšī¸ Each package can be installed separately.
𧰠Usage
import { CryptoCards, Button } from '@web3uikit/core';
const App = () => (
<>
<CryptoCards
chain="ethereum"
bgColor="blue"
chainType="Network"
onClick={console.log}
/>
<Button theme="primary" type="button" text="Launch Dapp" />
</>
);
ⲠUsage with Next.js
If you are using web3uikit
with Next.js, be sure to follow the official guide, since we are using styled-components
under the hood.
đ§ Table of Contents
- âī¸ Star us
- đ¤ Need help
- đ Quick start
- đ§ Table of Contents
-
đĻ Packages
- Core module
- Icons module
- Web3 module
- đ§ââī¸ Community
đĻ Packages
Core module
The core module contains all the basic ui components like button, input, dropdown etc
package | Version | Changelog | Description |
---|---|---|---|
@web3uikit/core | TODO | TODO | Contains all the basic UI elements |
Icons module
Create an issue with svg code to add more icons or feel free to raise a PR.
package | Version | Changelog | Description |
---|---|---|---|
@web3uikit/icons | TODO | TODO | Contains various icons |
Web3 module
These are components which have moralis
and react-moralis
dependency.
package | Version | Changelog | Description |
---|---|---|---|
@web3uikit/web3 | TODO | TODO | Contains all the web3 components |
đ¨ Breaking Changes
-
Icon
component does not exist anymore. -
All component prop type using
TIconType
are now converted toJSX.Element
. List of components that used TIconType prop are:- Button
- Credentials
- CryptoCards
- Dropdown
- Input
- Notification
- PopoverElement
- Select