Skip to content

Latest commit

 

History

History
103 lines (65 loc) · 3.34 KB

README.md

File metadata and controls

103 lines (65 loc) · 3.34 KB
Raw

Retro UI

Welcome to Retro UI - A Simple, Pixelated UI Library for React Applications

Retro UI Screenshot

Table of Contents

Demo

Check out our interactive demo to see Retro UI in action:

Screen.Recording.2024-07-23.at.3.01.55.AM.mov

Features

  • 🎨 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

Installation

Retro UI is designed to work seamlessly with your Next.js or React projects using TypeScript and Tailwind CSS.

  1. Install the package:

    npx i pixel-retroui@latest

  2. Configure your project: Follow our detailed Installation Guide to properly set up Retro UI in your project.

Usage

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.

Components

Retro UI comes packed with a variety of components to bring your application to life. Here's a list of our current components:

Basic Components

  • Button: Customizable button with retro styling
  • Card: Container for grouping related content

Form Components

  • Input: Text input field with pixelated design
  • TextArea: Multi-line text input

UI Elements

  • 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.

Customization

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.

Contributing

We welcome contributions from the community! If you'd like to contribute to Retro UI, please follow these steps:

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some AmazingFeature')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Please read our Contributing Guidelines for more information.

License

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!