🌟 Twinkle UIkit

Twinkle UIkit is a set of React components and hooks used to build pages on Twinkle's apps. It also contains a theme file for dark and light mode.

Install

yarn add @twinkleswap/uikit

Note: In case you want to use the older version of the Twinkle UIkit, you should install @twinkleswap-libs/uikit, instead, but we recommend using the latest version of the UIkit.

Setup

Theme

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

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

Reset

A reset CSS is available as a global styled component.

import { ResetCSS } from '@twinkleswap/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