Quickstart

Get started with ShellUI in minutes

Get up and running with ShellUI v0.4.0 in just a few minutes. This guide will walk you through installing and using your first components from our growing component library.

Prerequisites

  • .NET 8 SDK or later, and a Blazor project on .NET 8, 9 or 10
  • A Blazor project (Server, WebAssembly, or Hybrid)

Installation

ShellUI 0.4 offers a hybrid workflow - use CLI for customization, NuGet for speed:

bash
# Install CLI globally (one-time)
dotnet tool install -g ShellUI.CLI

# Initialize in your Blazor project (choose npm or standalone, and a dashboard layout if you want one)
shellui init

# Add components directly to your codebase
shellui add button input card dialog

# List all available components
shellui list

Option 2: NuGet Package (Quick Start)

bash
# Install components package
dotnet add package ShellUI.Components

# Manual Tailwind CSS v4.3.2 setup required
# See installation guide for details

Why choose CLI? Components are copied to your project for full control and customization.

Your First Component

Let's create a simple button and card combination:

razor
@page "/"

<Card>
  <Header>
    <h3 class="text-lg font-semibold">Welcome to ShellUI</h3>
    <p class="text-sm text-muted-foreground">Your first ShellUI components</p>
  </Header>
  <ChildContent>
    <div class="space-y-4">
      <Input Placeholder="Enter your name" />
      <Button OnClick="HandleClick">Get Started</Button>
    </div>
  </ChildContent>
</Card>

@code {
    private void HandleClick(MouseEventArgs args)
    {
        // Your logic here
    }
}

Add Charts

Build data-rich dashboards with ApexCharts-powered chart components:

bash
shellui add chart bar-chart line-chart pie-chart
dotnet add package Blazor-ApexCharts
razor
@page "/dashboard"

<BarChart TItem="SalesData"
    Data="@salesData"
    Title="Monthly Revenue"
    XValue="@(e => e.Month)"
    YValue="@(e => (decimal?)e.Revenue)"
    Theme="ChartTheme.Default"
    Height="350px" />

@code {
    private List<SalesData> salesData = new()
    {
        new("Jan", 12000), new("Feb", 19000),
        new("Mar", 15000), new("Apr", 25000)
    };

    record SalesData(string Month, decimal Revenue);
}

What's Next?

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.