Breadcrumb

A navigation aid showing the user's current location in a page hierarchy.

When to Use

  • To show the current page's position in the site hierarchy
  • To provide quick navigation back to parent pages
  • For multi-level page structures

Import

import { Breadcrumb } from "orizon";

Examples

Basic

A simple breadcrumb trail.

<Breadcrumb
  items={[
    { title: "Home", href: "#" },
    { title: "Components", href: "#" },
    { title: "Breadcrumb" },
  ]}
/>

Custom Separator

Use a custom separator between items.

<Breadcrumb
  separator=">"
  items={[
    { title: "Home", href: "#" },
    { title: "Navigation", href: "#" },
    { title: "Breadcrumb" },
  ]}
/>

With Dropdown Menu

Add a dropdown menu to a breadcrumb item for sibling navigation.

<Breadcrumb
  items={[
    { title: "Home", href: "#" },
    {
      title: "Components",
      menu: {
        items: [
          { key: "general", label: "General" },
          { key: "layout", label: "Layout" },
          { key: "navigation", label: "Navigation" },
        ],
      },
    },
    { title: "Breadcrumb" },
  ]}
/>

API

  • itemsBreadcrumbItemType[] — Breadcrumb item data array
  • separatorReactNode — Separator between items (default: "/")
  • classNamestring — Custom CSS class
  • titleReactNode — Display text
  • hrefstring — Link URL
  • menu{ items: MenuItem[] } — Dropdown menu configuration
  • onClick(e: MouseEvent) => void — Click handler
  • pathstring — Route path
  • classNamestring — Custom CSS class