https://github.com/estevanmaito/windmill-react-ui

🧩 The component library for fast and accessible development of gorgeous interfaces.
https://github.com/estevanmaito/windmill-react-ui

component-library components react tailwindcss windmill

Last synced: 7 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/estevanmaito/windmill-react-ui
• Owner: estevanmaito
• License: mit
• Created: 2020-06-24T01:16:15.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-01-03T03:34:54.000Z (about 1 year ago)
• Last Synced: 2025-02-01T00:35:31.150Z (14 days ago)
• Topics: component-library, components, react, tailwindcss, windmill
• Language: TypeScript
• Homepage: https://windmillui.com/react-ui
• Size: 2.42 MB
• Stars: 755
• Watchers: 12
• Forks: 148
• Open Issues: 48
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome-github-repos - estevanmaito/windmill-react-ui - 🧩 The component library for fast and accessible development of gorgeous interfaces. (TypeScript)

README

        
# Windmill React UI

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



  

  

  

  



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(

  

    

  ,

  document.getElementById('root')

)

```

Use components inside your project

```js

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

function App() {

  return Hi there!

}

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.