Breadcrumb

A navigation aid showing the current page’s location within a hierarchy.

Install

npx @vultra/cli add breadcrumb

Usage

<script>
  import {
    Breadcrumb,
    BreadcrumbItem,
    BreadcrumbLink,
    BreadcrumbList,
    BreadcrumbPage,
    BreadcrumbSeparator
  } from '@vultra/ui';
</script>

<Breadcrumb>
  <BreadcrumbList>
    <BreadcrumbItem>
      <BreadcrumbLink href="/">Home</BreadcrumbLink>
    </BreadcrumbItem>
    <BreadcrumbSeparator />
    <BreadcrumbItem>
      <BreadcrumbLink href="/docs">Docs</BreadcrumbLink>
    </BreadcrumbItem>
    <BreadcrumbSeparator />
    <BreadcrumbItem>
      <BreadcrumbPage>Components</BreadcrumbPage>
    </BreadcrumbItem>
  </BreadcrumbList>
</Breadcrumb>

Structure

  • Breadcrumb — root wrapper with aria-label="breadcrumb"
  • BreadcrumbList — horizontal list container
  • BreadcrumbItem — wraps a single breadcrumb entry
  • BreadcrumbLink — clickable link
  • BreadcrumbPage — current page (non-interactive)
  • BreadcrumbSeparator — visual separator between items
  • BreadcrumbEllipsis — collapsed menu indicator

Props

Sub-componentDescription
BreadcrumbRoot — sets aria-label="breadcrumb"
BreadcrumbLinkAccepts href for navigation
BreadcrumbPageCurrent page, aria-current="page"
BreadcrumbSeparatorRenders / by default, accepts children