Breadcrumb

The Finder path bar with chevron separators.

Installation

npx shadcn@latest add https://cupertino-ui.baltoon.jp/r/breadcrumb.json

Requires the theme tokens — see Installation if this is your first component.

Source

import * as React from "react";
import { ChevronRightIcon, EllipsisIcon } from "lucide-react";

import { cn } from "@/lib/utils";

/**
 * The macOS Finder path bar: small gray segments with chevron
 * separators; the current item is the label color.
 */
function Breadcrumb({ ...props }: React.ComponentProps<"nav">) {
  return <nav aria-label="breadcrumb" data-slot="breadcrumb" {...props} />;
}

function BreadcrumbList({ className, ...props }: React.ComponentProps<"ol">) {
  return (
    <ol
      data-slot="breadcrumb-list"
      className={cn(
        "flex flex-wrap items-center gap-0.5 text-footnote text-secondary-label",
        className
      )}
      {...props}
    />
  );
}

function BreadcrumbItem({ className, ...props }: React.ComponentProps<"li">) {
  return (
    <li
      data-slot="breadcrumb-item"
      className={cn("inline-flex items-center gap-1.5", className)}
      {...props}
    />
  );
}

function BreadcrumbLink({
  className,
  ...props
}: React.ComponentProps<"a">) {
  return (
    <a
      data-slot="breadcrumb-link"
      className={cn(
        "flex items-center gap-1 rounded-[5px] px-1.5 py-0.5 transition-colors hover:bg-fill-quaternary hover:text-label [&_svg]:size-3.5",
        className
      )}
      {...props}
    />
  );
}

function BreadcrumbPage({ className, ...props }: React.ComponentProps<"span">) {
  return (
    <span
      data-slot="breadcrumb-page"
      role="link"
      aria-disabled="true"
      aria-current="page"
      className={cn(
        "flex items-center gap-1 px-1.5 py-0.5 font-medium text-label [&_svg]:size-3.5",
        className
      )}
      {...props}
    />
  );
}

function BreadcrumbSeparator({
  children,
  className,
  ...props
}: React.ComponentProps<"li">) {
  return (
    <li
      data-slot="breadcrumb-separator"
      role="presentation"
      aria-hidden="true"
      className={cn("text-tertiary-label [&>svg]:size-3", className)}
      {...props}
    >
      {children ?? <ChevronRightIcon strokeWidth={2.5} />}
    </li>
  );
}

function BreadcrumbEllipsis({
  className,
  ...props
}: React.ComponentProps<"span">) {
  return (
    <span
      data-slot="breadcrumb-ellipsis"
      role="presentation"
      aria-hidden="true"
      className={cn("flex items-center px-1 [&>svg]:size-3.5", className)}
      {...props}
    >
      <EllipsisIcon />
      <span className="sr-only">More</span>
    </span>
  );
}

export {
  Breadcrumb,
  BreadcrumbEllipsis,
  BreadcrumbItem,
  BreadcrumbLink,
  BreadcrumbList,
  BreadcrumbPage,
  BreadcrumbSeparator,
};