# @saqarmaxswap-libs/uikit

> .

Latest version **0.17.0** (published 2021-04-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install @saqarmaxswap-libs/uikit
pnpm add @saqarmaxswap-libs/uikit
yarn add @saqarmaxswap-libs/uikit
bun add @saqarmaxswap-libs/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.17.0 |
| Published | 2021-04-19 |
| First published | 2021-04-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 5 |
| Unpacked size | 683.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | maroz88 |

## Links

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

## Dependencies (5)

- [lodash](https://npm.io/package/lodash.md) ^4.17.20
- [@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/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.17.0 (latest) — 2021-04-19
- 0.16.0 — 2021-04-19
- 0.15.0 — 2021-04-19

## README

# 🥞 Saqarmax UIkit

**This repository is not used anymore. See the [https://github.com/saqarmaxswap/saqarmax-toolkit](Saqarmax toolkit) instead**

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

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

## Install

`yarn add @saqarmaxswap-libs/uikit`

## Setup

### Theme

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

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

### Reset

A reset CSS is available as a global styled component.

```
import { ResetCSS } from '@saqarmaxswap-libs/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://saqarmaxswap.github.io/saqarmax-uikit/)

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