aurora-design-system
v0.1.7
Published
A modern React component library with TypeScript, Tailwind CSS, and Web3 aesthetics
Maintainers
Readme
🌟 Aurora UI
A modern React component library with TypeScript, Tailwind CSS, and Web3 aesthetics.
✨ Features
- 🎨 10 Beautiful Components - Button, Input, Select, Checkbox, Radio, Switch, Modal, Tooltip, Card, Badge
- 📘 Full TypeScript Support - Complete type definitions
- ♿ Accessible - WCAG 2.1 AA compliant
- 🎭 Multiple Variants - Extensive customization options
- 🌈 Aurora Theme - Unique gradient aesthetics
- 🧪 Well Tested - Comprehensive test coverage
- 📦 Tree-shakeable - Import only what you need
📦 Installation
npm install aurora-design-system🚀 Quick Start
import { Button, Card, Input } from "aurora-design-system";
import "aurora-design-system/dist/style.css";
function App() {
return (
<Card variant="gradient" padding="lg">
<h2>Welcome to Aurora</h2>
<Input label="Email" type="email" placeholder="[email protected]" />
<Button variant="gradient" size="lg">
Get Started
</Button>
</Card>
);
}📖 Components
- Button - Multiple variants, sizes, and states
- Input - Text inputs with validation and icons
- Select - Custom dropdown with search
- Checkbox - Standard and indeterminate states
- Radio - Radio groups with layouts
- Switch - Animated toggle switches
- Modal - Accessible dialogs with focus management
- Tooltip - Positioned tooltips with auto-placement
- Card - Flexible layout component
- Badge - Status indicators and counts
🎨 Customization
Aurora uses Tailwind CSS. Add the Aurora colors to your tailwind.config.js:
module.exports = {
theme: {
extend: {
colors: {
aurora: {
500: "#0ea5e9",
600: "#0284c7",
},
},
},
},
};📄 License
MIT © Florence Adikwu
🤝 Contributing
Contributions are welcome! See GitHub repository.
Made with ❤️ by Florence Adikwu
