# @windmill/react-ui

> React UI component library built with Tailwind CSS

Latest version **0.6.0** (published 2021-05-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install @windmill/react-ui
pnpm add @windmill/react-ui
yarn add @windmill/react-ui
bun add @windmill/react-ui
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.6.0 |
| Published | 2021-05-17 |
| First published | 2020-07-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Unpacked size | 194.5 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 751 |
| Author | Estevan Maito |
| Maintainers | estevanmaito |

## Links

- npm: https://www.npmjs.com/package/@windmill/react-ui
- Repository: https://github.com/estevanmaito/windmill-react-ui
- Homepage: https://github.com/estevanmaito/windmill-react-ui#readme
- Issues: https://github.com/estevanmaito/windmill-react-ui/issues
- npm.io page: https://npm.io/package/@windmill/react-ui

## Dependencies (6)

- [postcss](https://npm.io/package/postcss.md) ^8.2.15
- [deepmerge](https://npm.io/package/deepmerge.md) 4.2.2
- [classnames](https://npm.io/package/classnames.md) 2.2.6
- [react-focus-lock](https://npm.io/package/react-focus-lock.md) 2.4.1
- [@tailwindcss/forms](https://npm.io/package/@tailwindcss/forms.md) ^0.3.2
- [react-transition-group](https://npm.io/package/react-transition-group.md) 4.4.1

## Recent versions

- 0.6.0 (latest) — 2021-05-17
- 0.6.0-beta.0 (beta) — 2021-05-15
- 0.5.1 — 2021-02-06
- 0.5.0 — 2020-12-02
- 0.4.1 — 2020-11-08
- 0.4.0 — 2020-11-08
- 0.4.0-beta.0 — 2020-10-26
- 0.3.2 — 2020-08-08
- 0.3.1 — 2020-07-21
- 0.3.0 — 2020-07-21

## README

# Windmill React UI

The component library for fast and accessible development of gorgeous interfaces.

<p>
  <a href="https://codecov.io/gh/estevanmaito/windmill-react-ui"><img src="https://codecov.io/gh/estevanmaito/windmill-react-ui/branch/master/graph/badge.svg" alt="codecov" /></a>
  <img src="https://github.com/estevanmaito/windmill-react-ui/workflows/Build/badge.svg" alt="Build" />
  <a href="https://www.npmjs.com/package/@windmill/react-ui"><img src="https://img.shields.io/npm/v/@windmill/react-ui" alt="npm" /></a>
  <a href="https://github.com/estevanmaito/windmill-react-ui/blob/master/LICENSE"><img src="https://img.shields.io/github/license/estevanmaito/windmill-react-ui" alt="MIT License" /></a>
</p>

Projects using it: [Windmill Dashboard React](https://github.com/estevanmaito/windmill-dashboard-react)

## Mission

Be the most accessible it can be out of the box and the fastest way to production.

[Go to docs to see complete, live examples](https://windmillui.com/react-ui)

## 🚀 Usage

Install

```sh
npm i @windmill/react-ui
```

Inside `tailwind.config.js`

```js
const windmill = require('@windmill/react-ui/config')
module.exports = windmill({
  purge: [],
  theme: {
    extend: {},
  },
  variants: {},
  plugins: [],
})
```

Then place `Windmill` at the root of your project (the order doesn't matter, as long as your application is inside).

```js
// index.js
import React from 'react'
import ReactDOM from 'react-dom'
import App from './App'
import { Windmill } from '@windmill/react-ui'

ReactDOM.render(
  <Windmill>
    <App />
  </Windmill>,
  document.getElementById('root')
)
```

Use components inside your project

```js
import { Button } from '@windmill/react-ui'

function App() {
  return <Button>Hi there!</Button>
}

export default App
```

## 🔌 Contributing

- Fork
- Clone
- `npm install`
- `npm run storybook`

It will start a local server at `localhost:6006` with all components rendered.

⚠ Use `npm run cz` instead of `git commit`! It will guide you through some short questions and guarantee that you commit message is standardized.

Commit will also trigger linting and test coverage.

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