> 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: Page.Header Component

## Article: Page.Header Component

## Article Link: https://dev.wix.com/docs/wix-design-system/components/layout/page/page-header-component.md

## Article Content:

# Page.Header

_Components/Layout/Page_

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

## Overview

```jsx
() => (
  <Page.Header
    actionsBar={
      <Box gap="12px">
        <Button skin="inverted">Cancel</Button>
        <Button>Save</Button>
      </Box>
    }
    breadcrumbs={
      <Breadcrumbs
        activeId="2"
        items={[
          { id: '1', value: 'Settings' },
          { id: '2', value: 'Inbox Settings' },
        ]}
        onClick={() => {}}
      />
    }
    title="Inbox Settings"
    subtitle="Manage Inbox & Chat preferences, set up channels and more"
    showBackButton
    onBackClicked={() => {}}
  />
);
```

The page header appears at the top of a page, orients the user and focuses their attention on the primary action to be taken.

### Do

- Use it only inside the `<Page/>` component.
- Provide a title for each page on the site. Use it to describe what the page is about.
- Keep the entire page header text visible at all times. Make sure it doesn't get truncated with an ellipsis.

### Don't

- Don't use it as a standalone component. Use it inside the `<Page/>` component.
- Don't use it for content sections. Use `<PageSection/>` instead.
- Don't use it for cards or other widgets. Use `<Heading/>` instead.

### Feature examples

#### Structure

Page header structures can vary, but they can include up to three elements:

- `title`
- `subtitle` (optional)
- `actionBar` (optional)

```jsx
<Page.Header
  title="Page Title"
  subtitle="Subtitle"
  actionsBar={
    <StorybookComponents.Placeholder width="300px">
      Action bar (optional)
    </StorybookComponents.Placeholder>
  }
/>;
```

#### Action bar

Place page actions on the right side of the header using the `actionsBar` prop.

Pages should only have one primary action. If more actions are needed, place them in a "More Actions" popover menu, which can be displayed from a `<Button/>` or `<IconButton/>`.

```jsx
<StorybookComponents.Stack flexDirection="column">
  <Page.Header
    title="Form Pages"
    actionsBar={
      <StorybookComponents.Stack gap="12px">
        <PopoverMenu
          triggerElement={
            <IconButton skin="inverted">
              <Icons.More />
            </IconButton>
          }
        >
          <PopoverMenu.MenuItem
            text="Duplicate"
            prefixIcon={<Icons.Duplicate />}
          />
          <PopoverMenu.MenuItem text="Delete" prefixIcon={<Icons.Delete />} />
        </PopoverMenu>
        <Button priority="secondary" skin="inverted">
          Cancel
        </Button>
        <Button>Save</Button>
      </StorybookComponents.Stack>
    }
  />
  <Page.Header
    title="Display Pages"
    actionsBar={
      <StorybookComponents.Stack gap="12px">
        <PopoverMenu
          triggerElement={
            <Button skin="inverted" suffixIcon={<Icons.ChevronDown />}>
              More Actions
            </Button>
          }
        >
          <PopoverMenu.MenuItem
            text="Export to CSV "
            prefixIcon={<Icons.DownloadImport />}
          />
          <PopoverMenu.MenuItem
            text="View analytics"
            prefixIcon={<Icons.Statistics />}
          />
        </PopoverMenu>
        <Button prefixIcon={<Icons.Add />}>Create New</Button>
      </StorybookComponents.Stack>
    }
  />
</StorybookComponents.Stack>;
```

#### Breadcrumbs

Display the path to this page with `breadcrumbs`, which let users navigate back to previous pages quickly.

```jsx
<Page.Header
  breadcrumbs={
    <Breadcrumbs
      activeId="4"
      items={[
        { id: '1', value: 'Page' },
        { id: '2', value: 'Page' },
        { id: '3', value: 'Page' },
        { id: '4', value: 'Current Page' },
      ]}
      onClick={() => {}}
    />
  }
  title="Current Page"
/>;
```

#### Back button

The `showBackButton` prop lets users navigate to the previous page in the site hierarchy. The back button should only be used when there are breadcrumbs.

