# @reacontrade/uikit

> Set of UI components for reacon projects

Latest version **0.0.7** (published 2021-11-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install @reacontrade/uikit
pnpm add @reacontrade/uikit
yarn add @reacontrade/uikit
bun add @reacontrade/uikit
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.7 |
| Published | 2021-11-22 |
| First published | 2021-09-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 6 |
| Unpacked size | 1.2 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Mark Fenix |
| Maintainers | reaconcash |
| Keywords | reacon, trade, reacon |

## Links

- npm: https://www.npmjs.com/package/@reacontrade/uikit
- Repository: https://github.com/reacon-cash/reacon-trade-uikit
- Homepage: https://github.com/reacon-cash/reacon-trade-uikit#readme
- Issues: https://github.com/reacon-cash/reacon-trade-uikit/issues
- npm.io page: https://npm.io/package/@reacontrade/uikit

## Dependencies (6)

- [lodash](https://npm.io/package/lodash.md) ^4.17.20
- [react-popper](https://npm.io/package/react-popper.md) ^2.2.5
- [@types/lodash](https://npm.io/package/@types/lodash.md) ^4.14.168
- [styled-system](https://npm.io/package/styled-system.md) ^5.1.5
- [@popperjs/core](https://npm.io/package/@popperjs/core.md) ^2.9.2
- [@types/styled-system](https://npm.io/package/@types/styled-system.md) ^5.1.10

## Recent versions

- 0.0.7 (latest) — 2021-11-22
- 0.0.6 — 2021-11-22
- 0.0.5 — 2021-10-06
- 0.0.4 — 2021-09-29
- 0.0.3 — 2021-09-29
- 0.0.2 — 2021-09-29
- 0.0.1 — 2021-09-29

## README

# Reacon UIkit

[![Version](https://img.shields.io/npm/v/@reacontrade/uikit)](https://www.npmjs.com/package/@reacontrade/uikit) [![Size](https://img.shields.io/bundlephobia/min/@reacontrade/uikit)](https://www.npmjs.com/package/@reacontrade/uikit)

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

## Install

`yarn add @reacontrade/uikit`

## Setup

### Theme

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

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

### Reset

A reset CSS is available as a global styled component.

```
import { ResetCSS } from '@reacontrade/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](https://reacon-cash.github.io/reacon-trade-uikit/)

---
_Source: https://npm.io/package/@reacontrade/uikit · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._