structyl

Breadcrumb

stable

Displays the path to the current resource.

Basic usage

Examples

Multi-level navigation

Three levels showing the full path to the current resource.

Long path with ellipsis

Breadcrumb supports links, separators, current page and compact overflow markers.

Features

  • Navigable links + current page.
  • Custom separators.

Installation

bash
pnpm dlx structyl add breadcrumb

API Reference

Breadcrumb.Root

A nav landmark labelled "breadcrumb".

PropTypeDefault

Breadcrumb.List

The ordered list of crumbs.

PropTypeDefault
classNamestring

Additional Tailwind classes, merged with the component defaults.

Breadcrumb.Item

A single crumb.

PropTypeDefault
classNamestring

Additional Tailwind classes, merged with the component defaults.

Breadcrumb.Link

A navigable crumb link.

PropTypeDefault
asChildboolean

Merge props onto the immediate child instead of rendering a default element.

false
classNamestring

Additional Tailwind classes, merged with the component defaults.

Breadcrumb.Page

The current page crumb (non-link).

PropTypeDefault
classNamestring

Additional Tailwind classes, merged with the component defaults.

Breadcrumb.Separator

Divider between crumbs.

PropTypeDefault
classNamestring

Additional Tailwind classes, merged with the component defaults.

Breadcrumb | structyl