BreadcrumbDivider
Separator rendered between breadcrumb items. Defaults to "/" but accepts any text string or MDI icon identifier.
Structure
Anatomy
Visual breakdown of the component's internal structure with BEM class call-outs.
<origam-breadcrumb-divider> — root <span> ① hosts text or an <origam-icon> ② depending on whether divider is an MDI identifier.- 1.origam-breadcrumb-divider
- Root element (default:
<span>). Carries padding, color and density classes. Usually rendered inside a<li aria-hidden>from OrigamBreadcrumb. - 2(text or origam-icon)
- Content: raw text when
divideris a plain string;<origam-icon>when it is an MDI icon identifier (resolved viaMDI_ICONSenum check).
API
Props
All props accepted by this component, with their type, default value and description.
- Separator content. A plain string is rendered as text; an MDI icon identifier (e.g. "mdi-chevron-right") renders OrigamIcon.
- idstring
- classstring | Array<string> | object
- stylestring | Array<string> | object | StyleValue
- tagstring'span'
- HTML element rendered at the root. Defaults to <span> (aria-hidden on the parent <li>).
- paddingboolean | number | string
- 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
- 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
- Density modifier that adjusts the horizontal padding around the divider.
- color
- Foreground color of the divider glyph or icon.
- bgColor
- Background color of the divider element.
- Size of the divider (applies to icon mode via OrigamIcon).
API
Slots
Content slots exposed by this component.
- #default
- Full override of the divider content. When provided, the divider prop and icon/text logic are bypassed.
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 from the computed breadcrumbDividerStyles.
- string
- Unique style-sheet ID for this instance.
- () => void
- Injects the computed style sheet into the document.
- () => void
- Removes the injected style sheet.
- Ref<boolean>
- True once the style sheet has been injected into the DOM.
Customisation
CSS variables
CSS custom properties exposed by this component. Override them to customise the component without losing theme compatibility.
- Divider foreground color. Falls back to inherit so it matches the surrounding text by default.
- Divider background (transparent by default).
- Horizontal padding on both sides of the divider. Applied to both padding-inline-start and padding-inline-end.
- Divider opacity (1 by default).
- Density offset applied to padding calculations. comfortable: −8px, default: 0px, compact: +8px.
- Transition applied to transform and color properties.
Inclusion
Accessibility
ARIA roles, keyboard navigation and focus management. Sourced from the real component template.
Notes
- OrigamBreadcrumbDivider is aria-hidden by design — it is a purely visual separator and should not be read by screen readers. The aria-hidden attribute is applied on the parent <li> by OrigamBreadcrumb.
- The v-contrast directive is applied to the root element for automatic contrast adjustment when a custom color prop is provided.
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---secondary)
- Divider glyph color.
- dimensionvar(--origam-space---2)
- Horizontal padding around the divider character.
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.
Text divider
Icon divider
Custom slot
Ecosystem
Family
Components from the same folder that share conventions and often compose together.