# @whatfinance/uikit

> Set of UI components for whatswap projects

Latest version **0.0.11** (published 2022-01-23) · MIT license · 0 weekly downloads

## Install

```sh
npm install @whatfinance/uikit
pnpm add @whatfinance/uikit
yarn add @whatfinance/uikit
bun add @whatfinance/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.11 |
| Published | 2022-01-23 |
| First published | 2022-01-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 7 |
| Unpacked size | 1009.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | whatfinance_dev |

## Links

- npm: https://www.npmjs.com/package/@whatfinance/uikit
- Repository: https://github.com/whatfinance/uikit
- npm.io page: https://npm.io/package/@whatfinance/uikit

## Dependencies (7)

- [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
- [react-transition-group](https://npm.io/package/react-transition-group.md) ^4.4.1

## Recent versions

- 0.0.11 (latest) — 2022-01-23
- 0.0.10 — 2022-01-23
- 0.0.8 — 2022-01-23
- 0.0.7 — 2022-01-23
- 0.0.6 — 2022-01-23
- 0.0.5 — 2022-01-21
- 0.0.4 — 2022-01-21
- 0.0.3 — 2022-01-21

## README

# Whatswap UIkit 🐎

Whatswap UIkit is a set of React components and hooks used to build pages on Whatswap's apps.

## Install

`yarn add @whatfinance/uikit`

## Setup

### Theme

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

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

### Reset

A reset CSS is available as a global styled component.

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

### Types

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

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