Breadcrumb

Hierarchical trail with links and current page.

Installation

npx @noarka/cli add breadcrumb

Usage

tsx
import {  Breadcrumb,  BreadcrumbEllipsis,  BreadcrumbItem,  BreadcrumbLink,  BreadcrumbList,  BreadcrumbPage,  BreadcrumbSeparator,} from "@noarka/ui";
tsx
<Breadcrumb>  <BreadcrumbList>    <BreadcrumbItem>      <BreadcrumbLink href="#">Docs</BreadcrumbLink>    </BreadcrumbItem>    <BreadcrumbSeparator />    <BreadcrumbItem>      <BreadcrumbLink href="#">Components</BreadcrumbLink>    </BreadcrumbItem>    <BreadcrumbSeparator />    <BreadcrumbItem>      <BreadcrumbPage>Button</BreadcrumbPage>    </BreadcrumbItem>  </BreadcrumbList></Breadcrumb>

Examples

With ellipsis

Collapse middle levels behind an ellipsis.

Custom separator

Pass any glyph as the separator child.

Overflow menu

Hide collapsed levels inside a menu.

API reference

Breadcrumb

PropTypeDefault
children

Usually a single BreadcrumbList.

ReactNode-
className

Additional classes merged on the nav element.

string-

BreadcrumbList

PropTypeDefault
children

BreadcrumbItem and BreadcrumbSeparator elements.

ReactNode-
className

Additional classes merged with the default list styles.

string-

BreadcrumbItem

PropTypeDefault
children

One link, page, or collapsed control.

ReactNode-
className

Additional classes merged with the default item styles.

string-

BreadcrumbPage

PropTypeDefault
children

Current page label. Announced via aria-current.

ReactNode-
className

Additional classes merged with the default page styles.

string-

BreadcrumbSeparator

PropTypeDefault
children

Custom glyph. Defaults to a right arrow icon.

ReactNode-
className

Additional classes merged with the default separator styles.

string-

BreadcrumbEllipsis

PropTypeDefault
className

Additional classes merged with the default ellipsis styles.

string-