Coder Social home page Coder Social logo

narimanb / wreactui Goto Github PK

View Code? Open in Web Editor NEW
5.0 1.0 0.0 353 KB

React UI component library based on Tailwind CSS V3 for fast and accessible development of gorgeous interfaces.

License: MIT License

TypeScript 97.03% JavaScript 2.92% CSS 0.05%
react-ui tailwindcss-3 windmill windmill-ui component-library components wreactui

wreactui's Introduction

image

The React UI component library based on Tailwind CSS V3 for fast and accessible development of gorgeous interfaces.

codecov Build License: MIT Maintenance

image Install

Install via npm

npm i -D @narimanb/wreactui

Install via yarn

yarn add -D @narimanb/wreactui

image Configuration

Add wreactui in your tailwind.config.js file.

// tailwind.config.js
/** @type {import('tailwindcss').Config} */

const wreactui = require('@narimanb/wreactui/config');

module.exports = wreactui({
   content: ['./src/**/*.{html,js}'],
   theme: {
       extend: {},
   },
   plugins: [],
});

image Usage

Place Wreactui 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 { Wreactui } from '@narimanb/wreactui';

ReactDOM.render(
   <Wreactui>
      <App />
   </Wreactui>,

   document.getElementById('root')
);

Use components inside your project

import { Button } from '@narimanb/wreactui';

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

export default App;

image Documentation

image Examples

dark & light theme

controls-animate

dashboard

dashboard

image Development

  1. Install Node 18 or later. You can use the package manager of your choice.
  2. Clone this repository git clone https://github.com/narimanb/wreactui.git.
  3. Run npm ci to install the dependencies.
  4. Run npm run storybook
  5. It will start a local server at localhost:6006 with all components rendered.

image History

Original Project Tailwind CSS V2 Windmill React UI Projects using it: Windmill Dashboard React

wreactui's People

Contributors

narimanb avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.