@boarswap-libs/uikit
v1.0.13
Published
Set of UI components for boarswap projects
Downloads
27
Readme
BoarSwap UIkit
BoarSwap UIkit is a set of React components and hooks used to build pages on BoarSwap's apps. It also contains a theme file for dark and light mode.
Install
yarn add @boarswap-libs/uikit
Setup
Theme
Before using Boarswap UIkit, you need to provide the theme file to styled-component.
import { ThemeProvider } from 'styled-components'
import { light, dark } from '@boarswap-libs/uikit'
...
<ThemeProvider theme={isDark}>...</ThemeProvider>
Reset
A reset CSS is available as a global styled component.
import { ResetCSS } from '@boarswap-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