0.17.0 • Published 3 years ago

@saqarmaxswap-libs/uikit v0.17.0

Weekly downloads
-
License
MIT
Repository
github
Last release
3 years ago

🥞 Saqarmax UIkit

This repository is not used anymore. See the https://github.com/saqarmaxswap/saqarmax-toolkit(Saqarmax toolkit) instead

Version Size

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

Install

yarn add @saqarmaxswap-libs/uikit

Setup

Theme

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

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

Reset

A reset CSS is available as a global styled component.

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