ngduc/windmill-react-ui-kit

🧩 A fork from Windmill UI with upgrades, fixes and new components.

Windmill React UI

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

Projects using it: 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

🚀 Usage

Install

npm i windmill-react-ui-kit

Inside tailwind.config.js

const windmill = require('windmill-react-ui-kit/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).

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

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

Use components inside your project

import { Button } from 'windmill-react-ui-kit'

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.

windmill-react-ui-kit's Issues

config.js still using old references

• Tailwind version 3 upgrade

Relevant code or config:

https://github.com/ngduc/windmill-react-ui-kit/blob/master/config.js#L165

const windmillConfig = {
  darkMode: 'class',
  purge: {
    content: [
      'node_modules/@windmill/react-ui/lib/defaultTheme.js',
      'node_modules/@windmill/react-ui/dist/index.js',
    ],

Problem description:

Your windmill node_modules reference still referencing old @windmill package not your package name.

Purge property no longer being used in Tailwind version 3

Suggested solution:

https://tailwindcss.com/docs/upgrade-guide#configure-content-sources

And update package names:

'node_modules/windmill-react-ui-kit/lib/defaultTheme.js',
'node_modules/windmill-react-ui-kit/dist/index.js'

Ensure windmill() wrapper config will merge cleanly content property.

For performance, there should be a way to decide whether to exclude the node_module's defaultTheme.js as well for the windmill function call. Since user might one to configure their own full custom theme on their end fully and not rely on Windmill's one at all.

Pre-commit Linting/Test issues with current repo

Seems like with the Pre-commit husky operations with eslint and JEST test coverage thresholds, there are issues compiling and pre-commiting. Consider cleaning these up or removing pre-commit?

You may consider cherry-picking/using my pre-commit commit to deal with this issue as part of another existing PR related to Dropdown component (take note that this will remove test:coverage thresholds for precommiting and only only do the regular tests):

PR: #5

Commit: 15d16e3