ShellUI Documentation
CLI-first Blazor component library inspired by shadcn/ui
Welcome to ShellUI v0.3.0-alpha.2, the latest pre-release of the CLI-first Blazor component library inspired by shadcn/ui. Includes new compositional components, chart improvements, and CLI registry fixes.
Getting Started
Installation
Choose your preferred installation method:
CLI Installation (Recommended)
# Install alpha CLI
dotnet tool install -g ShellUI.CLI --version 0.3.0-alpha.2
# Or upgrade from alpha.1
dotnet tool update -g ShellUI.CLI --version 0.3.0-alpha.2
# Initialize in your Blazor project
shellui init
# Add components
shellui add button input card table chart drawer sheetNuGet 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
Interactive Components
Dropdowns, tooltips, and interactive elements
Advanced Components
Calendars, charts, carousels, steppers, and complex UI elements
What's New in v0.3.0-alpha.2
- Drawer/Sheet compositional pattern:
DrawerTrigger,DrawerContent,SheetTrigger,SheetContent— no external open state required - CLI registry fix:
shellui add drawerandshellui add sheetnow auto-install all subcomponent files - New components: Callout, CopyButton, LinkCard, PrevNextNav, Sonner, Stepper — all installable via CLI
- Chart fixes: tooltip generation,
ChartVariantsnamespace, andchart-stylesauto-install (v0.2.1 backport) - Compositional APIs: NavigationMenu, Tabs, Dropdown, Popover, Collapsible, Accordion all have new subcomponent patterns
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 */
}