Breadcrumbs

Page hierarchy navigation with current-page semantics.

Preview

A live, theme-aware example rendered with the published component.

Loading preview…

Import

Import from the focused entry point below, or use the same named export from @tavojs/ui. Both are public APIs; measure the built application when comparing their bundle cost.

TSX

tsximport { Breadcrumbs } from "@tavojs/ui/breadcrumbs";

The component import loads compiled component CSS. Enable tavoUi() for your project theme variables, or import @tavojs/ui/theme.css once for the package default theme. The equivalent CSS-safe component alias is @tavojs/ui/css/breadcrumbs.

When to use

Use it when

Use `Breadcrumbs` for page hierarchy

Choose something else when

Avoid Breadcrumbs when for arbitrary button groups that do not navigate.

Examples

These examples include imports and local state where interaction requires it. Render the exported component in a page after completing UI installation. Demo state stays in the mounted component; connect file handling, persistence, and data loading to your application as needed.

Breadcrumbs example

TSXCreate: src/components/examples/BreadcrumbsExample1.tsx

tsximport { Breadcrumbs } from "@tavojs/ui/breadcrumbs";

export function BreadcrumbsExample1() {
  return (
    <>
      <Breadcrumbs items={[{ label: "Home", href: "/" }, { label: "Settings", current: true }]} />
    </>
  );
}

Common props and defaults

A curated starting point. The complete TypeScript API below includes additional props and compound member contracts.

Prop	Type	Default	Description
`className`	`string`	—	Optional class hook applied to the public root element owned by the component.
`items`	`{ label: Child; href?: string; current?: boolean }[]`	—	Configures items for this component.
`separator`	`Child`	—	Configures separator for this component.

Complete TypeScript API

Import from @tavojs/ui/breadcrumbs. Published exports: BreadcrumbItem, BreadcrumbSeparator, Breadcrumbs, BreadcrumbsProps.

`BreadcrumbsProps`

Property	Type	Required	Description
`children`	`Child`	No	Inherited children attribute accepted by Breadcrumbs.
`className`	`string`	No	Optional class hook applied to the public root element owned by the component.
`sx`	`Sx`	No	Inherited sx attribute accepted by Breadcrumbs.
`id`	`string`	No	Inherited id attribute accepted by Breadcrumbs.
`role`	`string`	No	Inherited role attribute accepted by Breadcrumbs.
`style`	`Record<string, unknown>`	No	Inherited style attribute accepted by Breadcrumbs.
`title`	`string`	No	Inherited title attribute accepted by Breadcrumbs.
`tabIndex`	`number`	No	Inherited tabIndex attribute accepted by Breadcrumbs.
`hidden`	`boolean`	No	Inherited hidden attribute accepted by Breadcrumbs.
`disabled`	`boolean`	No	Inherited disabled attribute accepted by Breadcrumbs.
`onClick`	`TavoEventHandler<MouseEvent>`	No	Inherited onClick attribute accepted by Breadcrumbs.
`onChange`	`TavoEventHandler<Event>`	No	Inherited onChange attribute accepted by Breadcrumbs.
`onInput`	`TavoEventHandler<Event>`	No	Inherited onInput attribute accepted by Breadcrumbs.
`onKeyDown`	`TavoEventHandler<KeyboardEvent>`	No	Inherited onKeyDown attribute accepted by Breadcrumbs.
`onFocus`	`TavoEventHandler<FocusEvent>`	No	Inherited onFocus attribute accepted by Breadcrumbs.
`onBlur`	`TavoEventHandler<FocusEvent>`	No	Inherited onBlur attribute accepted by Breadcrumbs.
`items`	`BreadcrumbItem[]`	No	Configures items for this component.
`separator`	`Child`	No	Configures separator for this component.
`label`	`string`	No	Inherited label attribute accepted by Breadcrumbs.

State ownership and DOM target

Concern	Contract
State	No component state contract is exposed; the application owns the rendered content and surrounding behavior.
DOM target	Public passthrough props target the component root. Treat nested elements and private class names as implementation details.

Anatomy and related components

This component exposes one public component root rather than a compound member API.

Limitations

Avoid Breadcrumbs when for arbitrary button groups that do not navigate.

Use only the documented props, entry points, and compound members. Internal DOM nesting and CSS class names can change without becoming part of the public component contract.

Accessibility

Renders navigation with current-page state when provided.

Renders navigation with current-page state when provided.

Component status

Contract	Current value
Maturity	stable
Category	navigation
Component import	`@tavojs/ui/breadcrumbs`
Explicit CSS import	`@tavojs/ui/css/breadcrumbs`
Preview	Interactive preview available on this page