1.0.0 • Published 3 years ago

liger-uikit v1.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
3 years ago

:tiger: Liger Interface UIkit

Liger 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 liger-uikit

Setup

Theme

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

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

Reset

A reset CSS is available as a global styled component.

import { ResetCSS } from 'liger-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 Style Documentation