# 🥞 QuickSwap UIkit

[![Version](https://img.shields.io/npm/v/@quickswap-core/uikit)](https://www.npmjs.com/package/@quickswap-core/uikit) [![Size](https://img.shields.io/bundlephobia/min/@quickswap-core/uikit)](https://www.npmjs.com/package/@quickswap-core/uikit)

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

## Install

`yarn add @quickswap-core/uikit`

## Setup

### Theme

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

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

### Reset

A reset CSS is available as a global styled component.

```
import { ResetCSS } from '@quickswap-core/uikit'
...
<ResetCSS />
```

### Types

This project is built with Typescript and export all the relevant types.