🥞 BattleFI UIkit

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

Install

yarn add @battlefi/uikit

Setup

Theme

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

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

Reset

A reset CSS is available as a global styled component.

import { ResetCSS } from '@battlefi/uikit'
...
<ResetCSS />

Types

This project is built with Typescript and export all the relevant types.

How to use the UIkit