react-ui-kit-priyen/README.md

Reusable Component library for Ui Design System

# UI-COMPONENTS

Welcome to `react-ui-kit-priyen`, a comprehensive UI library built using Vite, React, Tailwind CSS, and Shadcn. This design system is tailored for developers looking to integrate robust, scalable, and aesthetically pleasing UI components into their web applications.

## Features

- **Rich Component Library**: Equipped with various UI components designed to be versatile and adaptable for various design needs.
- **Tailored for React**: Components are built to leverage React's capabilities for state management and reactivity.
- **Styled with Tailwind CSS**: Utilize the utility-first classes of Tailwind CSS for rapid UI development and easy customization.
- **Enhanced with Shadcn**: Provides encapsulated Shadow DOM solutions for styled-components without side effects.

## Installation

To install the latest version of `react-ui-kit-priyen`, run the following command in your project directory:
**Tailwind CSS is required**: Equipped with a variety of UI
```bash
npm install react-ui-kit-priyen
```

📌 Compatibility

React 18 or higher is supported.

The package externalizes react and react-dom, so make sure you have them installed in your project.

## Usage

After installation, you can import and use the components in your React projects as follows:

```javascript
import { Button, TextInput } from 'react-ui-kit-priyen';

// Import the global styles at your app's entry point (e.g., src/index.tsx or _app.tsx)
import "react-ui-kit-priyen/dist/style.css";

function App() {
  return (
    <div>
      <Button onClick={() => console.log('Clicked!')}>
        Click me!
      </Button>
      <Input placeholder="Enter text here" onChange={(e) => console.log(e.target.value)} />
    </div>
  );
}
```

👉 [Live Component Docs (Storybook)](https://react-ui-kit-delta.vercel.app/)

## Contributing

We welcome contributions from the community! Feel free to fork the repository and submit a pull request if you have suggestions for improvements or new features.

## License

`react-ui-kit-priyen` is open source and licensed under the MIT license.