Skip to content
Navigation

Breadcrumbs

client21 kB
@stellaria/nebula-webBreadcrumbsProps

Preview

Props

6
PropTypeDefault

className

string

collapseFrom

How many items it takes before the middle ones collapse. `0` turns collapsing off.

number5

items

required
readonly BreadcrumbItem[]

labels

Partial<BreadcrumbsLabels>

separator

ReactNode"/"

size

"sm" | "md""md"

Slot props

6

Each one spreads over an inner element, so you can restyle a region without forking the component.

PropTypeDefault

currentProps

The current crumb, which carries `aria-current` and is not a link.

BoxSlotProps

expandProps

The button that reveals the hidden crumbs. It only appears when the trail collapses.

Omit<DetailedHTMLProps<ButtonHTMLAttributes<HTMLButtonElement>, HTMLButtonElement>, "ref">

itemProps

Every crumb. It spreads over ALL of them, including the ellipsis one.

BoxSlotProps

linkProps

The navigable crumbs. It does not land on the current one. Their element comes from the `component` of each item, or from its `href`: with `href` it is an `a`, without it a `button`. It does not go through `Box`, so it does not accept style props.

Omit<DetailedHTMLProps<AnchorHTMLAttributes<HTMLAnchorElement>, HTMLAnchorElement>, "ref">

listProps

The list.

BoxSlotProps

separatorProps

The separator. It spreads over all of them; the last one is not rendered.

BoxSlotProps

Also accepts

On top of its own props, this component forwards these groups.

Style props · 127