Breadcrumb
Hierarchical trail with links and current page.
Installation
npx @noarka/cli add breadcrumbUsage
import { Breadcrumb, BreadcrumbEllipsis, BreadcrumbItem, BreadcrumbLink, BreadcrumbList, BreadcrumbPage, BreadcrumbSeparator,} from "@noarka/ui";<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
| Prop | Type | Default |
|---|---|---|
childrenUsually a single BreadcrumbList. | ReactNode | - |
classNameAdditional classes merged on the nav element. | string | - |
BreadcrumbList
| Prop | Type | Default |
|---|---|---|
childrenBreadcrumbItem and BreadcrumbSeparator elements. | ReactNode | - |
classNameAdditional classes merged with the default list styles. | string | - |
BreadcrumbItem
| Prop | Type | Default |
|---|---|---|
childrenOne link, page, or collapsed control. | ReactNode | - |
classNameAdditional classes merged with the default item styles. | string | - |
BreadcrumbLink
| Prop | Type | Default |
|---|---|---|
hrefLink target. Renders a native anchor. | string | - |
classNameAdditional classes merged with the default link styles. | string | - |
BreadcrumbPage
| Prop | Type | Default |
|---|---|---|
childrenCurrent page label. Announced via aria-current. | ReactNode | - |
classNameAdditional classes merged with the default page styles. | string | - |
BreadcrumbSeparator
| Prop | Type | Default |
|---|---|---|
childrenCustom glyph. Defaults to a right arrow icon. | ReactNode | - |
classNameAdditional classes merged with the default separator styles. | string | - |
BreadcrumbEllipsis
| Prop | Type | Default |
|---|---|---|
classNameAdditional classes merged with the default ellipsis styles. | string | - |