> To build a Wix site agentically, or add Wix features like bookings or a store to a site you already have, follow https://www.wix.com/headless/skill.md
> 
> Portal Navigation:
> 
> - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version.
> - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages).
> - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`).
> - If a reference page seems to be missing its schema (parameters, return types, or type definitions), append `?schema=true` to its `.md` URL (e.g. `https://dev.wix.com/docs/contexts/contexts/stores/category-info/use-category-info-context.md?schema=true`).
> - Top-level index of all portals: https://dev.wix.com/docs/llms.txt
> - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt

## Resource: Breadcrumbs Component

## Article: Breadcrumbs Component

## Article Link: https://dev.wix.com/docs/wix-design-system/components/navigation/breadcrumbs-component.md

## Article Content:

# Breadcrumbs

_Components/Navigation_

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

## Overview

```jsx
<Box align="center">
  <Breadcrumbs
    items={[
      { id: 0, value: 'Store' },
      { id: 1, value: 'Products' },
      { id: 2, value: 'Blue Jeans' },
    ]}
    activeId={2}
  />
</Box>;
```

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`.

```jsx
<StorybookComponents.Stack flexDirection="column">
  <Breadcrumbs
    items={[
      { id: 0, value: 'Medium' },
      { id: 1, value: 'Medium' },
      { id: 2, value: 'Medium' },
    ]}
    size="medium"
    activeId={2}
  />
  <Breadcrumbs
    items={[
      { id: 0, value: 'Large' },
      { id: 1, value: 'Large' },
      { id: 2, value: 'Large' },
    ]}
    size="large"
    activeId={2}
  />
</StorybookComponents.Stack>;
```

#### 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.

```jsx
<StorybookComponents.Stack flexDirection="column">
  <StorybookComponents.Stack padding="24px">
    <Breadcrumbs
      theme="onGrayBackground"
      items={[
        { id: 0, value: 'On grey background' },
        { id: 1, value: 'On grey background' },
        { id: 2, value: 'On grey background' },
      ]}
      activeId={2}
    />
  </StorybookComponents.Stack>
  <StorybookComponents.Background skin="dark">
    <StorybookComponents.Stack padding="24px">
      <Breadcrumbs
        theme="onDarkBackground"
        items={[
          { id: 0, value: 'On dark background' },
          { id: 1, value: 'On dark background' },
          { id: 2, value: 'On dark background' },
        ]}
        activeId={2}
      />
    </StorybookComponents.Stack>
  </StorybookComponents.Background>
  <StorybookComponents.Background skin="light">
    <StorybookComponents.Stack padding="24px">
      <Breadcrumbs
        theme="onWhiteBackground"
        items={[
          { id: 0, value: 'On white background' },
          { id: 1, value: 'On white background' },
          { id: 2, value: 'On white background' },
        ]}
        activeId={2}
      />
    </StorybookComponents.Stack>
  </StorybookComponents.Background>
</StorybookComponents.Stack>;
```

#### 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`.

```jsx
() => {
  const items = [
    { id: 0, value: 'Title' },
    { id: 1, value: 'Title' },
    {
      id: 2,
      value: 'Long title is truncated when default maximum width is reached',
    },
    { id: 3, value: 'Title' },
  ];

  return (
    <StorybookComponents.Stack flexDirection="column">
      <Breadcrumbs items={items} activeId={3} itemMaxWidth="150px" />
      <Breadcrumbs items={items} activeId={3} />
      <Breadcrumbs items={items} activeId={3} itemMaxWidth="max-content" />
    </StorybookComponents.Stack>
  );
};
```

#### Disabled

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

```jsx
<Breadcrumbs
  items={[
    { id: 0, value: 'Title (Disabled)', disabled: true },
    { id: 1, value: 'Title' },
    { id: 2, value: 'Title' },
    { id: 3, value: 'Title' },
  ]}
  activeId={3}
/>;
```

### Common use case examples

#### Navigation between pages

