1.0.10 β’ Published 8 months ago
@mohammedshuaau/snappy-ui v1.0.10
π¨ Snap Kit
A modern, fully-featured React component library built with TypeScript and 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:
- Variant Props: Built-in variants for different styles
- sx Prop: Direct style overrides
- className: Tailwind CSS classes
- 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
- Built with React
- Styled with Tailwind CSS
- Icons from Tabler Icons
- Date handling by date-fns
- Charts powered by Recharts
- Toast powered by React Toastify