Page.Header

Components/Layout/Page

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

Overview

Copy

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)
Copy

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

Copy

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

Copy

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.

Copy

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.

Copy

Editable

Let users edit the page title by rendering <EditableTitle/> as the title prop value.

Copy

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.

Copy

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.

Copy

Common use case examples

Copy

Add links to external resources that explain products or features in more detail by using inline <Box/> within the subtitle.

Copy

Inverted header

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

Copy

Code

Copy

Props

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

It receives minimized and hasBackgroundImage props.
backButtonAriaLabelstring—Defines a string value that labels the back button element.
breadcrumbsReactNode | 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.

For any custom enquiries, contact the Wix Design System team first.
dataHookstring—Applies a data-hook HTML attribute that can be used in the tests.
hasBackgroundImageboolean—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/>.
onBackClickedMouseEventHandler—Defines a callback function which is called every time a back button is clicked.
showBackButtonboolean—Specifies whether the back button is visible.
skin"light" | "dark"—Controls header skin (light or dark)
subtitleReactNode—Specifies page subtitle text.
titleReactNode | TitleRenderFn—Specifies page title text.

Testkit

Import the driver matching your test environment:

Copy

Driver methods

MethodDescription
hasClassChecks whether the PageHeader class exists
titleTextGets PageHeader title text
isTitleExistsChecks whether the PageHeader title exists
subtitleTextGets PageHeader subtitle text
isSubtitleExistsChecks whether the PageHeader subtitle exists
isBreadcrumbsExistsChecks whether the PageHeader breadcrumbs exists
breadcrumbsTextGets PageHeader breadcrumbs text
isActionBarExistsChecks whether the PageHeader action bar exists
isBackButtonExistsChecks whether the PageHeader back button exists
clickBackButtonClicks PageHeader back button
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.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)
  • 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, 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)
  • 1.299.0 (2026-07-17) — breaking: restyle back button to the close-button style (#16552)
  • 1.238.0 (2025-12-10) — feat: add aria-label for back button (#15646)

Last updated: 20 October 2026

Did this help?