```jsx
<Page.Header
  breadcrumbs={
    <Breadcrumbs
      activeId="4"
      items={[
        { id: '1', value: 'Page' },
        { id: '2', value: 'Page' },
        { id: '3', value: 'Page' },
        { id: '4', value: 'Current Page' },
      ]}
      onClick={() => {}}
    />
  }
  showBackButton
  onBackClicked={() => {}}
  title="Current Page"
/>;
```

#### Inverted

Invert the header styles with the `hasBackgroundImage` prop when using an image or dark-colored background.

This property only affects the styles of the title, subtitle, breadcrumbs and back button. Button styles must be changed manually.

```jsx
<StorybookComponents.Stack flexDirection="column">
  <Page.Header
    actionsBar={
      <StorybookComponents.Stack gap={12}>
        <Button skin="inverted">Secondary Action</Button>
        <Button>Main Action</Button>
      </StorybookComponents.Stack>
    }
    breadcrumbs={
      <Breadcrumbs
        activeId="3"
        items={[
          { id: '1', value: 'Page' },
          { id: '2', value: 'Page' },
          { id: '3', value: 'Standard Page Header' },
        ]}
        onClick={() => {}}
      />
    }
    onBackClicked={() => {}}
    showBackButton
    title="Standard Page Header"
    subtitle="Use the standard page header on white and light gray backgrounds."
  />
  <StorybookComponents.Background skin="dark">
    <Page.Header
      actionsBar={
        <StorybookComponents.Stack gap={12}>
          <Button skin="light" priority="secondary">
            Secondary Action
          </Button>
          <Button skin="light">Main Action</Button>
        </StorybookComponents.Stack>
      }
      breadcrumbs={
        <Breadcrumbs
          activeId="3"
          items={[
            { id: '1', value: 'Page' },
            { id: '2', value: 'Page' },
            { id: '3', value: 'Inverted Page Header' },
          ]}
          onClick={() => {}}
        />
      }
      hasBackgroundImage
      onBackClicked={() => {}}
      showBackButton
      title="Inverted Page Header"
      subtitle="Use an inverted header on image or dark colored backgrounds."
    />
  </StorybookComponents.Background>
</StorybookComponents.Stack>;
```

#### Editable

