Overview
Go Headless

Changelog

Wix Design System (WDS)
Introduction
About Wix Design System
Get started developing
Get started designing
Theming
Wix Design System AI

Guidelines
Themes
Interaction & Behavior
Guidelines
Localization

Patterns
Patterns Overview
Table Pattern
Grid Switch Pattern
Grid Pattern

Foundations
Tokens and Theming basics
Icon Theming

Contributing
AI-Assisted Development
Component Structure
Contributing to Wix Design System
Creating a New Component
Creating a Pull Request
Deprecating a Component
Documenting
Fixing a Bug
Test Drivers
Contributing Tokens
Token Migration Guidelines
Updating Props
Writing Tests

Components
Actions
Animations
Charts
Feedback
Form
Layout
Lists
Mechanisms
Media
Navigation
Breadcrumbs Component
ComposerHeader
Pagination Component
SidebarDividerNext
Stepper Component
Tabs Component
VerticalTabs
Overlays
Panels
Typography
In This Article

  1. Overview
  2. Code
  3. Testkit
  4. Changelog

Breadcrumbs

Components/Navigation

Interactive docs page: https://wix-pages.com/design-system-documentation/#/component/breadcrumbs

Overview

Copy

Breadcrumbs show the page a user is on within the site hierarchy and let them navigate back.

Do

  • Use it in pages that are arranged in site hierarchy.
  • Add breadcrumbs to deeper level pages (i.e. second, third, etc.).
  • Use it when users navigate between folders or lists.

Don't

  • Don't use it on first level pages.
  • Don't use it to show the progress of a task or process. Use <Stepper/> instead.

Feature examples

Size

Control the size of breadcrumbs with the size property. It supports 2 sizes:

  • medium is used by default in regular page layouts.
  • When it's necessary to emphasize the path, use large.
Copy

Theme

Control breadcrumbs' appearance with the theme prop. It supports 3 styles:

  • onGrayBackground is used by default with the default page header style.
  • Use onDarkBackground when breadcrumbs appear on a dark background or an image.
  • Use onWhiteBackground when breadcrumbs appear on a white background, for example in a modal.
Copy

Max width

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.

Copy

Disabled

Stop users from navigating to a particular breadcrumb item with the disabled property.

Copy

Common use case examples

Navigation between pages

Add breadcrumbs to <Page.Header/> to let users quickly navigate back to the previous page in the hierarchy.

Copy

Navigate between folders

Use breadcrumbs to let users navigate between folders and files.

Copy

Code

Copy

Props

NameTypeDefaultDescription
activeIdstring | number—Defines which breadcrumbs item is currently active.
dataHookstring—Applies a data-hook HTML attribute to be used in the tests.
itemMaxWidthstring | 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.

Testkit

Import the driver matching your test environment:

Copy

Driver methods

MethodDescription
breadcrumbsLengthGets number of breadcrumbs
breadcrumbContentAtGets breadcrumb content at position
clickBreadcrumbAtClicks on breadcrumb at position
getActiveItemIdGets the active breadcrumb position or null if no breadcrumb is active
isLargeChecks whether breadcrumbs are size large
isSmallChecks whether breadcrumbs are size small
isMediumChecks whether breadcrumbs are size medium
isOnWhiteBackgroundChecks whether breadcrumbs are on white background
isOnGrayBackgroundChecks whether breadcrumbs are on gray background
isOnDarkBackgroundChecks whether breadcrumbs are on dark background
isActiveLinkAtChecks whether breadcrumb at index is active
existsChecks whether the component found with the given data hook.
elementGets the component root element.
clickClicks on the component root element.
baseReturns UniDriver for the base element.

Changelog

  • 1.341.0 (2026-10-22) — maintenance release, no component-specific changes
  • 1.339.0 (2026-10-19) — maintenance release, no component-specific changes
  • 1.338.0 (2026-10-15) — maintenance release, no component-specific changes
  • 1.332.0 (2026-10-05) — maintenance release, no component-specific changes
  • 1.331.0 (2026-10-01) — maintenance release, no component-specific changes
  • 1.330.0 (2026-09-28) — maintenance release, no component-specific changes
  • 1.329.0 (2026-09-24) — maintenance release, no component-specific changes
  • 1.325.0 (2026-09-17) — maintenance release, no component-specific changes
  • 1.323.0 (2026-09-10) — maintenance release, no component-specific changes
  • 1.310.0 (2026-08-10) — maintenance release, no component-specific changes
  • 1.299.0 (2026-07-17) — breaking: update Harmony icon (#16557) — has visual changes
  • 1.299.0 (2026-07-17) — breaking: update tokens for Harmony theme (#16526) — has visual changes
  • 1.295.0 (2026-07-03) — maintenance release, no component-specific changes
  • 1.292.0 (2026-06-22) — maintenance release, no component-specific changes
  • 1.291.0 (2026-06-19) — maintenance release, no component-specific changes
  • 1.289.0 (2026-06-17) — maintenance release, no component-specific changes
  • 1.278.0 (2026-05-08) — feat: add on-grey text-fill-active token and update for odeditor-dark (#16226)
  • 1.277.0 (2026-05-07) — feat: change icon for Harmony theme (#16251)
  • 1.273.0 (2026-04-30) — maintenance release, no component-specific changes
  • 1.272.0 (2026-04-27) — maintenance release, no component-specific changes
  • 1.266.0 (2026-04-07) — maintenance release, no component-specific changes
  • 1.260.0 (2026-03-17) — maintenance release, no component-specific changes
  • 1.256.1 (2026-02-10) — maintenance release, no component-specific changes
  • 1.242.0 (2025-12-19) — feat: onClick handler includes event parameter (#15692)
  • 1.212.0 (2025-08-11) — maintenance release, no component-specific changes
  • 1.196.0 (2025-06-04) — maintenance release, no component-specific changes
  • 1.169.0 (2025-03-10) — maintenance release, no component-specific changes
  • 1.149.2 (2025-01-02) — breaking: add styles to breadcrumbs to studio token (#14410)
  • 1.115.0 (2024-07-17) — maintenance release, no component-specific changes
  • 1.102.0 (2024-04-16) — maintenance release, no component-specific changes
  • 1.93.0 (2024-02-08) — maintenance release, no component-specific changes
  • 1.92.1 (2024-02-05) — maintenance release, no component-specific changes

Last updated: 26 October 2026

Did this help?