@bugg-m/bugg-ui
TypeScript icon, indicating that this package has built-in type declarations

2.0.4 • Public • Published

🐞 Bugg-ui

In development phase

A modern, flexible UI component library for React

npm version License: MIT React TypeScript Tailwind CSS

🚀 Features

  • 📦 10+ Components: A comprehensive suite of UI components
  • 🎨 Customizable: Easily theme and style to match your brand
  • 🔧 TypeScript Support: Full type definitions for enhanced development
  • 📚 Well Documented: Detailed Storybook with live examples and API references
  • 🌙 Dark Mode: Built-in support for light and dark themes

📦 Installation

npm install @bugg-m/bugg-ui
# or
yarn add @bugg-m/bugg-ui

🏁 Quick Start

  1. Ensure Tailwind CSS is set up in your project.
  2. Import and use components:
import { Button, Input, Card } from '@bugg-m/bugg-ui';

function App() {
  return (
    <Card>
      <h1>Welcome to Bugg-ui</h1>
      <Input placeholder='Enter your name' />
      <Button variant='primary'>Get Started</Button>
    </Card>
  );
}

🧩 Components

Bugg-ui offers a wide range of components, including:

  • 🔘 Button
  • 📝 Input
  • 🃏 Card
  • 📊 Modal
  • ✅ Checkbox
  • 🔽 Select
  • 🔄 Loader
  • ... and many more!

Explore all components in our Storybook.

📚 Documentation

Visit our comprehensive documentation to learn more about:

  • Component API
  • Theming
  • Accessibility features
  • Best practices

🛠️ Development

# Clone the repository
git clone https://github.com/bugg-m/bugg-ui.git

# Install dependencies
npm install

# Run development server
npm run dev

# Run Storybook
npm run storybook

# Build for production
npm run build

Contributing

We welcome contributions! Please see our Contributing Guide for details.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Support

If you encounter any issues or have questions, please open an issue on our GitHub repository.

Stay in Touch

  • Author - [Manish Kumar]

Package Sidebar

Install

npm i @bugg-m/bugg-ui

Weekly Downloads

1

Version

2.0.4

License

MIT

Unpacked Size

184 kB

Total Files

5

Last publish

Collaborators

  • bugg-m