Add breadcrumbs to [`<Page.Header/>`](https://wix-pages.com/design-system-documentation/#/component/page-header) to let users quickly navigate back to the previous page in the hierarchy.

```jsx
<Page.Header
  title="Appointment Hours"
  subtitle="Set default hours for when you and your staff are available to take appointments."
  breadcrumbs={
    <Breadcrumbs
      activeId="3"
      items={[
        { id: '1', value: 'Home', link: '' },
        { id: '2', value: 'Booking Settings', link: '' },
        { id: '3', value: 'Appointment Hours', link: '' },
      ]}
      onClick={() => {}}
    />
  }
  showBackButton
  onBackClicked={() => {}}
  actionsBar={
    <StorybookComponents.Stack gap="12px">
      <Button skin="inverted">Cancel</Button>
      <Button>Save</Button>
    </StorybookComponents.Stack>
  }
/>;
```

#### Navigate between folders

Use breadcrumbs to let users navigate between folders and files.

```jsx
() => {
  const renderThumbnail = (backgroundImage) => (
    <Cell span={2}>
      <Thumbnail
        backgroundImage={backgroundImage}
        title={
          <Text secondary size="tiny">
            {backgroundImage}
          </Text>
        }
        height={132}
      />
    </Cell>
  );

  return (
    <CustomModalLayout
      title="Choose images"
      onCloseButtonClick={() => {}}
      removeContentPadding={true}
      showHeaderDivider
      content={
        <Box>
          <Box>
            <SidebarNext
              skin="neutral"
              isLoading={false}
              selectedKey="2"
              header={
                <SidebarHeaderNext>
                  <Button prefixIcon={<Icons.Add />}>Upload Media</Button>
                </SidebarHeaderNext>
              }
            >
              <SidebarItemNext itemKey="1">Home</SidebarItemNext>
              <SidebarDividerNext />
              <SidebarTitleItemNext>Manage</SidebarTitleItemNext>
              <SidebarItemNext itemKey="2">Site Files</SidebarItemNext>
              <SidebarItemNext itemKey="3">My Boards</SidebarItemNext>
              <SidebarItemNext itemKey="4">Trash</SidebarItemNext>
              <SidebarDividerNext />
              <SidebarTitleItemNext>Explore</SidebarTitleItemNext>
              <SidebarItemNext itemKey="5">Media from Wix</SidebarItemNext>
              <SidebarItemNext itemKey="6">Shutterstock</SidebarItemNext>
              <SidebarItemNext itemKey="7">Unsplash</SidebarItemNext>
            </SidebarNext>
          </Box>
          <Box direction="vertical" width="100%">
            <Box direction="vertical" padding="24px">
              <Search />
            </Box>
            <Box padding="0px 24px 24px 24px">
              <Breadcrumbs
                theme="onWhiteBackground"
                items={[
                  { id: 0, value: 'Site Files', link: '' },
                  { id: 1, value: 'Stores', link: '' },
                  { id: 2, value: 'Product images', link: '' },
                  { id: 3, value: 'Photos', link: '' },
                ]}
                activeId={3}
              />
            </Box>
            <Box padding="0px 24px">
              <Layout>
                {renderThumbnail('ProductExample1.jpg')}
                {renderThumbnail('ProductExample2.jpg')}
                {renderThumbnail('ProductExample3.jpg')}
                {renderThumbnail('ProductExample4.jpg')}
                {renderThumbnail('ProductExample5.jpg')}
                {renderThumbnail('ProductExample6.jpg')}
                {renderThumbnail('ProductExample7.jpg')}
                {renderThumbnail('ProductExample8.jpg')}
              </Layout>
            </Box>
            <Box paddingTop="60px">
              <Divider />
            </Box>
            <Box padding="12px 24px" align="right">
              <Box>
                <Button>Add to Page</Button>
              </Box>
            </Box>
          </Box>
        </Box>
      }
    />
  );
};
```

## Code

```jsx
import { Breadcrumbs } from '@wix/design-system';
```

### Props

| 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. |

## Testkit

Import the driver matching your test environment:

```jsx
// UniDriver
import { BreadcrumbsUniDriver } from '@wix/design-system/dist/testkit/unidriver';

// Vanilla
import { BreadcrumbsTestkit } from '@wix/design-system/dist/testkit';

// Puppeteer
import { BreadcrumbsTestkit } from '@wix/design-system/dist/testkit/puppeteer';

// Testing Library
import { BreadcrumbsTestkit } from '@wix/design-system/dist/testkit/testing-library';
```

### Driver methods

| 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. |

## 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](invalid-url)) — has visual changes
- **1.299.0** (2026-07-17) — breaking: update tokens for Harmony theme ([#16526](invalid-url)) — 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](invalid-url))
- **1.277.0** (2026-05-07) — feat: change icon for Harmony theme ([#16251](invalid-url))
- **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](invalid-url))
- **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](invalid-url))
- **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