Let users edit the page title by rendering [`<EditableTitle/>`](https://wix-pages.com/design-system-documentation/#/component/editabletitle) as the `title` prop value.

```jsx
<Page.Header
  title={<EditableTitle initialValue="Click to edit this page title" />}
/>;
```

#### Overflow text

The page title is limited to a single line of text. The subtitle has a limit of 2 lines.

Longer values will be truncated with ellipses and the full text will be displayed in a tooltip on hover.

Note: Keeping all title text visible on the screen at all times is very important for accessibility and usability overall. Keep page titles short.

```jsx
<Page.Header
  title="This is a long page title which exceeds the limit of a single line"
  subtitle="This is an explanatory subtitle which exceeds the limit of two lines. Text that is longer than two lines will be hidden and can be previewed in a tooltip message only. Avoid long descriptions. If two lines are not enough, maybe this description should be part of the content instead."
/>;
```

#### Minimized

The page header minimizes automatically on scroll. You can also choose to use the minimized header manually with the `minimized` prop. The minimized version is displayed on top of the page content when users scroll down.

Breadcrumbs show in a minimized header instead of the page title when they're on a page.

```jsx
<StorybookComponents.Stack flexDirection="column">
  <Page.Header
    title="Minimized Page Title"
    minimized
    actionsBar={<Button>Action</Button>}
  />
  <Page.Header
    title="Minimized Page Title with Breadcrumbs"
    breadcrumbs={
      <Breadcrumbs
        activeId="3"
        items={[
          { id: '1', value: 'Page' },
          { id: '2', value: 'Page' },
          { id: '3', value: 'Minimized Page Title with Breadcrumbs' },
        ]}
        onClick={() => {}}
      />
    }
    minimized
    actionsBar={<Button>Action</Button>}
  />
</StorybookComponents.Stack>;
```

### Common use case examples

#### Sticky header

```jsx
<Page height="60vh">
  <Page.Header
    title="Subscriptions"
    subtitle="Manage all recurring payments coming to you from Pricing Plans, Stores & Invoices."
    actionsBar={<Button prefixIcon={<Icons.Add />}>Sell Pricing Plan</Button>}
  />
  <Page.Content>
    <Layout>
      <Cell span={12}>
        <Card>
          <Card.Header title="Statistics"></Card.Header>
          <Card.Divider />
          <Card.Content>
            <StatisticsWidget
              size="large"
              items={[
                {
                  value: '1',
                  description: 'Total subscriptions',
                },
                {
                  value: '-',
                  description: 'Active subscriptions',
                },
              ]}
            />
          </Card.Content>
        </Card>
      </Cell>
      <Cell span={12}>
        <Card>
          <TableToolbar>
            <TableToolbar.ItemGroup position="start">
              <TableToolbar.Item>
                <FormField labelPlacement="left" label="Type">
                  <Dropdown
                    size="small"
                    border="round"
                    options={[
                      { id: 0, value: 'All types' },
                      { id: 1, value: 'Pricing Plans' },
                      { id: 2, value: 'Invoices' },
                      { id: 3, value: 'Product Subscriptions' },
                    ]}
                    initialSelectedId={0}
                  />
                </FormField>
              </TableToolbar.Item>
              <TableToolbar.Item>
                <FormField labelPlacement="left" label="Status">
                  <Dropdown
                    size="small"
                    border="round"
                    options={[
                      { id: 0, value: 'All statuses' },
                      { id: 1, value: 'Paid' },
                      { id: 2, value: 'Unpaid' },
                      { id: 3, value: 'Failed payment' },
                    ]}
                    initialSelectedId={0}
                  />
                </FormField>
              </TableToolbar.Item>
            </TableToolbar.ItemGroup>
            <TableToolbar.ItemGroup position="end">
              <TableToolbar.Item>
                <Search size="small" />
              </TableToolbar.Item>
            </TableToolbar.ItemGroup>
          </TableToolbar>
          <Card.Divider />
          <Card.Content>
            <Box height="320px"></Box>
          </Card.Content>
        </Card>
      </Cell>
    </Layout>
  </Page.Content>
</Page>;
```

#### Subtitle links

Add links to external resources that explain products or features in more detail by using inline [`<Box/>`](https://wix-pages.com/design-system-documentation/#/component/box) within the subtitle.

```jsx
<Page.Header
  title="Pricing Plans"
  subtitle={
    <Text secondary>
      Set up subscriptions, memberships or package plans to sell on your site.
      <Box inline paddingLeft="SP1">
        <TextButton>Learn more</TextButton>
      </Box>
    </Text>
  }
  actionsBar={
    <Box gap="12px">
      <PopoverMenu
        minWidth="max-content"
        triggerElement={
          <Button skin="inverted" suffixIcon={<Icons.ChevronDown />}>
            More Actions
          </Button>
        }
      >
        <PopoverMenu.MenuItem
          text="Sell Plan Offline"
          prefixIcon={<Icons.PaidPlansSell />}
        />
        <PopoverMenu.MenuItem
          text="Purchased Plans"
          prefixIcon={<Icons.PaidPlans />}
        />
        <PopoverMenu.Divider />
        <PopoverMenu.MenuItem
          text="Payments & Tax"
          prefixIcon={<Icons.Payment />}
        />
        <PopoverMenu.MenuItem
          text="Manage Invoices"
          prefixIcon={<Icons.Invoice />}
        />
        <PopoverMenu.MenuItem
          text="Manage Automations"
          prefixIcon={<Icons.Automations />}
        />
      </PopoverMenu>
      <Button prefixIcon={<Icons.Add />}>Create Plan</Button>
    </Box>
  }
/>;
```

#### Inverted header

If `<Page/>` has a background image the `<Page.Header/>` style will automatically be inverted. Make sure to adjust button styles manually.

```jsx
<Page backgroundImageUrl="TravelExample3.jpg" height="60vh">
  <Page.Header
    title="Get Started with Your Forum"
    subtitle="Preview your site to navigate your forum. This is where you go to add, edit and delete posts and comments."
    actionsBar={
      <Box gap="SP2">
        <Button skin="light" priority="secondary">
          Cancel
        </Button>
        <Button skin="light">Save</Button>
      </Box>
    }
    showBackButton
    onBackClicked={() => {}}
    breadcrumbs={
      <Breadcrumbs
        activeId="2"
        items={[
          { id: '1', value: 'Categories' },
          { id: '2', value: 'Get Started with Your Forum' },
        ]}
        onClick={() => {}}
      />
    }
  />
  <Page.Content>
    <Layout>
      <Cell span={12}>
        <Card>
          <Card.Header title="Category info"></Card.Header>
          <Card.Divider />
          <Card.Content>
            <Box height="180px"></Box>
          </Card.Content>
        </Card>
      </Cell>
    </Layout>
  </Page.Content>
</Page>;
```

## Code

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

### Props

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `actionsBar` | `ReactNode \| ActionsBarRenderFn` | — | Adds an empty container on the right side of a header. Most commonly used to store primary and secondary actions of a page, but can contain any other element, i.e. dropdown selection.<br/> <br/> It receives `minimized` and `hasBackgroundImage` props. |
| `backButtonAriaLabel` | `string` | — | Defines a string value that labels the back button element. |
| `breadcrumbs` | `ReactNode \| BreadcrumbsRenderFn` | — | Adds an empty container above the page title. It accepts any item as a child element, but should be used to pass \<Breadcrumbs/> component only.<br/> <br/> For any custom enquiries, contact the Wix Design System team first. |
| `dataHook` | `string` | — | Applies a data-hook HTML attribute that can be used in the tests. |
| `hasBackgroundImage` | `boolean` | — | Inverts header styles. This property is supplied by \<Page/> component and reflects whether \<Page/> has a background image or not. |
| `minimized` *(required)* | `boolean` | — | Changes header appearance to a denser version. Value changes by the state of the scrolled content inside of a \<Page/>. |
| `onBackClicked` | `MouseEventHandler` | — | Defines a callback function which is called every time a back button is clicked. |
| `showBackButton` | `boolean` | — | Specifies whether the back button is visible. |
| `skin` | `"light" \| "dark"` | — | Controls header skin (light or dark) |
| `subtitle` | `ReactNode` | — | Specifies page subtitle text. |
| `title` | `ReactNode \| TitleRenderFn` | — | Specifies page title text. |

## Testkit

Import the driver matching your test environment:

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

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

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

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

### Driver methods

| Method | Description |
| --- | --- |
| `hasClass` | Checks whether the PageHeader class exists |
| `titleText` | Gets PageHeader title text |
| `isTitleExists` | Checks whether the PageHeader title exists |
| `subtitleText` | Gets PageHeader subtitle text |
| `isSubtitleExists` | Checks whether the PageHeader subtitle exists |
| `isBreadcrumbsExists` | Checks whether the PageHeader breadcrumbs exists |
| `breadcrumbsText` | Gets PageHeader breadcrumbs text |
| `isActionBarExists` | Checks whether the PageHeader action bar exists |
| `isBackButtonExists` | Checks whether the PageHeader back button exists |
| `clickBackButton` | Clicks PageHeader back button |
| `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.306.0** (2026-07-31) — fix: QA fixes for Harmony (odeditor) and Studio 2.0 (odeditor-dark) — the divider under the minimized (scrolled) header is removed; breadcrumbs in the header render at 12px, the inactive crumb color changed from `#151414` to `#525150` (odeditor) and from `#FFFFFF` to `#A8A6A5` (odeditor-dark), and the selected crumb renders at weight `500` per spec (unchanged in odeditor, changed from `700` in odeditor-dark); the subtitle gets a 4px gap below the title and 4px start padding; the EditableTitle text-to-marker gap changed from 6px to 4px. All other themes render unchanged. ([#16681](invalid-url))
- **1.305.1** (2026-07-30) — fix: restore the breadcrumbs' alignment with the page title. The compensating offset that cancelled the breadcrumb item's own horizontal padding was dropped in [#16552](invalid-url), which left the trail indented relative to the title. It is back as the themed `--wds-page-header-breadcrumbs-offset-small/medium/large` tokens and now uses `margin-inline-start`, so RTL is offset correctly too. Harmony (odeditor), Studio 2.0 (odeditor-dark) and Wixel are unaffected — their offset is `0`, matching their current rendering. ([#16690](invalid-url))
- **1.299.0** (2026-07-17) — breaking: restyle back button to the close-button style ([#16552](invalid-url))
- **1.238.0** (2025-12-10) — feat: add aria-label for back button ([#15646](invalid-url))