Breadcrumb
Accessible hierarchy navigation with controlled collapsing, current-page semantics, and long-label handling.
- Selector
- ui-breadcrumb
- Package
- @ngnova/ui/breadcrumb
Import
import { UiBreadcrumbComponent } from '@ngnova/ui/breadcrumb';Usage & variants
Live examples use the public ui-breadcrumb API, paired with the exact snippet a product team would paste into an Angular app.
Documentation breadcrumb
Accessible hierarchy navigation with controlled collapsing, current-page semantics, and long-label handling.
Production guidance
Use these notes to decide when the component belongs in a product workflow and what to verify before shipping.
When to use
Use in products with two or more stable hierarchy levels where users benefit from moving back to an ancestor.
Watch for
maxItems values below three do not collapse because first, ellipsis, and current entries must remain visible.
Product recipes
Apply Breadcrumb in distinct, copyable product scenarios—not just an isolated component state.
Responsive hierarchy
Keep the first location and nearest ancestors visible while collapsing a long middle hierarchy.
1 2 3 4 5 6
<ui-breadcrumb
[items]="breadcrumbItems"
[maxItems]="4"
ariaLabel="Documentation location"
(itemSelected)="trackNavigation($event)"
/>Invoice location
Truncate a deep hierarchy visually while preserving an explicit current-page destination.
1 2 3 4 5 6 7 8
<ui-breadcrumb
ariaLabel="Invoice location"
[items]="[
{ label: 'Billing', href: '/billing' },
{ label: 'Invoices', href: '/billing/invoices' },
{ label: 'INV-2026-042', current: true }
]"
/>API Reference
Inputs and outputs are semver-sensitive public API. Keep examples aligned with this table.
Inputs
items [] readonly UiBreadcrumbItem[] Ordered hierarchy items with labels, optional links, and optional current state.
ariaLabel 'Breadcrumb' string Accessible name for the navigation landmark.
maxItems 0 number Maximum visible entries before middle items collapse; zero shows the complete hierarchy.
| Name | Type | Default | Description |
|---|---|---|---|
items | readonly UiBreadcrumbItem[] | [] | Ordered hierarchy items with labels, optional links, and optional current state. |
ariaLabel | string | 'Breadcrumb' | Accessible name for the navigation landmark. |
maxItems | number | 0 | Maximum visible entries before middle items collapse; zero shows the complete hierarchy. |
Outputs
itemSelected OutputEmitterRef<UiBreadcrumbSelection> Emits the selected linked item, source index, and native mouse event.
| Name | Type | Description |
|---|---|---|
itemSelected | OutputEmitterRef<UiBreadcrumbSelection> | Emits the selected linked item, source index, and native mouse event. |
Accessibility
- The component renders a named nav landmark containing an ordered list.
- Exactly one resolved item receives aria-current="page"; the final item is current when no item explicitly opts in.
- Chevron separators and the collapsed ellipsis are decorative and hidden from assistive technology.
Keyboard behavior
- Linked ancestors use native anchor behavior and remain reachable in document order.
- The current location is text rather than an inactive link, avoiding a misleading keyboard stop.
Testing guidance
- Use UiBreadcrumbHarness to read the hierarchy, identify the current item, detect collapse, and follow linked ancestors.
- Test complete, collapsed, explicit-current, long-label, single-item, and empty hierarchies.