Skip to content

Breadcrumbs

A breadcrumb trail: a nav landmark wrapping an ordered list of the pages leading to the current one. Put a Breadcrumbs.Link in each ancestor’s Breadcrumbs.Item, a Breadcrumbs.Separator between items, and a Breadcrumbs.Page for the current page.

<Breadcrumbs>
<Breadcrumbs.Item><Breadcrumbs.Link href="/">Home</Breadcrumbs.Link></Breadcrumbs.Item>
<Breadcrumbs.Separator />
<Breadcrumbs.Item><Breadcrumbs.Ellipsis /></Breadcrumbs.Item>
<Breadcrumbs.Separator />
<Breadcrumbs.Item><Breadcrumbs.Link href="/machines">Machines</Breadcrumbs.Link></Breadcrumbs.Item>
<Breadcrumbs.Separator />
<Breadcrumbs.Item><Breadcrumbs.Page>my-robot</Breadcrumbs.Page></Breadcrumbs.Item>
</Breadcrumbs>
  • Composed from parts, so each link, the separators, and the current page are yours to arrange.
  • A nav landmark wrapping an ordered list, so assistive technology announces it as a trail.
  • Breadcrumbs.Page marks the current page with aria-current="page", and it is text, not a link.
  • Breadcrumbs.Ellipsis stands in for hidden crumbs, alone or inside a menu trigger.

Every part is a property on Breadcrumbs. Breadcrumbs renders the nav and the ol, and each part renders a single element. Breadcrumbs.Separator is a direct child of the list.

<Breadcrumbs>
<Breadcrumbs.Item>
<Breadcrumbs.Link />
</Breadcrumbs.Item>
<Breadcrumbs.Separator />
<Breadcrumbs.Item>
<Breadcrumbs.Ellipsis />
</Breadcrumbs.Item>
<Breadcrumbs.Separator />
<Breadcrumbs.Item>
<Breadcrumbs.Page />
</Breadcrumbs.Item>
</Breadcrumbs>

A Breadcrumbs.Link in each ancestor’s Breadcrumbs.Item, a Breadcrumbs.Separator between items, and a Breadcrumbs.Page for the current page.

Code
Basic.svelte
<script lang="ts">
import { Breadcrumbs } from "@viamrobotics/prime-ui";
</script>
<div class="not-content">
<Breadcrumbs>
<Breadcrumbs.Item><Breadcrumbs.Link href="#home">Home</Breadcrumbs.Link></Breadcrumbs.Item>
<Breadcrumbs.Separator />
<Breadcrumbs.Item><Breadcrumbs.Link href="#machines">Machines</Breadcrumbs.Link></Breadcrumbs.Item>
<Breadcrumbs.Separator />
<Breadcrumbs.Item><Breadcrumbs.Page>my-robot</Breadcrumbs.Page></Breadcrumbs.Item>
</Breadcrumbs>
</div>

Put Breadcrumbs.Ellipsis inside a Menu.Trigger and list the hidden crumbs as menu items. The ellipsis has no behavior of its own.

Code
Collapsed.svelte
<script lang="ts">
import { Breadcrumbs, Menu } from "@viamrobotics/prime-ui";
</script>
<div class="not-content">
<Breadcrumbs>
<Breadcrumbs.Item><Breadcrumbs.Link href="#home">Home</Breadcrumbs.Link></Breadcrumbs.Item>
<Breadcrumbs.Separator />
<Breadcrumbs.Item>
<Menu>
<Menu.Trigger class="focus-ring rounded-sm">
<Breadcrumbs.Ellipsis />
</Menu.Trigger>
<Menu.Content>
<Menu.Item>Organizations</Menu.Item>
<Menu.Item>Locations</Menu.Item>
</Menu.Content>
</Menu>
</Breadcrumbs.Item>
<Breadcrumbs.Separator />
<Breadcrumbs.Item><Breadcrumbs.Link href="#machines">Machines</Breadcrumbs.Link></Breadcrumbs.Item>
<Breadcrumbs.Separator />
<Breadcrumbs.Item><Breadcrumbs.Page>my-robot</Breadcrumbs.Page></Breadcrumbs.Item>
</Breadcrumbs>
</div>

