Skip to content

Latest commit

 

History

History
122 lines (82 loc) · 4.2 KB

README.md

File metadata and controls

122 lines (82 loc) · 4.2 KB
Raw

web3uiKit logo

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.

CI

Live StoryBook DEMO: https://web3ui.github.io/web3uikit/

Moralis-NFT-Marketplace

⭐️ 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

📦 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 to JSX.Element. List of components that used TIconType prop are:

    • Button
    • Credentials
    • CryptoCards
    • Dropdown
    • Input
    • Notification
    • PopoverElement
    • Select

🧙‍♂️ Community