Rewind-UI

A React component library for building modern web applications using Tailwi...

Component ToolkitTailwindCSSReact
rewindui/rewinduirewind-ui.dev@rewind-ui/core

README

Rewind-UI, Effortless user interfaces

Introduction

Built specifically for use with React and Tailwind CSS, Rewind-UI offers a range of accessible, highly customizable components that can be easily integrated into any react project. Rewind-UI comes with a set of default styles that can be easily customized using Tailwind CSS classes. Furthermore, each component can be parameterized using a set of props that can be used to change the default styles of the component.

Installation

Rewind-UI is available as an NPM package and can be installed using the following command:

  1. ```bash
  2. npm install @rewind-ui/core
  3. ```

Configuration

Rewind-UI is designed to be used with React and Tailwind CSS. To use Rewind-UI, you must first install ReactJS and Tailwind CSS in your project. Furthermore, you must also install the following NPM packages:

  1. ```bash
  2. npm install tailwind-scrollbar @tailwindcss/forms @tailwindcss/typography
  3. ```

After having installed Tailwind CSS, you must configure it to work with Rewind-UI. To do this, you must first create a tailwind.config.js file in the root directory of your project. Then, add the following code to that config file:

It is highly recommended to add only the needed style files to avoid having a bloated css file


  1. ```js
  2. module.exports = {
  3.   content: [
  4.     './src/**/*.{html,jsx,tsx}',
  5.     // you can either add all styles
  6.     './node_modules/@rewind-ui/core/dist/theme/styles/*.js',
  7.     // OR you can add only the styles you need
  8.     './node_modules/@rewind-ui/core/dist/theme/styles/Button.styles.js',
  9.     './node_modules/@rewind-ui/core/dist/theme/styles/Text.styles.js'
  10.   ],
  11.   plugins: [
  12.     require('@tailwindcss/typography'),
  13.     require('tailwind-scrollbar')({ nocompatible: true }),
  14.     require('@tailwindcss/forms')({
  15.       strategy: 'class' // only generate classes
  16.     })
  17.   ]
  18. };
  19. ```

Usage

To start using Rewind-UI components just add the following import statement to the top of your React component:

  1. ```tsx
  2. import { Button } from '@rewind-ui/core';
  3. ```

Then, you can use the component in your JSX code:

  1. ```tsx
  2. <Button>Click Me</Button>
  3. ```

Properties

Each component has a set of default styles that can be parameterized using the corresponding props. For example, the Button component has a default blue color and a medium size. These values can be changed by setting the color and size props to the component:

  1. ```tsx
  2. <Button color="black" size="sm">Click Me</Button>
  3. ```

Moreover, the style of a component can be customized by passing the normal className prop to it. This prop can be used to override the default styles of the component. For example, the following code will change the font weight of the button to semi-bold:

Rewind-UI is using tailwind-merge to merge the default classes with the classes you provide in theclassName prop and resolve any possible conflicts.

  1. ```tsx
  2.   <Button color="black" size="sm" className="font-semibold">Click Me</Button>
  3. ```

Variants

Trying to avoid to make the user use multiple properties again and again we have created a variant prop. A variant is basically a pre-defined set of properties that can be used to customize a component. For example, the Button component has a success variant that can be used to create a bootstrap-like success button:

  1. ```tsx
  2.   <Button variant="success">Click Me</Button>
  3. ```

You can read more about the variants of each component in their corresponding documentation page.

Customization

All Rewind-UI components are highly customizable. This means that you can easily change the default styles of a component by overriding the corresponding Tailwind CSS classes. You can read more about style customization on the theming page.

Credits

Special thanks to the following people:
Joe Bell - For his amazing open source library Class Variance Authority which is the foundation of rewind's theming system.
Jack Herrington - For inspiring me to start building Rewind-UI.
shadcn - For his open source projects (taxonomy & ui) that helped me build this documentation.

Special thanks to the following teams:
React - For creating React.
Tailwind Labs - For creating Tailwind CSS.
Vercel - For creating Next.js and their awesome open source templates.
Floating-UI - For creating Floating-UI.
Phosphor - For creating Phosphor icon family.

Powered by Vercel