Pass children to Breadcrumbs.Separator to replace the chevron.

Code
CustomSeparator.svelte
<script lang="ts">
import { Breadcrumbs } from "@viamrobotics/prime-ui";
</script>
<div class="not-content">
<Breadcrumbs>
<Breadcrumbs.Item><Breadcrumbs.Link href="#home">Home</Breadcrumbs.Link></Breadcrumbs.Item>
<Breadcrumbs.Separator>/</Breadcrumbs.Separator>
<Breadcrumbs.Item><Breadcrumbs.Link href="#machines">Machines</Breadcrumbs.Link></Breadcrumbs.Item>
<Breadcrumbs.Separator>/</Breadcrumbs.Separator>
<Breadcrumbs.Item><Breadcrumbs.Page>my-robot</Breadcrumbs.Page></Breadcrumbs.Item>
</Breadcrumbs>
</div>

Single page

Ellipsis

Custom separator

prime-core’s Breadcrumbs took a crumbs array of strings and rendered the whole trail. Here you write the trail from parts, so each crumb can be a real link.

prime-core Now
Breadcrumbs with crumbs Breadcrumbs with one Breadcrumbs.Item per crumb.
isDisabled Not carried over. Render a Breadcrumbs.Page instead of a link.
cx class
NavigationBreadcrumb Breadcrumbs
NavigationBreadcrumbList Folded into Breadcrumbs, which renders the list.
NavigationBreadcrumbItem Breadcrumbs.Item
NavigationBreadcrumbLink Breadcrumbs.Link
NavigationBreadcrumbPage Breadcrumbs.Page
NavigationBreadcrumbSeparator Breadcrumbs.Separator, placed between items and not inside one.
NavigationBreadcrumbEllipsis Breadcrumbs.Ellipsis

Every part takes class on the element it renders. Breadcrumbs.Link is muted and darkens on hover. Breadcrumbs.Page uses the default text color. Breadcrumbs.Separator is hidden from assistive technology, and Breadcrumbs.Ellipsis draws an ellipsis glyph on the text baseline, labeled More. The list wraps onto a new line when the trail is wider than its container. Nothing here sets data attributes.

Links are native, so Tab moves between them and Enter follows one.

PropTypeDefaultDescription
idstringElement id. null is not accepted.
aria-labelstring'Breadcrumb'The landmark name.

Plus everything in HTMLAttributes<HTMLElement>, spread onto the element.

Stands in for the crumbs a Breadcrumbs trail leaves out. Place it in a Breadcrumbs.Item, alone or inside a menu trigger. It draws an ellipsis glyph that sits on the text baseline, labeled More. Pass children to replace the glyph, and aria-label to replace the label.

PropTypeDefaultDescription
idstringElement id. null is not accepted.
aria-labelstring'More'What a screen reader announces for the glyph.

Plus everything in HTMLAttributes<HTMLSpanElement>, spread onto the element.

One entry in a Breadcrumbs trail. Holds a Breadcrumbs.Link, a Breadcrumbs.Page, or a Breadcrumbs.Ellipsis.

Takes extraClasses, children, ...restProps }: Props as its props.

A link to an ancestor page in a Breadcrumbs trail. It is muted and darkens on hover.

Takes extraClasses, children, ...restProps }: Props as its props.

The current page at the end of a Breadcrumbs trail. It is text, not a link, and carries aria-current="page".

Takes extraClasses, children, ...restProps }: Props as its props.

The divider between two items of a Breadcrumbs trail. It is a direct child of the list, hidden from assistive technology, and draws a chevron unless given children.

Takes extraClasses, children, ...restProps }: Props as its props.