1.0.10 • Published 2 years ago

@aethermeta/uikit v1.0.10

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

👜 Aether UIkit

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

Install

yarn add @aethermeta/uikit

Setup

In front-end-main:

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

In aether-uikit:

    yarn link
    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"

In front-end-main:

    yarn link "@aethermeta/uikit"

Theme

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

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

Reset

A reset CSS is available as a global styled component.

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

Types

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