Skip to content

alium-official/alium-uikit

Repository files navigation

Alium UIkit

Version Size

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

Install

yarn add @aliumswap/uikit

Setup

Theme

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

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

Reset

A reset CSS is available as a global styled component.

import { ResetCSS } from '@alium-official/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

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages