GitHub55X

Breadcrumb

Vue breadcrumb navigation that shows the path to the current page with hierarchical links.

PreviousNext

Features

  • Composable — Flexible slot-based layout with Breadcrumb.List, Breadcrumb.Item, Breadcrumb.Link, Breadcrumb.Page, and Breadcrumb.Separator
  • Accessible — Semantic navigation with aria-current on the current page
  • Customizable — Override separators, compose with menus, or collapse long paths with Breadcrumb.Ellipsis

Installation

Install from the Vuzeno registry:

      
      bunx --bun shadcn-vue@latest add https://vuzeno.com/r/breadcrumb.json
    

Usage

      
      <script setup lang="ts">
import { Breadcrumb } from "@/components/ui/breadcrumb";
</script>

<template>
  <Breadcrumb.Root>
    <Breadcrumb.List>
      <Breadcrumb.Item>
        <Breadcrumb.Link href="/">
          Home
        </Breadcrumb.Link>
      </Breadcrumb.Item>
      <Breadcrumb.Separator />
      <Breadcrumb.Item>
        <Breadcrumb.Link href="/components">
          Components
        </Breadcrumb.Link>
      </Breadcrumb.Item>
      <Breadcrumb.Separator />
      <Breadcrumb.Item>
        <Breadcrumb.Page>Breadcrumb</Breadcrumb.Page>
      </Breadcrumb.Item>
    </Breadcrumb.List>
  </Breadcrumb.Root>
</template>
    

Composition

      
      Breadcrumb.Root
└── Breadcrumb.List
    ├── Breadcrumb.Item
    │   └── Breadcrumb.Link
    ├── Breadcrumb.Separator
    ├── Breadcrumb.Item
    │   └── Breadcrumb.Link
    ├── Breadcrumb.Separator
    └── Breadcrumb.Item
        └── Breadcrumb.Page
    

Examples

Custom separator

Use a custom icon or character inside Breadcrumb.Separator.

Compose Breadcrumb.Item with Menu to create a dropdown for nested navigation.

Collapsed

Use Breadcrumb.Ellipsis to collapse intermediate path segments.

API

PartDescription
Breadcrumb.RootRoot nav element with aria-label="breadcrumb"
Breadcrumb.ListOrdered list of breadcrumb items
Breadcrumb.ItemList item wrapping a link or page label
Breadcrumb.LinkNavigable link. Supports as-child for router links
Breadcrumb.PageCurrent page label with aria-current="page"
Breadcrumb.SeparatorVisual separator between items. Defaults to a chevron icon
Breadcrumb.EllipsisCollapsed path indicator with screen-reader text