https://github.com/codingshot/pancake100-uikit
https://github.com/codingshot/pancake100-uikit
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/codingshot/pancake100-uikit
- Owner: codingshot
- Created: 2021-09-16T18:24:19.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2021-09-16T20:48:51.000Z (over 3 years ago)
- Last Synced: 2025-03-18T11:10:30.854Z (2 months ago)
- Language: TypeScript
- Size: 5.48 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# 🥞 Pancake UIkit
[](https://www.npmjs.com/package/@pancakeswap-libs/uikit) [](https://www.npmjs.com/package/@pancakeswap-libs/uikit)
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'
...
...
```
### Reset
A reset CSS is available as a global styled component.
```
import { ResetCSS } from '@pancakeswap-libs/uikit'
...
```
### 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](https://pancakeswap.github.io/pancake-uikit/)