# Maki UIkit

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

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

## Install

`yarn add maki-toolkit`

## Setup

### Theme

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

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

### Reset

A reset CSS is available as a global styled component.

```
import { ResetCSS } from 'maki-toolkit'
...
<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](https://makiswap.github.io/maki-uikit/)