DocsBreadcrumb
Breadcrumb
A breadcrumb navigation component to help users navigate through a website hierarchy.
Implementation
1
Copy and paste the following code into your project.
import * as React from "react"
import { ChevronRight } from 'lucide-react'
import { cn } from "@/lib/utils"
const Breadcrumb = React.forwardRef<
HTMLElement,
React.HTMLAttributes<HTMLElement>
>(({ ...props }, ref) => <nav ref={ref} aria-label="breadcrumb" {...props} />)
Breadcrumb.displayName = "Breadcrumb"
const BreadcrumbList = React.forwardRef<
HTMLOListElement,
React.OlHTMLAttributes<HTMLOListElement>
>(({ className, ...props }, ref) => (
<ol
ref={ref}
className={cn(
"flex flex-wrap items-center gap-1.5 break-words text-sm text-muted-foreground sm:gap-2.5",
className
)}
{...props}
/>
))
BreadcrumbList.displayName = "BreadcrumbList"
const BreadcrumbItem = React.forwardRef<
HTMLLIElement,
React.LiHTMLAttributes<HTMLLIElement>
>(({ className, ...props }, ref) => (
<li
ref={ref}
className={cn("inline-flex items-center gap-1.5", className)}
{...props}
/>
))
BreadcrumbItem.displayName = "BreadcrumbItem"
const BreadcrumbLink = React.forwardRef<
HTMLAnchorElement,
React.AnchorHTMLAttributes<HTMLAnchorElement>
>(({ className, ...props }, ref) => (
<a
ref={ref}
className={cn("transition-colors hover:text-foreground", className)}
{...props}
/>
))
BreadcrumbLink.displayName = "BreadcrumbLink"
const BreadcrumbPage = React.forwardRef<
HTMLSpanElement,
React.HTMLAttributes<HTMLSpanElement>
>(({ className, ...props }, ref) => (
<span
ref={ref}
role="link"
aria-current="page"
className={cn("font-normal text-foreground", className)}
{...props}
/>
))
BreadcrumbPage.displayName = "BreadcrumbPage"
const BreadcrumbSeparator = ({
children,
className,
...props
}: React.ComponentProps<"li">) => (
<li
role="presentation"
aria-hidden="true"
className={cn("[&>svg]:size-3.5", className)}
{...props}
>
{children || <ChevronRight />}
</li>
)
BreadcrumbSeparator.displayName = "BreadcrumbSeparator"
export {
Breadcrumb,
BreadcrumbList,
BreadcrumbItem,
BreadcrumbLink,
BreadcrumbPage,
BreadcrumbSeparator,
}
2
Update the import paths to match your project setup.
Usage
import { Breadcrumb, BreadcrumbItem, BreadcrumbLink, BreadcrumbPage, BreadcrumbSeparator } from "@/components/ui/breadcrumb"
Examples
Default
With Custom Separator
With Icons
API Reference
Breadcrumb
The main container for the breadcrumb navigation.
Breadcrumb Parts
Part | Description |
---|---|
Breadcrumb | The root container for the breadcrumb. |
BreadcrumbList | The ordered list that contains the breadcrumb items. |
BreadcrumbItem | A list item within the breadcrumb. |
BreadcrumbLink | A link within a breadcrumb item. |
BreadcrumbPage | The current page in the breadcrumb (not a link). |
BreadcrumbSeparator | The separator between breadcrumb items. |