hicity-toolkit/packages/pancake-uikit
gary 016f948610 feat: 添加邀请链接 2022-04-23 22:18:25 +08:00
..
.storybook feat: 初始化项目 2022-04-11 15:02:10 +08:00
src feat: 添加邀请链接 2022-04-23 22:18:25 +08:00
CHANGELOG.md feat: 初始化项目 2022-04-11 15:02:10 +08:00
README.md feat: 初始化项目 2022-04-11 15:02:10 +08:00
babel.config.js feat: 初始化项目 2022-04-11 15:02:10 +08:00
jest.config.js feat: 初始化项目 2022-04-11 15:02:10 +08:00
package.json feat: 初始化项目 2022-04-11 15:02:10 +08:00
rollup.config.js feat: 初始化项目 2022-04-11 15:02:10 +08:00
tsconfig.json feat: 初始化项目 2022-04-11 15:02:10 +08:00

README.md

🥞 Pancake UIkit

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