---
title: "Breadcrumb"
description: "Breadcrumb with accessible presentation and local state."
---

# Breadcrumb

Breadcrumb with accessible presentation and local state.

## Installation

Install the shared package once in your Exact app. This version is a beta.

```sh
bun add --exact @rightui/ui@0.4.0-beta.4
```

Or choose another package manager:

```sh
npm install --save-exact @rightui/ui@0.4.0-beta.4
pnpm add --save-exact @rightui/ui@0.4.0-beta.4
yarn add --exact @rightui/ui@0.4.0-beta.4
```

Exact compilation uses Bun 1.4.2. Register Geist and Newsreader, declare the font marker and add the root provider using [Installation](/docs/installation).

### Manual source setup

Install an editable copy of the complete package:

```sh
mkdir -p vendor/rightui vendor/rightui-ui
npm pack @rightui/ui@0.4.0-beta.4 --pack-destination vendor/rightui
tar -xzf ./vendor/rightui/rightui-ui-0.4.0-beta.4.tgz -C vendor/rightui-ui --strip-components=1
bun add file:./vendor/rightui-ui
```

Keep package.json, the Contract files, ui.tamber, assets and licenses together.

### Import

```contract
use Breadcrumb, BreadcrumbOptions, BreadcrumbRoot, BreadcrumbList, BreadcrumbItem, BreadcrumbLink, BreadcrumbPage, BreadcrumbSeparator, BreadcrumbEllipsis, BreadcrumbResponsive, DropdownMenuLinks, MenuLinkEntry from "@rightui/ui"
```

## Usage

Import Breadcrumb(id, labels, choose) for legacy callbacks. BreadcrumbOptions also requires hrefs, separator, label and direction; ancestor entries without hrefs keep choose. Compose real links and a noninteractive current page with the public Breadcrumb parts. BreadcrumbResponsive(id, entries, width, reduced, label, direction) uses MenuLinkEntry(id, label, href), unique IDs and an empty final href; it shows hidden ancestors in a dropdown at width >= 768 or a Drawer below 768. DropdownMenuLinks requires id, label, entries, reduced, customTrigger and direction. Pass every prop explicitly; native hosts must declare the example link destinations.

## Example

