# Dioxus Components Library
A comprehensive collection of reusable Dioxus 0.7 components built with Tailwind CSS v4 and following Radix UI design patterns.
[](https://crates.io/crates/dioxus_components)
[](https://www.rust-lang.org/)
[](https://opensource.org/licenses/MIT)
## Features
✨ **10 High-Quality Components**
- 🎯 **Accordion** - Collapsible sections with single/multiple modes
- 👤 **Avatar** - User avatars with image loading and fallback support
- 🏷️ **Badge** - Flexible badges with 4 style variants
- 🔘 **Button** - Versatile buttons with 6 variants and 6 sizes
- 🃏 **Card** - Flexible card container with header, content, and footer sections
- 💬 **Dialog** - Accessible modal dialogs with overlay and keyboard handling
- 📭 **Empty** - Empty state component for "no content" scenarios
- 🌀 **Portal** - Render content outside the parent DOM hierarchy
- ⏳ **Spinner** - Loading indicators with multiple sizes and colors
- 💬 **Tooltip** - Hover-triggered tooltips with flexible positioning
🎨 **Styling**
- Built with **Tailwind CSS v4** for consistent, utility-first styling
- **Dark mode** support on all components
- **Customizable** through Tailwind theme configuration
- **Responsive** design patterns built-in
♿ **Accessibility**
- **WAI-ARIA** compliant
- Keyboard navigation support
- Screen reader friendly
- Focus management
## Installation
Add to your `Cargo.toml`:
```toml
[dependencies]
dioxus_components = "0.1"
dioxus = { version = "0.7.1", features = ["web"] }
```
Or add with cargo:
```bash
cargo add dioxus_components
```
## Quick Start
### Basic Component Usage
```rust
use dioxus::prelude::*;
use dioxus_components::{Button, ButtonVariant, Spinner, SpinnerSize};
#[component]
fn App() -> Element {
rsx! {
div {
class: "flex gap-4",
Button {
variant: ButtonVariant::Default,
"Click me"
}
Spinner {
size: SpinnerSize::Large,
color: "text-primary"
}
}
}
}
```
## Components Included
1. **Accordion** - Collapsible sections with single/multiple modes
2. **Avatar** - User avatars with image loading and fallback
3. **Badge** - Small decorative labels with 4 variants
4. **Button** - Versatile buttons with 6 variants and 6 sizes
5. **Card** - Flexible card container with header, content, and footer sections
6. **Dialog** - Modal dialogs with overlay, focus management, and keyboard controls
7. **Empty** - Empty state component for "no content" scenarios
8. **Portal** - Render content to different DOM locations (modals, overlays)
9. **Spinner** - Loading indicators with multiple sizes
10. **Tooltip** - Hover-triggered tooltips with positioning
See `COMPONENTS.md` for detailed documentation and API references for all components.
## Running the Demo
Build the library:
```bash
cargo build --lib
```
Run the demo application:
```bash
dx serve --example demo
```
This will start a development server with hot reloading and open the demo in your browser.
## Deploy to Vercel
Deploy the demo to Vercel in 3 steps:
1. **Push to GitHub:**
```bash
git push origin main
```
2. **Import to Vercel:**
- Go to [vercel.com/new](https://vercel.com/new)
- Import your repository
- Vercel will auto-detect `vercel.json`
3. **Deploy:**
- Click "Deploy" and wait ~5-10 minutes
- Your demo will be live at `https://your-project.vercel.app`
See `DEPLOYMENT.md` for detailed deployment instructions and alternative methods.
## Project Structure
```text
src/
├── lib.rs # Library entry point
├── components/ # All reusable components
│ ├── accordion/
│ ├── avatar/
│ ├── badge/
│ ├── button/
│ ├── card/
│ ├── dialog/
│ ├── empty/ # NEW: Empty component
│ ├── portal/
│ ├── spinner/
│ └── tooltip/
└── utils/ # Utility functions
examples/
└── demo.rs # Demo application
COMPONENTS.md # Full component documentation
```
## Building as a Library
This project is configured as a Rust library that can be:
1. Used as a dependency in other Dioxus projects
2. Published to crates.io ✅ **Now published!**
3. Used locally via path dependencies
### Library Exports
The library exports all components and utilities:
```rust
pub use dioxus_components::{
Accordion, AccordionItem, AccordionTrigger, AccordionContent,
Avatar, AvatarImage, AvatarFallback,
Badge, BadgeVariant,
Button, ButtonVariant, ButtonSize,
Portal, // NEW: Portal component
Spinner, SpinnerSize,
Tooltip, TooltipTrigger, TooltipContent, TooltipProvider,
cn, // utility function
};
```
## Published on Crates.io
This library is published and available on [crates.io](https://crates.io/crates/dioxus_components).
Install it in your project:
```bash
cargo add dioxus_components
```
Or manually add to `Cargo.toml`:
```toml
[dependencies]
dioxus_components = "0.1"
```
## Customization
### Theme Colors
Update colors in your `tailwind.css`:
```css
@theme {
--color-primary: hsl(221.2 83.2% 53.3%);
--color-secondary: hsl(210 40% 96.1%);
--color-destructive: hsl(0 84.2% 60.2%);
}
```
### Custom Styling
All components support the `class` prop:
```rust
Button {
class: "rounded-full px-6 py-3 text-lg",
"Custom button"
}
```
## Development
Build the library:
```bash
cargo build --lib
```
Run tests:
```bash
cargo test --lib
```
Generate documentation:
```bash
cargo doc --lib --open
```
## License
MIT
## Changelog
### v0.1.0 - Published 🎉
- ✅ Initial release on crates.io
- ✅ 7 core components (Accordion, Avatar, Badge, Button, Portal, Spinner, Tooltip)
- ✅ Tailwind CSS v4 integration
- ✅ Full WAI-ARIA compliance
- ✅ Dark mode support
- ✅ Comprehensive documentation
## Resources
- [Crates.io Package](https://crates.io/crates/dioxus_components)
- [Dioxus Documentation](https://dioxuslabs.com/learn/0.7/)
- [Tailwind CSS](https://tailwindcss.com/)
- [Radix UI](https://www.radix-ui.com/)
- [Documentation](COMPONENTS.md)