Skip to content

Latest commit

 

History

History
38 lines (24 loc) · 790 Bytes

README.md

File metadata and controls

38 lines (24 loc) · 790 Bytes

Peronio UIkit

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

Install

yarn add peronio-uikit

Setup

Theme

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

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

Reset

A reset CSS is available as a global styled component.

import { ResetCSS } from 'peronio-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