jurosh / pancake-uikit

๐Ÿ’  Set of UI components for pancake projects

Home Page:https://pancakeswap.github.io/pancake-uikit/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

๐Ÿฅž Pancake UIkit

This repository is not used anymore. See the [https://github.com/pancakeswap/pancake-toolkit](Pancake toolkit) instead

Version Size

Pancake UIkit is a set of React components and hooks used to build pages on Pancake's apps. It also contains a theme file for dark and light mode.

Install

yarn add @pancakeswap-libs/uikit

Setup

Theme

Before using Pancake UIkit, you need to provide the theme file to styled-component.

import { ThemeProvider } from 'styled-components'
import { light, dark } from '@pancakeswap-libs/uikit'
...
<ThemeProvider theme={isDark}>...</ThemeProvider>

Reset

A reset CSS is available as a global styled component.

import { ResetCSS } from '@pancakeswap-libs/uikit'
...
<ResetCSS />

Types

This project is built with Typescript and export all the relevant types.

How to use the UIkit

If you want to use components from the UIkit, check the Storybook documentation

About

๐Ÿ’  Set of UI components for pancake projects

https://pancakeswap.github.io/pancake-uikit/


Languages

Language:TypeScript 99.6%Language:JavaScript 0.3%Language:HTML 0.0%