# atf-toolkit

> Set of UI components for ATF projects

Latest version **1.1.1** (published 2021-03-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install atf-toolkit
pnpm add atf-toolkit
yarn add atf-toolkit
bun add atf-toolkit
```

## 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.1.1 |
| Published | 2021-03-24 |
| First published | 2021-03-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 5 |
| Unpacked size | 565.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | johnmusk21 |

## Links

- npm: https://www.npmjs.com/package/atf-toolkit
- Repository: https://github.com/ATF-Autofarm/atf-uikit
- Homepage: https://github.com/ATF-Autofarm/atf-uikit#readme
- Issues: https://github.com/ATF-Autofarm/atf-uikit/issues
- npm.io page: https://npm.io/package/atf-toolkit

## 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

- 1.1.1 (latest) — 2021-03-24
- 1.1.0 — 2021-03-23
- 1.0.9 — 2021-03-22
- 1.0.8 — 2021-03-22
- 1.0.7 — 2021-03-22
- 1.0.6 — 2021-03-22
- 1.0.5 — 2021-03-22
- 1.0.4 — 2021-03-22
- 1.0.3 — 2021-03-22
- 1.0.2 — 2021-03-22
- 1.0.1 — 2021-03-20
- 1.0.0 — 2021-03-20

## README

# ATF UIkit

ATF UIkit is a set of React components and hooks used to build pages on ATF's apps. It also contains a theme file for dark and light mode.
This project is fork from pancakeswap-uikit

## Install

`yarn add atf-toolkit`

## Setup

### Theme

Before using ATF UIkit, you need to provide the theme file to styled-component.

```
import { ThemeProvider } from 'styled-components'
import { light, dark } from 'atf-toolkit'
...
<ThemeProvider theme={isDark}>...</ThemeProvider>
```

### Reset

A reset CSS is available as a global styled component.

```
import { ResetCSS } from 'atf-toolkit'
...
<ResetCSS />
```

### Types

This project is built with Typescript and export all the relevant types.

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