---
title: "Breadcrumb"
description: "The path from the top of a section to the current page, as a row of links."
---

Use it on pages that sit more than one level deep, such as a role inside the roles list inside server settings. It shows where the page is and gives a one-click way back up. It is not a history of where the reader has been.

_Live example of Breadcrumb — see the page for the rendered demo._

## Installation

```bash
npx newtui@latest add breadcrumb
```

Files written — React: components/ui/breadcrumb.tsx. Vue: components/ui/breadcrumb/Breadcrumb.vue, components/ui/breadcrumb/BreadcrumbItem.vue, components/ui/breadcrumb/index.ts.

## Usage

React:

```tsx
import { Breadcrumb } from "@/components/ui/breadcrumb"
```

Vue:

```ts
import { Breadcrumb, BreadcrumbItem } from "@/components/ui/breadcrumb"
```

## API reference

**`Breadcrumb`**

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `label` | `string` | `"Breadcrumb"` | Accessible name of the navigation landmark. |

**`BreadcrumbItem`**

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `href` | `string` | — | Where this level leads. Omit it and pass your router's link component as the child instead. |
| `current` | `boolean` | `false` | Marks the page the reader is on. It renders as text, not a link. |

A link passed as the child of an item with no `href` is styled by the item, so a Next.js `Link` or a `NuxtLink` looks the same as the built-in anchor.

## Accessibility

The trail is an ordered list inside a `<nav>` named by `label`, so it appears in a screen reader's list of landmarks. The last item carries `aria-current="page"`. The slash between items is drawn by the stylesheet and is never read out. Keep the trail short: on a narrow screen it wraps, and the current page truncates before it pushes the layout wide.

`label` names the trail; it defaults to `Breadcrumb`. [Translating labels](/docs/translating-labels) lists every English default.

## Tokens

Breadcrumb reads its colours, radii and motion from the `--newt-*` tokens. Override a token rather than editing the component.
