# royaltyz-uikit

> Set of UI components for Royaltiz projects

Latest version **1.0.1** (published 2021-11-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install royaltyz-uikit
pnpm add royaltyz-uikit
yarn add royaltyz-uikit
bun add royaltyz-uikit
```

## Health

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

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

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2021-11-05 |
| First published | 2021-11-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 8 |
| Unpacked size | 1.1 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Royaltyz |
| Maintainers | woonkly |
| Keywords | uikit |

## Links

- npm: https://www.npmjs.com/package/royaltyz-uikit
- Repository: https://github.com/royaltyz-git/Royaltiz-uikit
- Homepage: https://github.com/royaltyz-git/Royaltiz-uikit#readme
- Issues: https://github.com/royaltyz-git/Royaltiz-uikit/issues
- npm.io page: https://npm.io/package/royaltyz-uikit

## Dependencies (8)

- [lodash](https://npm.io/package/lodash.md) ^4.17.20
- [cogo-toast](https://npm.io/package/cogo-toast.md) ^4.2.3
- [react-tippy](https://npm.io/package/react-tippy.md) ^1.4.0
- [@types/lodash](https://npm.io/package/@types/lodash.md) ^4.14.162
- [styled-system](https://npm.io/package/styled-system.md) ^5.1.5
- [@types/js-cookie](https://npm.io/package/@types/js-cookie.md) ^2.2.6
- [@types/styled-system](https://npm.io/package/@types/styled-system.md) ^5.1.10
- [react-transition-group](https://npm.io/package/react-transition-group.md) ^4.4.1

## Recent versions

- 1.0.1 (latest) — 2021-11-05
- 1.0.0 — 2021-11-05

## README

# Royaltiz UIkit


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

## Install

`npm i `

## Setup

### Theme

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

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

### Reset

A reset CSS is available as a global styled component.

```
import { ResetCSS } from ''
...
<ResetCSS />
```

### Types

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

## Publish

1. Login as admin user
2. Change version on `package.json`
3. Run:

```bash
npm run build
npm publish
// npm run build && npm publish
```

`

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