Breadcrumb
Hierarchical navigation trail rendered as a <nav> landmark with an ordered list of items and configurable dividers.
Preview
Rendering the live preview…
defaultRendering the live preview…
icon dividerRendering the live preview…
with colorStructure
Anatomy
Visual breakdown of the component's internal structure with BEM class call-outs.
<origam-breadcrumb> — root <nav> ①, ordered list ②, divider ③ and individual items ④. The last item is visually dimmed and aria-current="page".- 1.origam-breadcrumb
- Root
- 2.origam-breadcrumb__items
- flex row containing all item+divider pairs. list-style: none; margin-block: 0.
- 3.origam-breadcrumb__item
- wrapper for one item + its trailing divider. display: flex; align-items: center.
- 4.origam-breadcrumb__divider
- OrigamBreadcrumbDivider separator. aria-hidden. Not rendered after the last item.
API
Props
All props accepted by this component, with their type, default value and description.
- disabledbooleanfalse
- Disables all breadcrumb items. Propagated via OrigamDefaultsProvider.
- Divider character or MDI icon displayed between items. Propagated to OrigamBreadcrumbDivider via slotDefaults.
- Breadcrumb trail items. Accepts strings (converted to { title }) or full IBreadcrumbItemProps objects. The last item is automatically disabled and active.
- color
- Intent or custom foreground color propagated to all items.
- bgColor
- Background color of the breadcrumb container.
- tagstring'nav'
- HTML element rendered at the root. Defaults to <nav> for correct landmark semantics.
- idstring
- classstring | Array<string> | object
- stylestring | Array<string> | object | StyleValue
- Density modifier affecting padding and item sizing.
- Border-radius token or boolean for the container.
- roundedTopRightboolean | number | string
- roundedTopLeftboolean | number | string
- roundedBottomLeftboolean | number | string
- roundedBottomRightboolean | number | string
- roundedStartStartboolean | number | string
- roundedStartEndboolean | number | string
- roundedEndStartboolean | number | string
- roundedEndEndboolean | number | string
- paddingboolean | number | string
- Custom padding override.
- paddingTopboolean | number | string
- paddingLeftboolean | number | string
- paddingBottomboolean | number | string
- paddingRightboolean | number | string
- paddingBlockboolean | number | string
- paddingInlineboolean | number | string
- paddingInlineStartboolean | number | string
- paddingInlineEndboolean | number | string
- paddingBlockStartboolean | number | string
- paddingBlockEndboolean | number | string
- marginboolean | number | string
- Custom margin override.
- marginTopboolean | number | string
- marginLeftboolean | number | string
- marginBottomboolean | number | string
- marginRightboolean | number | string
- marginBlockboolean | number | string
- marginInlineboolean | number | string
- marginInlineStartboolean | number | string
- marginInlineEndboolean | number | string
- marginBlockStartboolean | number | string
- marginBlockEndboolean | number | string
- borderboolean | number | string | TDirectionBoth | Array<TDirectionBoth>false
- Applies a border to the breadcrumb container.
- borderTopboolean | number | string
- borderLeftboolean | number | string
- borderBottomboolean | number | string
- borderRightboolean | number | string
- borderBlockboolean | number | string
- borderInlineboolean | number | string
- borderInlineStartboolean | number | string
- borderInlineEndboolean | number | string
- borderBlockStartboolean | number | string
- borderBlockEndboolean | number | string
- borderColorstring
- borderStylestring
- borderTopColorTColor
- borderRightColorTColor
- borderBottomColorTColor
- borderLeftColorTColor
- borderInlineStartColorTColor
- borderInlineEndColorTColor
- borderBlockStartColorTColor
- borderBlockEndColorTColor
- elevationTElevation
- Box-shadow elevation token.
- hoverboolean | IStateEffectConfig
- hoverClassstring
- activeboolean | IStateEffectConfig
- activeClassstring
- CSS class applied to the active (last) breadcrumb item.
API
Slots
Content slots exposed by this component.
- #default
- Full override of the breadcrumb content. When present, items prop and the default <ol> are not rendered.
- #item
- Override every breadcrumb item. Receives the normalized item object and its index.
- #item.title
- Override the title content inside each OrigamBreadcrumbItem.
- #item.{index}
- Override a specific item by index.
- #divider
- Override every divider. Receives the current divider string/icon.
- #divider.{index}
- Override a specific divider by index.
API
Exposed members
Properties and methods accessible via template ref (defineExpose). Use them for programmatic control.
- <T extends object>(props: T, exclude?: string[]) => Partial<T>
- Utility to forward a filtered subset of props to child components.
- Ref<string>
- Reactive CSS string generated by useStyle.
- string
- Unique style-sheet ID for this instance.
- () => void
- Injects the computed style sheet.
- () => void
- Removes the injected style sheet.
- Ref<boolean>
- True once the style sheet has been injected.
Customisation
CSS variables
CSS custom properties exposed by this component. Override them to customise the component without losing theme compatibility.
- Default text color of the breadcrumb container.
- Container background (transparent by default).
- Block-start padding (density-adjusted at render time).
- Inline-start padding.
- Container border-radius. Overridden by rounded prop.
- Container box-shadow. Overridden by elevation.
- Default item text color.
- Item color on hover (link affordance).
- Color of the current-page item (last crumb).
- Divider glyph or icon color.
- Horizontal padding around the divider (breathing room between crumbs).
Inclusion
Accessibility
ARIA roles, keyboard navigation and focus management. Sourced from the real component template.
ARIA roles
Keyboard interactions
| Key | Action |
|---|---|
| Tab | Moves focus through each breadcrumb item link. |
| Enter | Follows the link of the focused breadcrumb item. |
Notes
- The root <nav> receives aria-label="Breadcrumb" from the useLocale translation (key: origam.breadcrumb.ariaLabel).
- The last item is automatically set to aria-current="page" via the isActive prop on OrigamBreadcrumbItem.
- OrigamBreadcrumbDivider is aria-hidden — the separators are purely presentational and not read by screen readers.
- The v-contrast directive is applied to the root for auto contrast when a custom color is set.
- Disabled items receive opacity-50 and pointer-events: none without the native disabled attribute (which does not apply to anchors).
Foundation
Design tokens
Excerpt from this component's token declarations — the --origam-<component>---<property> variables, declared in its hand-maintained token sheet with no build step.
- colorvar(--origam-color__text---primary)
- Container text color.
- colorrgba(0, 0, 0, 0)
- Container background.
- colorvar(--origam-color__action--primary---bg)
- Item color on hover.
- colorvar(--origam-color__text---secondary)
- Current-page item color.
- colorvar(--origam-color__text---secondary)
- Divider color.
- dimensionvar(--origam-space---2)
- Divider horizontal padding.
Interactive
Playground
Edit props live and see the component update in real time. The generated code snippet updates as you change values.
Rendering the live preview…
Usage
Examples
Ready-to-paste code snippets for your templates.
Basic breadcrumb
With router links
Custom divider slot
Ecosystem
Family
Components from the same folder that share conventions and often compose together.