Breadcrumb

Navigation breadcrumb trail for hierarchical page structure

The Breadcrumb component displays the user's current location within a site hierarchy, allowing quick navigation to parent pages.

Installation

bash
shellui add breadcrumb

Basic Usage

<Breadcrumb>
  <BreadcrumbItem Href="/">Home</BreadcrumbItem>
  <BreadcrumbItem Href="/docs">Documentation</BreadcrumbItem>
  <BreadcrumbItem IsLast="true">Components</BreadcrumbItem>
</Breadcrumb>

Non-last items render as clickable links when Href is provided:

Dynamic Breadcrumbs

Generate breadcrumbs from route data:

<Breadcrumb>
  @foreach (var (segment, index) in breadcrumbs.Select((s, i) => (s, i)))
  {
    <BreadcrumbItem
      Href="@(index < breadcrumbs.Count - 1 ? segment.Href : null)"
      IsLast="@(index == breadcrumbs.Count - 1)">
      @segment.Label
    </BreadcrumbItem>
  }
</Breadcrumb>

@code {
    private List<BreadcrumbSegment> breadcrumbs = new()
    {
        new("Home", "/"),
        new("Settings", "/settings"),
        new("Profile", "/settings/profile")
    };

    record BreadcrumbSegment(string Label, string Href);
}

Custom Separator

The default separator is /. You can customize it via CSS:

<Breadcrumb Class="breadcrumb-chevron">
  <BreadcrumbItem Href="/">Home</BreadcrumbItem>
  <BreadcrumbItem Href="/docs">Docs</BreadcrumbItem>
  <BreadcrumbItem IsLast="true">Breadcrumb</BreadcrumbItem>
</Breadcrumb>

Composed from parts

New in v0.4: for full control over links, separators and collapsed levels, set UseList="true" and build the trail from BreadcrumbList, BreadcrumbLink, BreadcrumbPage, BreadcrumbSeparator and BreadcrumbEllipsis. Inside a BreadcrumbList, items don't draw their own separator; you place each BreadcrumbSeparator.

<Breadcrumb UseList="true">
    <BreadcrumbList>
        <BreadcrumbItem>
            <BreadcrumbLink Href="/">Home</BreadcrumbLink>
        </BreadcrumbItem>
        <BreadcrumbSeparator />
        <BreadcrumbItem>
            <BreadcrumbEllipsis />
        </BreadcrumbItem>
        <BreadcrumbSeparator />
        <BreadcrumbItem>
            <BreadcrumbLink Href="/docs/components">Components</BreadcrumbLink>
        </BreadcrumbItem>
        <BreadcrumbSeparator />
        <BreadcrumbItem>
            <BreadcrumbPage>Breadcrumb</BreadcrumbPage>
        </BreadcrumbItem>
    </BreadcrumbList>
</Breadcrumb>

BreadcrumbSeparator shows a chevron by default. Give it content to use something else:

<Breadcrumb UseList="true">
    <BreadcrumbList>
        <BreadcrumbItem>
            <BreadcrumbLink Href="/docs">Projects</BreadcrumbLink>
        </BreadcrumbItem>
        <BreadcrumbSeparator>/</BreadcrumbSeparator>
        <BreadcrumbItem>
            <BreadcrumbLink Href="/docs/introduction">ShellUI</BreadcrumbLink>
        </BreadcrumbItem>
        <BreadcrumbSeparator>/</BreadcrumbSeparator>
        <BreadcrumbItem>
            <BreadcrumbPage>Settings</BreadcrumbPage>
        </BreadcrumbItem>
    </BreadcrumbList>
</Breadcrumb>

API Reference

Property Type Default Description
ChildContent RenderFragment null BreadcrumbItem children
Class string? null Additional CSS classes
Property Type Default Description
Href string? null Navigation link (renders as anchor when set)
IsLast bool false Marks the current/last item (no link styling)
ChildContent RenderFragment null Item label content
Class string? null Additional CSS classes

Parts

Component Parameters Purpose
Breadcrumb UseList Set UseList="true" when the children include a BreadcrumbList
BreadcrumbList Class The ordered list
BreadcrumbLink Href, Class A link to a parent page
BreadcrumbPage Class The current page; sets aria-current="page"
BreadcrumbSeparator Class The divider between items; content replaces the chevron
BreadcrumbEllipsis Class Stands in for collapsed levels

Accessibility

The Breadcrumb component includes:

  • nav element with aria-label="breadcrumb"
  • Ordered list (ol) for proper structure
  • aria-current="page" on the last item
  • Keyboard navigable links
  • Screen reader friendly separator handling

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.