```contract
use Breadcrumb, BreadcrumbOptions, BreadcrumbRoot, BreadcrumbList, BreadcrumbItem, BreadcrumbLink, BreadcrumbPage, BreadcrumbSeparator, BreadcrumbEllipsis, BreadcrumbResponsive, DropdownMenuLinks, MenuLinkEntry, Select, QuietLink, uiFontFamily from "@rightui/ui"

component Demo
  props
    width: number
    reduced: bool
  inject
    uiFont: string
  derive narrow = width < 600
  state breadcrumb = "Components"
  state language = "Arabic"
  derive rtl = language != "English"
  derive hebrew = language == "Hebrew"
  derive destinations = [MenuLinkEntry(id="documentation", label="Documentation", href="/docs/installation"), MenuLinkEntry(id="themes", label="Themes", href="/themes"), MenuLinkEntry(id="registry", label="Registry", href="/docs/registry")]
  action chooseBreadcrumb(i: number)
    breadcrumb = (i == 0 ? "Home" : "Library")
  action chooseLanguage(value: string)
    language = value
  view
    column gap="ui.space-16" min-width=0 max-width="100%"
      BreadcrumbRoot(id="breadcrumb-demo", label="Breadcrumb", direction="ltr")
        BreadcrumbList()
          BreadcrumbItem()
            BreadcrumbLink(href="/", label="Home", id="")
          BreadcrumbSeparator(kind="chevron", direction="ltr")
          BreadcrumbItem()
            DropdownMenuLinks(id="breadcrumb-demo-more", label="Show more pages", entries=destinations, reduced=reduced, customTrigger=true, direction="ltr")
              BreadcrumbEllipsis()
          BreadcrumbSeparator(kind="chevron", direction="ltr")
          BreadcrumbItem()
            BreadcrumbLink(href="/docs/components", label="Components", id="")
          BreadcrumbSeparator(kind="chevron", direction="ltr")
          BreadcrumbItem()
            BreadcrumbPage(label="Breadcrumb")
      Breadcrumb(id="catalog-breadcrumb", labels=["Home", "Library", "Components"], choose=chooseBreadcrumb)
      text ("Selected: " + breadcrumb) role="status" font-size="ui.text-sm" color="ui.muted-foreground" font-family=uiFontFamily(uiFont) data-rightui-font="body"
      BreadcrumbOptions(id="linked-breadcrumb", labels=["Home", "Components", "Breadcrumb"], hrefs=["/", "/docs/components"], choose=chooseBreadcrumb, separator="chevron", label="Breadcrumb", direction="ltr")
      BreadcrumbOptions(id="slash-breadcrumb", labels=["Home", "Components", "Breadcrumb"], hrefs=["/", "/docs/components"], separator="slash", choose=chooseBreadcrumb, label="Breadcrumb", direction="ltr")
      BreadcrumbRoot(id="custom-separator-breadcrumb", label="Breadcrumb", direction="ltr")
        BreadcrumbList()
          BreadcrumbItem()
            BreadcrumbLink(href="/", label="Home", id="")
          BreadcrumbSeparator(kind="custom", direction="ltr")
            svg width="ui.space-14" height="ui.space-14" viewBox="0 0 24 24" fill="currentColor" aria-hidden=true
              circle cx=12 cy=12 r=1
          BreadcrumbItem()
            BreadcrumbLink(href="/docs/components", label="Components", id="")
          BreadcrumbSeparator(kind="dot", direction="ltr")
          BreadcrumbItem()
            BreadcrumbPage(label="Breadcrumb")
      BreadcrumbRoot(id="dropdown-breadcrumb", label="Breadcrumb", direction="ltr")
        BreadcrumbList()
          BreadcrumbItem()
            BreadcrumbLink(href="/", label="Home", id="")
          BreadcrumbSeparator(kind="dot", direction="ltr")
          BreadcrumbItem()
            DropdownMenuLinks(id="breadcrumb-components", label="Components", entries=destinations, reduced=reduced, customTrigger=false, direction="ltr")
          BreadcrumbSeparator(kind="dot", direction="ltr")
          BreadcrumbItem()
            BreadcrumbPage(label="Breadcrumb")
      BreadcrumbRoot(id="collapsed-breadcrumb", label="Breadcrumb", direction="ltr")
        BreadcrumbList()
          BreadcrumbItem()
            BreadcrumbLink(href="/", label="Home", id="")
          BreadcrumbSeparator(kind="chevron", direction="ltr")
          BreadcrumbItem()
            BreadcrumbEllipsis()
          BreadcrumbSeparator(kind="chevron", direction="ltr")
          BreadcrumbItem()
            BreadcrumbLink(href="/docs/components", label="Components", id="")
          BreadcrumbSeparator(kind="chevron", direction="ltr")
          BreadcrumbItem()
            BreadcrumbPage(label="Breadcrumb")
      BreadcrumbRoot(id="router-breadcrumb", label="Breadcrumb", direction="ltr")
        BreadcrumbList()
          BreadcrumbItem()
            link href="/" class=QuietLink
              text "Home" font-family=uiFontFamily(uiFont) data-rightui-font="body"
          BreadcrumbSeparator(kind="chevron", direction="ltr")
          BreadcrumbItem()
            BreadcrumbLink(href="/docs/components", id="", label="")
              text "Components" font-family=uiFontFamily(uiFont) data-rightui-font="body"
          BreadcrumbSeparator(kind="chevron", direction="ltr")
          BreadcrumbItem()
            BreadcrumbPage(label="Breadcrumb")
      BreadcrumbResponsive(id="responsive-breadcrumb", width=width, reduced=reduced, entries=[MenuLinkEntry(id="home", label="Home", href="/"), MenuLinkEntry(id="documentation", label="Documentation", href="/docs/installation"), MenuLinkEntry(id="rightui", label="RightUI", href="/docs/registry"), MenuLinkEntry(id="components", label="Components", href="/docs/components"), MenuLinkEntry(id="breadcrumb", label="Breadcrumb", href="")], label="Breadcrumb", direction="ltr")
      Select(id="breadcrumb-language", label="Language", options=["English", "Arabic", "Hebrew"], value=language, disabled=false, reduced=reduced, change=chooseLanguage)
      BreadcrumbRoot(id="rtl-breadcrumb", direction=rtl ? "rtl" : "ltr", label="Breadcrumb")
        BreadcrumbList()
          BreadcrumbItem()
            BreadcrumbLink(href="/", label=rtl ? (hebrew ? "בית" : "الرئيسية") : "Home", id="")
          BreadcrumbSeparator(direction=rtl ? "rtl" : "ltr", kind="chevron")
          BreadcrumbItem()
            DropdownMenuLinks(id="breadcrumb-rtl-components", label=rtl ? (hebrew ? "רכיבים" : "المكونات") : "Components", direction=rtl ? "rtl" : "ltr", reduced=reduced, entries=[MenuLinkEntry(id="documentation", label=rtl ? (hebrew ? "תיעוד" : "التوثيق") : "Documentation", href="/docs/installation"), MenuLinkEntry(id="themes", label=rtl ? (hebrew ? "ערכות נושא" : "السمات") : "Themes", href="/themes"), MenuLinkEntry(id="registry", label=rtl ? (hebrew ? "ספרייה" : "المكتبة") : "Registry", href="/docs/registry")], customTrigger=false)
          BreadcrumbSeparator(direction=rtl ? "rtl" : "ltr", kind="chevron")
          BreadcrumbItem()
            BreadcrumbPage(label=rtl ? (hebrew ? "פירורי לחם" : "مسار التنقل") : "Breadcrumb")

```

