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.

You are reading the v0.2.1 docs

v0.3 is the current stable release. Use the version selector to switch, or read the v0.3 introduction. Code samples on these pages are not rendered live: the previews on this site run the current ShellUI package.

Getting Started

Installation

Choose your preferred installation method:

CLI Installation (Recommended)

bash
# Install CLI globally
dotnet tool install -g ShellUI.CLI

# Initialize in your Blazor project
shellui init

# Add components
shellui add button input card table chart

NuGet Package

bash
dotnet add package ShellUI.Components

Quick Example

razor
<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:

What's New in v0.2.1

  • Chart tooltip fix: Custom tooltip HTML now generates correctly in installed files
  • ChartVariants namespace fix: ChartVariants now correctly under ShellUI.Components.Variants
  • chart-styles auto-install: shellui add chart automatically installs charts.css to wwwroot/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:

css
: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 */
}

Learn More

Rejoining the server...

Rejoin failed... trying again in seconds.

Failed to rejoin.
Please retry or reload the page.

The session has been paused by the server.

Failed to resume the session.
Please retry or reload the page.