Welcome to Retro UI - A Simple, Pixelated UI Library for React Applications
Check out our interactive demo to see Retro UI in action:
Screen.Recording.2024-07-23.at.3.01.55.AM.mov
- 🎨 Pixelated, retro-style UI components
- 🚀 Easy integration with React and Next.js projects
- 📱 Responsive design for various screen sizes
- 🛠 Built with TypeScript for type safety
- 🎭 Customizable with Tailwind CSS
Retro UI is designed to work seamlessly with your Next.js or React projects using TypeScript and Tailwind CSS.
-
Install the package:
npx i pixel-retroui@latest
-
Configure your project: Follow our detailed Installation Guide to properly set up Retro UI in your project.
Here's a quick example of how to use a Retro UI component in your React application:
import { Button } from "pixel-retroui";
function MyComponent() {
return <Button onClick={() => console.log("Clicked!")}>Click me!</Button>;
}For more detailed usage instructions and examples, please refer to our documentation.
Retro UI comes packed with a variety of components to bring your application to life. Here's a list of our current components:
- Progress Bar: Visualize progress with a retro flair
- Popup: Modal dialog for important messages or actions
- Accordion: Collapsible content sections for organizing information
Explore all our components and their usage in our Component Gallery.
Retro UI is built with customization in mind. You can easily adjust the look and feel of components using Tailwind CSS classes or by using predefined props.
We welcome contributions from the community! If you'd like to contribute to Retro UI, please follow these steps:
- Fork the repository
- Create your feature branch (
git checkout -b feature/AmazingFeature) - Commit your changes (
git commit -m 'Add some AmazingFeature') - Push to the branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Please read our Contributing Guidelines for more information.
This project is licensed under the BSD 3-Clause License - see the LICENSE file for details.
For any questions, issues, or feature requests, please open an issue on our GitHub repository. We appreciate your feedback and support!
