https://github.com/strvm/ponzi-uikit
https://github.com/strvm/ponzi-uikit
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/strvm/ponzi-uikit
- Owner: Strvm
- Created: 2021-07-01T12:16:07.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-07-01T16:11:38.000Z (over 4 years ago)
- Last Synced: 2025-01-01T21:23:20.557Z (about 1 year ago)
- Language: TypeScript
- Size: 694 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.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/)