Props
| Name | Description |
|---|---|
disabled Type: booleanDefaultfalse | Disables the component On the component it freezes every crumb and the overflow button; per item it drops that crumb's |
dividerWidth Type: numberDefault16 | Width of the divider in pixels. Estimation only: it does not resize anything. The default moved from |
ellipsisWidth Type: number | Explicit width used by the estimator for the ellipsis activator. The width reserved for the overflow trigger. Set it whenever the |
estimationBias Type: numberDefault1.12 | Multiplier applied to each estimated item width. A higher value will result in more over-estimation. A multiplier on every estimated item width. Raise it when crumbs clip before folding (a wider custom font is the usual cause), and lower it when the trail folds too eagerly. See example |
gapWidth Type: numberDefault4 | Horizontal gap between breadcrumb elements in pixels. Drives the rendered gap and the estimate at once, so changing it here is the supported way to retune the spacing. See example |
items requiredType: BbBreadcrumbsItem[] | Array of items that describe how the breadcrumbs should behave. Compatible with navigating through Each item is |
offsetWidth Type: numberDefault0 | Extra one-off width in pixels added to the total estimate (e.g. prepend/append/item slot content). The knob you actually reach for. Slot and icon content is invisible to the estimator, so declare its total here rather than shrinking the trail with CSS. See example |
pt Type: PtMap<BbBreadcrumbsPtPart, BbBreadcrumbsPtState> | Passthrough, object form: the same keys as the |
pt:<part> Type: PtValue | Passthrough, attribute form: one attribute per part, |
Slots
The listed properties are the ones exposed to the slot scope.
| Name | Description |
|---|---|
<value> Type: BbBreadcrumbsItemSlotProps | One crumb's label, by its Named by the crumb's |
<value>:append Type: BbBreadcrumbsItemSlotProps | The glyph after one crumb's label; beats |
<value>:prepend Type: BbBreadcrumbsItemSlotProps | The glyph before one crumb's label; beats Content inside the link, so keep it non-interactive and mark a decorative mark |
append Type: BbBreadcrumbsEdgeSlotProps | Content rendered after the breadcrumb list, in a dedicated append region. The natural home for compact page actions on a detail header. Keep them |
divider Type: Record<string, never> | Replaces the default separator rendered between breadcrumb items. The only way to change the separator: the v2 |
ellipsis Type: BbBreadcrumbsEllipsisSlotProps | Replaces the default Repaints the overflow trigger, which stays a real button with a localized, count-aware label and a keyboard-complete menu. The scope carries |
item:append Type: BbBreadcrumbsItemSlotProps | Content rendered after every breadcrumb item's link/button. Generic fallback below a per-item Same precedence as |
item:prepend Type: BbBreadcrumbsItemSlotProps | Content rendered before every breadcrumb item's link/button, in the leading edge region. Generic fallback: a per-item The generic fallback for every crumb. A per-crumb |
prepend Type: BbBreadcrumbsEdgeSlotProps | Content rendered before the breadcrumb list, in a dedicated prepend region. A fixed region before the whole trail, not before each crumb: a hint, a workspace mark. Account for its width with |
Renamed and removed
Names from v2 and from earlier 3.0 betas that no longer work, and what to write instead.
- item field
items[].keyitems[].valuefails silentlyA crumb's identity, naming its
#<value>slots;check --fixrenames it. - item field
items[].textitems[].labelfails silentlyA crumb's text;
check --fixrenames it.