Components/Navigation/Composer
Interactive docs page: https://wix-pages.com/design-system-documentation/#/component/composerheader
Composer header is a local navigation of a composer environment.
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.
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.
Add a shadow with `dropShadow` prop. It will replace the default bottom divider.
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.
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.
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.
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.
Include a Composer header on top of the composer environment.
Allow users to break the creation process into multiple steps by placing <Stepper/> inside the Composer header.
Use <ComposerSidebar.Actions/> container to store it.
| Name | Type | Default | Description |
|---|---|---|---|
backButtonValue | ReactNode | — | Defines the label of a back button. |
children | ReactNode | — | Accepts <ComposerHeader.Actions/> and <ComposerHeader.MainActions/> elements. Any other child isn't rendered. |
dataHook | string | — | Applies a data-hook HTML attribute to be used in the tests. |
dropShadow | boolean | — | Applies a drop shadow effect. |
onBackClick | MouseEventHandler | — | 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. |
Import the driver matching your test environment:
| Method | Description |
|---|---|
saveStatusExists | returns true if save status has been passed. Custom dataHook can be used |
getSaveStatusValue | — |
actionsExists | returns true if action exists. Requires dataHook. |
mainActionsExists | return true if main action exists |
backButtonExists | return true if backButton exists. |
getBackButtonText | returns back button value in string |
clickBack | clicks on 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. |
Last updated: 29 October 2026