@frenchkiss-libs/uikit
v0.0.12
Published
Set of UI components for frenchkiss projects
Downloads
42
Readme
💋 FrenchKiss UIkit
FrenchKiss UIkit is a set of React components and hooks used to build pages on FrenchKiss's apps. It also contains a theme file for dark and light mode.
Install
yarn add @frenchkiss-libs/uikit
Setup
Theme
Before using FrenchKiss UIkit, you need to provide the theme file to styled-component.
import { ThemeProvider } from 'styled-components'
import { light, dark } from '@frenchkiss-libs/uikit'
...
<ThemeProvider theme={isDark}>...</ThemeProvider>
Reset
A reset CSS is available as a global styled component.
import { ResetCSS } from '@frenchkiss-libs/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