# Breadcrumbs

> Breadcrumb navigation with separators and ellipsis.

Registry name: `breadcrumbs`. HTML docs: https://ui.anuragroy.dev/component/breadcrumbs.

## Install

```bash
npx shadcn@latest add https://ui.anuragroy.dev/r/breadcrumbs.json
```

If the website is down: `npx shadcn@latest add https://raw.githubusercontent.com/anurag-roy/ui.anuragroy.dev/main/public/r/breadcrumbs.json`.

Registry JSON: https://ui.anuragroy.dev/r/breadcrumbs.json (GitHub: https://raw.githubusercontent.com/anurag-roy/ui.anuragroy.dev/main/public/r/breadcrumbs.json).

## Import

Import paths follow the consumer `components.json` aliases. After a default install:

```tsx
import {
  BreadcrumbEllipsis,
  BreadcrumbItem,
  BreadcrumbLink,
  BreadcrumbList,
  BreadcrumbPage,
  BreadcrumbSeparator,
  Breadcrumbs
} from "@/components/ui/breadcrumbs"
```

## Usage

```tsx
import {
  BreadcrumbItem,
  BreadcrumbLink,
  BreadcrumbList,
  BreadcrumbPage,
  BreadcrumbSeparator,
  Breadcrumbs,
} from "@/components/ui/breadcrumbs"

export function Example() {
  return (
    <Breadcrumbs>
      <BreadcrumbList>
        <BreadcrumbItem>
          <BreadcrumbLink href="/">Home</BreadcrumbLink>
        </BreadcrumbItem>
        <BreadcrumbSeparator />
        <BreadcrumbItem>
          <BreadcrumbPage>Current</BreadcrumbPage>
        </BreadcrumbItem>
      </BreadcrumbList>
    </Breadcrumbs>
  )
}
```

## API

### Breadcrumbs

Landmark `nav` with a default `aria-label` of `Breadcrumbs`.

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `className` | string | — |  |

### BreadcrumbLink

Styled `a` for ancestor crumbs.

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `href` | string | — |  |

### BreadcrumbPage

Marks the current page (`aria-current="page"`).

No additional props beyond the underlying primitive.

### BreadcrumbSeparator

Defaults to a chevron. Pass children to replace the icon.

No additional props beyond the underlying primitive.

### BreadcrumbEllipsis

Collapsed middle crumbs. Includes a visually hidden “More” label.

No additional props beyond the underlying primitive.

## See also

- [HTML page](https://ui.anuragroy.dev/component/breadcrumbs): Preview and the same docs in the site chrome.
- [Registry item](https://ui.anuragroy.dev/r/breadcrumbs.json): Source files and dependencies.
- [Catalog](https://ui.anuragroy.dev/component): All components.
- [llms.txt](https://ui.anuragroy.dev/llms.txt): Agent index for this library.
