A modern, reusable, and customizable React components library for building beautiful user interfaces quickly and efficiently.
- 📦 Lightweight: Minimal overhead with efficient performance.
- ⚡ Fast: Optimized for high performance with minimal bundle size.
- 🎨 Customizable: Easy to style and customize using CSS-in-JS, Tailwind, or any CSS framework.
- 🚀 Developer Friendly: Well-documented with TypeScript support for type safety.
- 🔄 Reusable: A collection of modular and reusable components designed to work together.
Install the library using npm or yarn:
# With npm
npm install @raghavsvh/pixelflex
# With yarn
yarn add @raghavsvh/pixelflexHere's a quick example of how to use the components:
import React from 'react';
import { Button } from '@raghavsvh/pixelflex';
const App = () => (
<div>
<p>This is a simple Button component from @raghavsvh/pixelflex.</p>
<Button onClick={() => alert('Button clicked!')} theme={'light'}>
Click Me
</Button>
</div>
);
export default App;- Button: A flexible button component.
- Input: A customizable input field component.
- Loader: A loader/spinner for loading states.
...and more coming soon ..!
You can find detailed documentation and component demos here. (Link to your documentation or demo site)
We welcome contributions! Please follow these steps to contribute:
- Fork the repository.
- Create a new branch (
git checkout -b feature/YourFeature). - Commit your changes (
git commit -m 'Add some feature'). - Push to the branch (
git push origin feature/YourFeature). - Open a pull request.
Make sure to lint and test your code before submitting.
This project is licensed under the MIT License - see the LICENSE file for details.
- Built with ❤️ using React, TypeScript, and Styled Components .
- Bundling using rollup
This README provides a good overview for your users and contributors. Let me know if you'd like to add more sections!