Skip to content
docs-sitekit

Menu

Type to search the docs.

↑ ↓ move · Enter open · Esc close

Breadcrumbs

Breadcrumb trail for a page.

Preview

Add to your site

npx docs-sitekit add breadcrumbs

It writes these files, and keeps a file you changed:

  • src/presentation/components/site/breadcrumbs.tsx

It requires these entries of the registry, which add restores first:

Props

Built from the TypeScript types and the TSDoc comments of the component, so they cannot drift from the code.

Props of Breadcrumbs
KeyTypeDefaultAllowed valuesDescription
itemsreadonly { label: string; href?: string; }[]required-The trail, from the home page to the current one. An item with no href is the current page.

Variants and states

Only the current page

A trail of one item has no link and no separator.

About

The trail from the home page to the current page, built on the Breadcrumb of shadcn/ui. The last item is the page itself and has no link.

Accessibility

  • It is a <nav> named “breadcrumb” that holds an ordered list.
  • The current page has aria-current="page".
  • The chevron between two items is aria-hidden.
  • A link is 44 px high on a phone and 24 px from the md width.

Source

Edit this page

Last updated