Skip to content

Search documentation

Search guides, examples, and component APIs.

Quick links
↑↓ NavigateEnter OpenEsc Close
Get started

Documentation navigation

Components / Navigation

Breadcrumb

A native breadcrumb navigation composition with real links and a current page.

Last changed in version 0.13.0: Add avatar groups and chips, expand the block gallery, and improve component colors, spacing, and motion.

Interactive showcase

Install

Run in your project
bunx --bun @getweini/cli@latest add breadcrumb

Start with this example

Import the files copied by the install command, then place the component in your Vue template. The text and values in the example belong to your app; change them to fit your task.

Vue
<script setup lang="ts">
import Breadcrumb from './components/ui/breadcrumb/Breadcrumb.vue'
import BreadcrumbItem from './components/ui/breadcrumb/BreadcrumbItem.vue'
import BreadcrumbLink from './components/ui/breadcrumb/BreadcrumbLink.vue'
import BreadcrumbList from './components/ui/breadcrumb/BreadcrumbList.vue'
import BreadcrumbPage from './components/ui/breadcrumb/BreadcrumbPage.vue'
import BreadcrumbSeparator from './components/ui/breadcrumb/BreadcrumbSeparator.vue'
</script>

<template>
  <Breadcrumb label="Breadcrumb">
    <BreadcrumbList>
      <BreadcrumbItem><BreadcrumbLink href="/">Home</BreadcrumbLink></BreadcrumbItem>
      <BreadcrumbSeparator />
      <BreadcrumbItem><BreadcrumbPage>Settings</BreadcrumbPage></BreadcrumbItem>
    </BreadcrumbList>
  </Breadcrumb>
</template>

Breadcrumb renders a labelled nav containing an ordered list. BreadcrumbPage adds aria-current="page"; separators are presentation-only, and the current page should only be a link when it genuinely navigates.

When to use it

Nested pages

Show where a project settings page sits in the site hierarchy.

Deep records

Give readers a direct route back from a record to its collection.

More examples

Settings hierarchy

Use real anchors for ancestors and a current-page element at the end.

Settings hierarchy
<script setup lang="ts">
import Breadcrumb from './components/ui/breadcrumb/Breadcrumb.vue'
import BreadcrumbItem from './components/ui/breadcrumb/BreadcrumbItem.vue'
import BreadcrumbLink from './components/ui/breadcrumb/BreadcrumbLink.vue'
import BreadcrumbList from './components/ui/breadcrumb/BreadcrumbList.vue'
import BreadcrumbPage from './components/ui/breadcrumb/BreadcrumbPage.vue'
import BreadcrumbSeparator from './components/ui/breadcrumb/BreadcrumbSeparator.vue'
</script>

<template>
  <Breadcrumb label="Breadcrumb">
    <BreadcrumbList>
      <BreadcrumbItem><BreadcrumbLink href="/">Home</BreadcrumbLink></BreadcrumbItem>
      <BreadcrumbSeparator />
      <BreadcrumbItem><BreadcrumbLink href="/settings">Settings</BreadcrumbLink></BreadcrumbItem>
      <BreadcrumbSeparator />
      <BreadcrumbItem><BreadcrumbPage>Security</BreadcrumbPage></BreadcrumbItem>
    </BreadcrumbList>
  </Breadcrumb>
</template>

Project record

A short trail is enough when the page has only one ancestor.

Project record
<script setup lang="ts">
import Breadcrumb from './components/ui/breadcrumb/Breadcrumb.vue'
import BreadcrumbItem from './components/ui/breadcrumb/BreadcrumbItem.vue'
import BreadcrumbLink from './components/ui/breadcrumb/BreadcrumbLink.vue'
import BreadcrumbList from './components/ui/breadcrumb/BreadcrumbList.vue'
import BreadcrumbPage from './components/ui/breadcrumb/BreadcrumbPage.vue'
import BreadcrumbSeparator from './components/ui/breadcrumb/BreadcrumbSeparator.vue'
</script>

<template>
  <Breadcrumb label="Project location">
    <BreadcrumbList>
      <BreadcrumbItem><BreadcrumbLink href="/projects">Projects</BreadcrumbLink></BreadcrumbItem>
      <BreadcrumbSeparator />
      <BreadcrumbItem><BreadcrumbPage>Atlas</BreadcrumbPage></BreadcrumbItem>
    </BreadcrumbList>
  </Breadcrumb>
</template>

Complete API

Every public prop, model, event, slot, and exposed member of the installed Vue parts is listed below. “Not set” means you can leave that value out; “Required” means you must provide it. Native HTML attributes also work where the component uses a native element.

Breadcrumb

Complete API for Breadcrumb
NameType or signatureDefaultWhat it does
labelpropstringRequiredVisible or accessible name for this item.
defaultslot() => unknownRequiredContent shown inside Breadcrumb.

BreadcrumbItem

Complete API for BreadcrumbItem
NameType or signatureDefaultWhat it does
defaultslot() => unknownRequiredContent shown inside BreadcrumbItem.
Complete API for BreadcrumbLink
NameType or signatureDefaultWhat it does

BreadcrumbList

Complete API for BreadcrumbList
NameType or signatureDefaultWhat it does
defaultslot() => unknownRequiredContent shown inside BreadcrumbList.

BreadcrumbPage

Complete API for BreadcrumbPage
NameType or signatureDefaultWhat it does
defaultslot() => unknownRequiredContent shown inside BreadcrumbPage.

BreadcrumbSeparator

Complete API for BreadcrumbSeparator
NameType or signatureDefaultWhat it does
defaultslot(() => unknown) | undefinedOptionalContent shown inside BreadcrumbSeparator.
Public type definitions
Public types
// packages/frameworks/vue/components/breadcrumb/types.ts
// ------- IMPORTS -------

import type { Component } from 'vue'

// ------- TYPES -------

export interface BreadcrumbProps {
  label: string
}

export interface BreadcrumbLinkProps {
  href?: string
  as?: 'a' | Component
  asChild?: boolean
}

Implementation notes

  • The default separator is decorative; its default slot replaces the separator content.
  • Show the actual page hierarchy, not a history of recently visited pages.
  • The final item normally names the current page and does not need a link.

Accessibility and localization

  • The root renders labelled navigation and the page item marks aria-current="page".

Source contract and editing guidance