ShellUI Logo
ShellUI

Quickstart

Get started with ShellUI in minutes

Get up and running with ShellUI in just a few minutes. This guide will walk you through installing and using your first components.

Prerequisites

  • .NET 8.0 or higher
  • A Blazor project (Server, WebAssembly, or Hybrid)

Installation

Choose your preferred installation method:

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

# Initialize in your Blazor project
shellui init

# Add your first components
shellui add button input card

Option 2: NuGet Package

# Install via NuGet
dotnet add package ShellUI.Components

Your First Component

Let's create a simple button and card combination:

@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
    }
}

What's Next?

On this page