@squirrelswap/uikit v1.0.4

🥞 Squirrel UIkit

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

Install

yarn add @squirrelswap-libs/uikit

Setup

In pecans:

    yarn link

In hazelnuts:

    yarn link "@squirrelswap/uikit"
    cd node_modules/react
    yarn link
    cd ../react-dom
    yarn link
    cd ../@types/react
    yarn link
    cd ../@types/react-dom
    yarn link
    cd ../../styled-components
    yarn link
    cd ../react-router-dom
    yarn link

In pecans:

    yarn link "react"
    yarn link "react-dom"
    yarn link "@types/react"
    yarn link "@types/react-dom"
    yarn link "styled-components"
    yarn link "react-router-dom"

Theme

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

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

Reset

A reset CSS is available as a global styled component.

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