1.0.10 β€’ Published 8 months ago

@mohammedshuaau/snappy-ui v1.0.10

Weekly downloads
-
License
MIT
Repository
github
Last release
8 months ago

🎨 Snap Kit

A modern, fully-featured React component library built with TypeScript and Tailwind CSS.

npm version License TypeScript Tailwind CSS

πŸ“š Documentation

For detailed documentation, live examples, and usage guidelines for all components, check out our Storybook. Each component includes:

  • Interactive examples
  • Props API reference
  • Usage guidelines
  • Customization options
  • Accessibility notes

✨ Features

  • πŸ“¦ 70+ Production-Ready Components
  • 🎯 TypeScript First Approach
  • 🎨 Tailwind CSS Styling
  • πŸŒ™ Dark Mode Support
  • β™Ώ Accessibility Built-in
  • πŸ“± Responsive Design
  • ⌨️ Keyboard Navigation
  • πŸ” Screen Reader Support
  • 🎭 Customizable Themes
  • πŸ“š Comprehensive Documentation
  • βœ… Unit Tests
  • πŸ”§ Easy to Extend

πŸ“¦ Installation

# Using npm
npm install @mohammedshuaau/snappy-ui

# Using yarn
yarn add @mohammedshuaau/snappy-ui

# Using pnpm
pnpm add @mohammedshuaau/snappy-ui

πŸš€ Quick Start

import { Button, Input } from '@mohammedshuaau/snappy-ui';

function App() {
  return (
    <div>
      <Input placeholder="Enter your name" />
      <Button variant="primary">Click me!</Button>
    </div>
  );
}

πŸ“š Components

Data Display

  • πŸͺ— Accordion
  • πŸ‘€ Avatar
  • 🎴 Card
  • πŸ“ List
  • πŸ“Š Progress
  • πŸ’€ Skeleton
  • πŸ“‹ Table
  • 🏷️ Tag
  • ⏳ Timeline
  • 🌳 Tree
  • πŸ“œ Typography

Feedback

  • ⚠️ Alert
  • πŸ”° Badge
  • πŸ’¬ Dialog
  • πŸ”„ LoadingOverlay
  • πŸ“¨ Message
  • πŸ’­ Popover
  • πŸŒ€ Spinner
  • 🍞 Toast
  • πŸ’‘ Tooltip

Layout

  • πŸ“ AspectRatio
  • πŸ“¦ Box
  • 🏒 Container
  • βž– Divider
  • πŸ’ͺ Flex
  • 🎯 Grid
  • 🌌 Spacer
  • πŸ“š Stack

Media

  • πŸ”Š Audio
  • 🎨 Icon
  • πŸ–ΌοΈ Image
  • πŸŽ₯ Video

Navigation

  • 🍞 Breadcrumb
  • πŸ”— Link
  • πŸ“‘ Menu
  • 🧭 Navbar
  • πŸ“„ Pagination
  • πŸ“Œ Sidebar
  • πŸͺœ Stepper
  • πŸ“‘ Tabs

Form

  • πŸ”˜ Button
  • βœ… Checkbox
  • 🎨 ColorPicker
  • πŸ“… DatePicker
  • πŸ“† DateRangePicker
  • ⏰ DateTimePicker
  • πŸ“ FileUpload
  • πŸ“ Form
  • ⌨️ Input
  • πŸ”’ NumberInput
  • πŸ”‘ PasswordInput
  • β­• Radio
  • πŸ“ RichTextEditor
  • πŸ“Š Select
  • 🎚️ Slider
  • πŸ”„ Switch
  • πŸ“ Textarea
  • ⏰ TimePicker

Advanced

  • πŸ“… Calendar
  • πŸ‘¨β€πŸ’» CodeEditor
  • ⌨️ CommandPalette
  • 🎯 DragAndDrop
  • ♾️ InfiniteScroll
  • πŸ“‹ KanbanBoard
  • πŸ“ Markdown
  • ↔️ ResizablePanel
  • πŸ“œ VirtualList

Charts

  • πŸ“Š BarChart
  • 🌑️ Heatmap
  • πŸ“ˆ LineChart
  • πŸ₯§ PieChart
  • 🎯 Gauge
  • β­• ProgressCircle
  • ✨ Sparkline
  • πŸ“Š StatCard

🎨 Customization

Snap Kit components can be customized using:

  1. Variant Props: Built-in variants for different styles
  2. sx Prop: Direct style overrides
  3. className: Tailwind CSS classes
  4. Theme: Global theme customization
// Using variants
<Button variant="primary" size="lg" />

// Using sx prop
<Box sx={{ backgroundColor: '#f0f0f0', padding: '1rem' }} />

// Using className
<Card className="shadow-lg hover:shadow-xl" />

🀝 Contributing

I want to make contributing to Snap Kit as easy and transparent as possible, whether it's:

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features
  • Becoming a maintainer

Check out our Contributing Guide for more information.

πŸ“ License

Snap Kit is MIT licensed.

πŸ™ Acknowledgments