<script setup>
import { PhHouse } from "@phosphor-icons/vue";
import { Breadcrumbs } from "@dicehub/phi/components/breadcrumbs";
</script>
<template>
<Breadcrumbs>
<Breadcrumbs.Link :icon="PhHouse" :icon-props="{ size: 16 }" href="#">
Home
</Breadcrumbs.Link>
<Breadcrumbs.Separator />
<Breadcrumbs.Link href="#">Projects</Breadcrumbs.Link>
<Breadcrumbs.Separator />
<Breadcrumbs.Current>Current Project</Breadcrumbs.Current>
</Breadcrumbs>
</template>Installation
Use the root package while prototyping, or the component entrypoint for granular imports.
import { Breadcrumbs } from "@dicehub/phi";
// or use the component entrypoint:
// import { Breadcrumbs } from "@dicehub/phi/components/breadcrumbs";Usage
<script setup>
import { Breadcrumbs } from "@dicehub/phi/components/breadcrumbs";
</script>
<template>
<Breadcrumbs>
<Breadcrumbs.Link href="/">Home</Breadcrumbs.Link>
<Breadcrumbs.Separator />
<Breadcrumbs.Link href="/docs">Docs</Breadcrumbs.Link>
<Breadcrumbs.Separator />
<Breadcrumbs.Current>Breadcrumbs</Breadcrumbs.Current>
</Breadcrumbs>
</template>Use Breadcrumbs.Current for the active page and keep it non-interactive.
Examples
Basic
<script setup>
import { Breadcrumbs } from "@dicehub/phi/components/breadcrumbs";
</script>
<template>
<Breadcrumbs>
<Breadcrumbs.Link href="#">Home</Breadcrumbs.Link>
<Breadcrumbs.Separator />
<Breadcrumbs.Link href="#">Docs</Breadcrumbs.Link>
<Breadcrumbs.Separator />
<Breadcrumbs.Current>Breadcrumbs</Breadcrumbs.Current>
</Breadcrumbs>
</template>Loading
<script setup>
import { PhHouse } from "@phosphor-icons/vue";
import { Breadcrumbs } from "@dicehub/phi/components/breadcrumbs";
</script>
<template>
<Breadcrumbs>
<Breadcrumbs.Link :icon="PhHouse" :icon-props="{ size: 16 }" href="#">
Home
</Breadcrumbs.Link>
<Breadcrumbs.Separator />
<Breadcrumbs.Link href="#">Docs</Breadcrumbs.Link>
<Breadcrumbs.Separator />
<Breadcrumbs.Current loading />
</Breadcrumbs>
</template>Root
<script setup>
import { PhHouse } from "@phosphor-icons/vue";
import { Breadcrumbs } from "@dicehub/phi/components/breadcrumbs";
</script>
<template>
<Breadcrumbs>
<Breadcrumbs.Current :icon="PhHouse" :icon-props="{ size: 16 }">
Worker Analytics
</Breadcrumbs.Current>
</Breadcrumbs>
</template>Clipboard
<script setup>
import { Breadcrumbs } from "@dicehub/phi/components/breadcrumbs";
</script>
<template>
<Breadcrumbs>
<Breadcrumbs.Link href="#">Home</Breadcrumbs.Link>
<Breadcrumbs.Separator />
<Breadcrumbs.Current>Breadcrumbs</Breadcrumbs.Current>
<Breadcrumbs.Clipboard text="#" />
</Breadcrumbs>
</template>Localization
Use LocaleProvider to translate the navigation label and clipboard text. The breadcrumbs keys are label (default: breadcrumb),copy (Copy), copyTooltip (Click to copy), and copied (Copied). The last key names the action and tooltip after a successful copy. Keep the clipboard labels non-empty so the icon button has an accessible name in both states.
All translation keys are optional. Nested providers inherit missing keys from their parent, then fall back to English. Reactive translation changes update mounted components. An explicit aria-label on Breadcrumbs takes precedence. Empty strings are preserved; supply a meaningful name for each navigation landmark. Set dir="rtl" on the trail or an ancestor to mirror the SVG separators. A nested dir="ltr" keeps its left-to-right direction. Direction does not add margins.
<script setup>
import { Breadcrumbs, LocaleProvider } from "@dicehub/phi";
const translations = {
breadcrumbs: {
label: "Fil d’Ariane",
copy: "Copier",
copyTooltip: "Cliquer pour copier",
copied: "Copié",
},
};
</script>
<template>
<LocaleProvider :translations="translations">
<Breadcrumbs>
<Breadcrumbs.Link href="/">Accueil</Breadcrumbs.Link>
<Breadcrumbs.Separator />
<Breadcrumbs.Current>Paramètres</Breadcrumbs.Current>
<Breadcrumbs.Clipboard text="/settings" />
</Breadcrumbs>
</LocaleProvider>
</template>API Reference
Breadcrumbs
| Prop | Type | Default | Description |
|---|---|---|---|
size | "sm" | "base" | "base" | Sets the breadcrumb trail size. |
aria-label | string | LocaleProvider text | Overrides the navigation label from LocaleProvider, including an empty string. Typed as ariaLabel in props. |
Breadcrumbs.Link
| Prop | Type | Default | Description |
|---|---|---|---|
href | string | - | Target URL for a breadcrumb link. |
icon | Component | - | Vue component rendered before the link label. |
iconProps | Record<string, unknown> | {} | Props forwarded to the link icon component. |
Breadcrumbs.Current
| Prop | Type | Default | Description |
|---|---|---|---|
loading | boolean | false | Shows a skeleton placeholder for the current page label. |
icon | Component | - | Vue component rendered before the current label. |
iconProps | Record<string, unknown> | {} | Props forwarded to the current icon component. |
Breadcrumbs.Separator
No component-specific props.
Breadcrumbs.Clipboard
| Prop | Type | Default | Description |
|---|---|---|---|
text | string | - | Text copied by the clipboard action. |