ComposerHeader

Components/Navigation/Composer

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

Overview

Copy

Composer header is a local navigation of a composer environment.

Do

  • Use it to navigate within a composer.
  • Use it to display actions and data related to the composer environment, such as content state, undo actions, etc.

Don't

  • Don't use it in layouts other than the composer.
  • Don't use it as a global navigation (top bar). Composer header exists together with global navigation and should be positioned right below it.

Feature examples

Structure

Composer header consists of 3 areas:
 - Back button on the left.
 - Additional actions container in the center.
 - Main actions container on the right.

There can be multiple containers with Additional actions in the middle. Available space will be evenly divided among them.

Note that all areas are optional.

Copy

Size

Control component height and back button size with `size` prop:
 - `medium` (default) - use it in all common cases. Height is fixed at 66 px.
 - `small` - use it to maximise space for the content area. Height is fixed at 54 px.

The Harmony theme has one header size, so size has no effect there.

size doesn't resize the items inside <ComposerHeader.MainActions/> and <ComposerHeader.Actions/>. Set their size yourself.

Copy

Shadow

Add a shadow with `dropShadow` prop. It will replace the default bottom divider.

Copy

Back Button

Add a back button by specifying its label with `backButtonValue` prop.

Button is added to the left side of a Composer header. Its position cannot be changed.

Copy

Main Actions

Add main actions as children items to <ComposerHeader.MainActions> container on the right side of the Composer header. Container position is fixed and cannot be changed.

In all common cases, use <Button/> and <TextButton/> components to display the actions.

Copy

Additional Actions

Add secondary actions or content to <ComposerHeader.Actions/> container in the middle of the Composer header.

Use justifyContent prop to distribute content inside the container. It accepts 3 values:

  • flex-start (default) - aligns items to the left.
  • center - centers items within the container.
  • flex-end - aligns items to the right.

Vertical dividers will be added automatically to separate primary and secondary actions.

Set hideOnMobile on an actions group to drop it when mobile is enabled on the design system provider. Use it for the secondary controls that do not survive a narrow header, and keep the main actions visible.

Copy

Save Status

Add a save status to the Composer header with a compound <ComposerHeader.SaveStatus/> component. Include it in the additional actions container, justified to the end.

Set save status label with `saveStatusValue` prop.

Change its status to error with `saveStatusError` prop.

Copy

Common use case examples

Composer

Include a Composer header on top of the composer environment.

Copy

Multiple Steps

Allow users to break the creation process into multiple steps by placing <Stepper/> inside the Composer header.

Use <ComposerSidebar.Actions/> container to store it.

Copy

Code

Copy

Props

NameTypeDefaultDescription
backButtonValueReactNode—Defines the label of a back button.
childrenReactNode—Accepts <ComposerHeader.Actions/> and <ComposerHeader.MainActions/> elements. Any other child isn't rendered.
dataHookstring—Applies a data-hook HTML attribute to be used in the tests.
dropShadowboolean—Applies a drop shadow effect.
onBackClickMouseEventHandler—Defines what happens when the back button is clicked.
size"small" | "medium"—Sets the height of the component and adjusts the size of the back button.

Testkit

Import the driver matching your test environment:

Copy

Driver methods

MethodDescription
saveStatusExistsreturns true if save status has been passed. Custom dataHook can be used
getSaveStatusValue—
actionsExistsreturns true if action exists. Requires dataHook.
mainActionsExistsreturn true if main action exists
backButtonExistsreturn true if backButton exists.
getBackButtonTextreturns back button value in string
clickBackclicks on 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.340.0 (2026-10-21) — 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.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.328.0 (2026-09-22) — maintenance release, no component-specific changes
  • 1.327.0 (2026-09-21) — maintenance release, no component-specific changes
  • 1.325.0 (2026-09-17) — maintenance release, no component-specific changes
  • 1.312.0 (2026-08-14) — maintenance release, no component-specific changes
  • 1.310.0 (2026-08-10) — 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.266.0 (2026-04-07) — maintenance release, no component-specific changes
  • 1.260.0 (2026-03-17) — maintenance release, no component-specific changes
  • 1.250.0 (2026-01-27) — maintenance release, no component-specific changes
  • 1.165.0 (2025-02-27) — maintenance release, no component-specific changes
  • 1.129.0 (2024-09-25) — maintenance release, no component-specific changes
  • 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.92.1 (2024-02-05) — maintenance release, no component-specific changes

Last updated: 29 October 2026

Did this help?