@thecompounder/uikit v1.0.2

The Compounder UIkit

(https://www.npmjs.com/package/@thecompounder/uikit)

(https://www.npmjs.com/package/@thecompounder/uikit)

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

Install

yarn add @thecompounder/uikit

Setup

Theme

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

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

Reset

A reset CSS is available as a global styled component.

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