Skip to content
← Inventory

Breadcrumb

Navigation landmark for a breadcrumb trail; renders a labelled <nav>.

Usage

import { Breadcrumb, breadcrumbAnatomy, BreadcrumbCurrent, BreadcrumbEllipsis, BreadcrumbItem, BreadcrumbLink, BreadcrumbList, BreadcrumbSeparator } from "@desk/ui/components/breadcrumb";

Best practices

  • Terminate the trail with BreadcrumbCurrent (it sets aria-current="page"), never a final BreadcrumbLink.

  • Render router links via <BreadcrumbLink asChild> wrapping a framework <Link> — the bare default is an <a>.

  • Collapse overflow with BreadcrumbEllipsis hosting a menu of the hidden crumbs, rather than dropping items silently.

Props

Breadcrumb

PropTypeDefaultDescription
separatorReact.ReactNode

BreadcrumbLink

PropTypeDefaultDescription
asChildboolean

Also exports

  • constbreadcrumbAnatomy
  • componentBreadcrumbCurrent
  • componentBreadcrumbEllipsis
  • componentBreadcrumbItem
  • componentBreadcrumbList
  • componentBreadcrumbSeparator

Anatomy

Breadcrumb

breadcrumb

Navigation showing current location in hierarchy

BreadcrumbList

breadcrumb-list

Container for breadcrumb items

BreadcrumbItem

breadcrumb-item

Single breadcrumb entry

BreadcrumbLink

breadcrumb-link

Clickable link

BreadcrumbCurrent

breadcrumb-page

Current page (non-link)

BreadcrumbSeparator

breadcrumb-separator

Visual divider

BreadcrumbEllipsis

breadcrumb-ellipsis

Collapsed items indicator