1.0.5 • Published 3 years ago
share-uikit v1.0.5
🥞 Share UIkit
Share UIkit is a set of React components and hooks used to build pages on Share's apps. It also contains a theme file for dark and light mode.
Install
yarn add share-uikit
Setup
Theme
Before using Share UIkit, you need to provide the theme file to styled-component.
import { ThemeProvider } from 'styled-components'
import { light, dark } from 'share-uikit'
...
<ThemeProvider theme={isDark}>...</ThemeProvider>
Reset
A reset CSS is available as a global styled component.
import { ResetCSS } from 'share-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