Nested pages
Show where a project settings page sits in the site hierarchy.
Components / Navigation
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.
bunx --bun @getweini/cli@latest add breadcrumbImport 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.
<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.
Show where a project settings page sits in the site hierarchy.
Give readers a direct route back from a record to its collection.
Use real anchors for ancestors and a current-page element at the end.
<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>A short trail is enough when the page has only one ancestor.
<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>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.
| Name | Type or signature | Default | What it does |
|---|---|---|---|
labelprop | string | Required | Visible or accessible name for this item. |
defaultslot | () => unknown | Required | Content shown inside Breadcrumb. |
| Name | Type or signature | Default | What it does |
|---|---|---|---|
defaultslot | () => unknown | Required | Content shown inside BreadcrumbItem. |
| Name | Type or signature | Default | What it does |
|---|---|---|---|
hrefprop | string | undefined | Not set | URL to navigate to when this link is activated. |
asprop | Component | "a" | undefined | "a" | Choose the HTML element or Vue component used for this control. |
asChildprop | boolean | undefined | Not set | Use one child element as the control instead of adding another wrapper. |
defaultslot | () => unknown | Required | Content shown inside BreadcrumbLink. |
| Name | Type or signature | Default | What it does |
|---|---|---|---|
defaultslot | () => unknown | Required | Content shown inside BreadcrumbList. |
| Name | Type or signature | Default | What it does |
|---|---|---|---|
defaultslot | () => unknown | Required | Content shown inside BreadcrumbPage. |
| Name | Type or signature | Default | What it does |
|---|---|---|---|
defaultslot | (() => unknown) | undefined | Optional | Content shown inside BreadcrumbSeparator. |
// 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
}