Skip to main content

Interface: BreadcrumbsProps

Defined in: components/Breadcrumbs.tsx:11

Properties​

categoryPath​

categoryPath: Category[]

Defined in: components/Breadcrumbs.tsx:16

The category path from the category, product or cluster response. Obtain from category.categoryPath or product.category.categoryPath.

className?​

optional className?: string

Defined in: components/Breadcrumbs.tsx:80

Extra CSS class applied to the root element.

configuration?​

optional configuration?: any

Defined in: components/Breadcrumbs.tsx:83

Configuration object passed to the component

currentCategory?​

optional currentCategory?: Category

Defined in: components/Breadcrumbs.tsx:34

The category of the current page. When provided and not already the last item in categoryPath, it is appended automatically so the trail always ends at the current category. This makes the component correct whether the API's categoryPath includes the current category or only its ancestors.

currentLabel?​

optional currentLabel?: string

Defined in: components/Breadcrumbs.tsx:42

Optional trailing crumb appended after the category path — typically the name of the current product or cluster on a detail page. When provided, this crumb is marked as the current page and the last category becomes a normal link.

currentUrl?​

optional currentUrl?: string

Defined in: components/Breadcrumbs.tsx:48

Optional URL for the trailing currentLabel crumb. When omitted, the crumb is rendered as a non-link <span>.

getUrl?​

optional getUrl?: (category, index) => string

Defined in: components/Breadcrumbs.tsx:71

Custom URL builder for category links. Receives the Category object and its zero-based index in the path. When omitted, URLs default to /category/{categoryId}/{slug}.

Parameters​

category​

Category

index​

number

Returns​

string

homeUrl?​

optional homeUrl?: string

Defined in: components/Breadcrumbs.tsx:58

URL for the Home link. Defaults to '/'.

labels?​

optional labels?: Record&lt;string, string>

Defined in: components/Breadcrumbs.tsx:77

Override any UI string. Available keys: home, separator

language?​

optional language?: string

Defined in: components/Breadcrumbs.tsx:64

Language code used to resolve localised category names and slugs. Defaults to 'NL'.

showCurrent?​

optional showCurrent?: boolean

Defined in: components/Breadcrumbs.tsx:25

When true (default), the last item in the path is displayed as the current page (non-clickable, aria-current="page"). When false, the last item is omitted. Ignored when currentLabel is provided — the extra crumb becomes the current page instead.

showHome?​

optional showHome?: boolean

Defined in: components/Breadcrumbs.tsx:53

When true (default), a "Home" link is prepended to the trail.