## API Reference

| Property | Type |
| --- | --- |
| BreadcrumbRoot.id | string |
| BreadcrumbRoot.label | string |
| BreadcrumbRoot.direction | string |
| BreadcrumbLink.href | string |
| BreadcrumbLink.label | string |
| BreadcrumbLink.id | string |
| BreadcrumbPage.label | string |
| BreadcrumbSeparator.kind | string |
| BreadcrumbSeparator.direction | string |
| BreadcrumbResponsive.id | string |
| BreadcrumbResponsive.entries | MenuLinkEntry[] |
| BreadcrumbResponsive.width | number |
| BreadcrumbResponsive.reduced | bool |
| BreadcrumbResponsive.label | string |
| BreadcrumbResponsive.direction | string |
| DropdownMenuLinks.id | string |
| DropdownMenuLinks.label | string |
| DropdownMenuLinks.entries | MenuLinkEntry[] |
| DropdownMenuLinks.reduced | bool |
| DropdownMenuLinks.customTrigger | bool |
| DropdownMenuLinks.direction | string |
| Breadcrumb.id | string |
| Breadcrumb.labels | string[] |
| Breadcrumb.choose | action |
| BreadcrumbOptions.id | string |
| BreadcrumbOptions.labels | string[] |
| BreadcrumbOptions.choose | action |
| BreadcrumbOptions.hrefs | string[] |
| BreadcrumbOptions.separator | string |
| BreadcrumbOptions.label | string |
| BreadcrumbOptions.direction | string |

## Source

File: packages/ui/navigation.contract

```contract
use FontWeights from "./typography-context.contract"
use uiFontFamily from "./typography-context.contract"
use Control from "./styles.contract"
use Button from "./button.contract"
use BreadcrumbRoot, BreadcrumbList, BreadcrumbItem, BreadcrumbLink, BreadcrumbPage, BreadcrumbSeparator from "./breadcrumb-parts.contract"
component Breadcrumb
  props
    id: string
    labels: string[]
    choose: action
  view
    BreadcrumbOptions(id=id, labels=labels, choose=choose, hrefs=[], separator="chevron", label="Breadcrumb", direction="inherit")

component BreadcrumbOptions
  props
    id: string
    labels: string[]
    choose: action
    hrefs: string[]
    separator: string
    label: string
    direction: string
  inject
    uiWeights: FontWeights
    uiFont: string
  view
    BreadcrumbRoot(id=id, label=label, direction=direction)
      BreadcrumbList()
        for item, i in labels key=i
          if i > 0
            BreadcrumbSeparator(kind=separator, direction=direction)
          BreadcrumbItem()
            if i == labels.length - 1
              BreadcrumbPage(label=item)
            else if i < hrefs.length and (match hrefs.at(i) { case some(href) => href, case none => "" }) != ""
              BreadcrumbLink(id=id + "-" + i.toString(), href=(match hrefs.at(i) { case some(href) => href, case none => "" }), label=item)
            else
              button id=(id + "-" + i.toString()) testId=(id + "-" + i.toString()) class=Control font-weight=uiWeights.medium press=choose(i) padding="0px" min-height="ui.space-20" border="0" background-color="transparent" color="ui.muted-foreground"
                :hover
                  color="ui.foreground"
                text item font-size="ui.text-sm" font-family=uiFontFamily(uiFont) data-rightui-font="body"

component Pagination
  props
    id: string
    page: number
    total: number
    change: action
  inject
    uiWeights: FontWeights
    uiFont: string
  derive count = max(1, floor(total))
  derive current = max(1, min(count, floor(page)))
  derive start = max(1, min(current - 2, count - 4))
  view
    nav id=id testId=id aria-label="Pagination"
      row gap="ui.space-4" flex-wrap="wrap" align-items="center" justify-content="center"
        Button(id=id + "-previous", label="Previous", variant="outline", disabled=current == 1, press=change(current - 1))
        for i in range(min(5, count)) key=i
          button id=(id + "-page-" + (start + i).toString()) testId=(id + "-page-" + (start + i).toString()) class=Control font-weight=uiWeights.medium
            aria-label=("Page " + (start + i).toString()) aria-current=(current == start + i ? "page" : "false") press=change(start + i)
            min-width="ui.space-36" height="ui.space-36" padding="ui.space-8 ui.space-12" border-width=(current == start + i ? "ui.border-width" : "ui.border-width") border-style=(current == start + i ? "solid" : "solid") border-color=(current == start + i ? "ui.border" : "transparent") background-color="ui.background" color="ui.foreground"
            text (start + i).toString() font-family=uiFontFamily(uiFont) data-rightui-font="body"
        Button(id=id + "-next", label="Next", variant="outline", disabled=current == count, press=change(current + 1))

component ButtonGroup
  props
    label: string
  slot
  view
    row role="group" aria-label=label gap="ui.space-4" flex-wrap="wrap"
      children

```
