Components/Navigation
Interactive docs page: https://wix-pages.com/design-system-documentation/#/component/breadcrumbs
Breadcrumbs show the page a user is on within the site hierarchy and let them navigate back.
<Stepper/> instead.Control the size of breadcrumbs with the size property. It supports 2 sizes:
medium is used by default in regular page layouts.large.Control breadcrumbs' appearance with the theme prop. It supports 3 styles:
onGrayBackground is used by default with the default page header style.onDarkBackground when breadcrumbs appear on a dark background or an image.onWhiteBackground when breadcrumbs appear on a white background, for example in a modal.Control when a breadcrumb item gets truncated with the itemMaxWidth property. When truncated, the breadcrumb item shows an ellipsis and the full text appears in a tooltip on hover.
Default max width is 240 px.
Avoid truncating breadcrumb items at all by setting max width to max-content.
Stop users from navigating to a particular breadcrumb item with the disabled property.
Add breadcrumbs to <Page.Header/> to let users quickly navigate back to the previous page in the hierarchy.
Use breadcrumbs to let users navigate between folders and files.
| Name | Type | Default | Description |
|---|---|---|---|
activeId | string | number | — | Defines which breadcrumbs item is currently active. |
dataHook | string | — | Applies a data-hook HTML attribute to be used in the tests. |
itemMaxWidth | string | number | string & {} | '240px' | Sets the maximum width of each item value in px. Longer items get truncated with ellipsis. |
items (required) | BreadcrumbsItem[] | — | Describes each breadcrumbs item: - id (required) - gives an item numeric identifier - value (required) - sets the item label to be shown on breadcrumbs - link - stores a link which user is directed to after clicking on an item - customElement - contains and renders a custom component or <a> link instead of an item value - disabled - disables an item |
onClick | (item: BreadcrumbsItem, event: MouseEvent<HTMLElement, MouseEvent>) => any | — | Defines a function which is called when a user clicks on an item. |
size | "small" | "medium" | "large" | 'medium' | Controls the component size. |
skin | "onGrayBackground" | "onWhiteBackground" | "onDarkBackground" | — | Controls the component appearance. |
theme | "onGrayBackground" | "onWhiteBackground" | "onDarkBackground" | — | Controls the component appearance. |
Import the driver matching your test environment:
| Method | Description |
|---|---|
breadcrumbsLength | Gets number of breadcrumbs |
breadcrumbContentAt | Gets breadcrumb content at position |
clickBreadcrumbAt | Clicks on breadcrumb at position |
getActiveItemId | Gets the active breadcrumb position or null if no breadcrumb is active |
isLarge | Checks whether breadcrumbs are size large |
isSmall | Checks whether breadcrumbs are size small |
isMedium | Checks whether breadcrumbs are size medium |
isOnWhiteBackground | Checks whether breadcrumbs are on white background |
isOnGrayBackground | Checks whether breadcrumbs are on gray background |
isOnDarkBackground | Checks whether breadcrumbs are on dark background |
isActiveLinkAt | Checks whether breadcrumb at index is active |
exists | Checks whether the component found with the given data hook. |
element | Gets the component root element. |
click | Clicks on the component root element. |
base | Returns UniDriver for the base element. |
Last updated: 26 October 2026