ShellUI Documentation
CLI-first Blazor component library inspired by shadcn/ui
Welcome to ShellUI v0.2.1, a modern, CLI-first Blazor component library inspired by shadcn/ui. Build beautiful, accessible, and performant web applications with our production-ready component library.
Getting Started
Installation
Choose your preferred installation method:
CLI Installation (Recommended)
# Install CLI globally
dotnet tool install -g ShellUI.CLI
# Initialize in your Blazor project
shellui init
# Add components
shellui add button input card table chartNuGet Package
dotnet add package ShellUI.ComponentsQuick Example
<Card>
<CardHeader>
<CardTitle>Welcome to ShellUI</CardTitle>
<CardDescription>Build beautiful Blazor applications</CardDescription>
</CardHeader>
<CardContent>
<p>Your content goes here.</p>
</CardContent>
</Card>Component Categories
Explore our comprehensive component library, organized by category:
Form Components
Buttons, inputs, selects, and form controls
Layout Components
Cards, dialogs, sheets, and structural elements
Navigation Components
Menus, breadcrumbs, tabs, and navigation elements
Data Display
Tables, badges, avatars, and data presentation
Interactive Components
Dropdowns, tooltips, and interactive elements
Advanced Components
Calendars, charts, carousels, and complex UI elements
What's New in v0.2.1
- Chart tooltip fix: Custom tooltip HTML now generates correctly in installed files
- ChartVariants namespace fix:
ChartVariantsnow correctly underShellUI.Components.Variants chart-stylesauto-install:shellui add chartautomatically installscharts.csstowwwroot/css/and injects the<link>tag into your App.razor- wwwroot file support: CLI now correctly installs files with
wwwroot/paths relative to project root
v0.2.0 Highlights
- Charts & Data Visualization: 7 chart components built on ApexCharts.Blazor
- Chart Themes: Three built-in themes (Default, Colorful, Monochrome)
- Theme-Aware Charts: Charts automatically use your theme's CSS variables
- Custom Tooltips: Compact, shadcn-inspired chart tooltips with dark mode support
- Tailwind CSS v4.1.18: Updated to latest stable Tailwind release
Key Features
- CLI-First: Copy components directly to your codebase for full control
- Hybrid Workflow: CLI + NuGet packages for maximum flexibility
- Tailwind CSS v4.1.18: Modern styling with standalone CLI (no Node.js required)
- Production-Ready Components: Comprehensive component library
- Type-Safe Variants: CVA patterns with full C# type safety
- Accessible: WCAG 2.1 AA compliant by default
- Performance Optimized: Built for both Server and WASM scenarios
- Customizable: Easy theme customization with CSS variables
Architecture
ShellUI offers a unique hybrid approach:
- Copy Components: Like shadcn/ui, components are copied to your project
- NuGet Option: Traditional package installation for quick starts
- Tailwind Integration: Standalone CLI or npm setup options
- Build Integration: Automatic CSS compilation on project build
Theming
Customize your theme instantly with tweakcn or modify CSS variables:
:root {
--background: oklch(0.9900 0 0);
--foreground: oklch(0 0 0);
--primary: oklch(0 0 0);
--primary-foreground: oklch(1 0 0);
--secondary: oklch(0.9400 0 0);
--secondary-foreground: oklch(0 0 0);
/* ... more variables */
}