Components/Navigation/Composer
Interactive docs page: https://wix-pages.com/design-system-documentation/#/component/composersidebar
Composer sidebar is a local navigation used to control the composer's settings panel.
<SidePanel/> settings.Control component size with `size` prop:
 - `large` - use it when the component needs to be emphasized.
 - `medium` (default) - use it in all default cases, especially if there are many (5 or more) items to show.
 - `small` - use in more dense layouts.
Control the position of a toggle button labels with `labelPlacement` prop. It supports 2 values:
 - `end` (default) - use it if there are many (5 or more) items to show. Button width depends on a label length but has a max width of 270 px. Label will be truncated if the limit is reached.
 - `bottom` - use it with few items to show. Component's width is fixed to 90 px.
 - `tooltip` - use it only for professional tools that users are good at and use side actions repeatedly. For example, image editing tools like color fill, text, shape, etc. Configure tooltip's placement and size with `labelTooltipProps`.
Use ellipsis prop to change between truncated or wrapped label.
Highlight currently selected item with `selectedId` prop.
Show that a certain action or category in a sidebar is not available with `disabled` prop.
Group related items together with sections using `sectionTitle` prop.
Keep up to 3 items, such as language or help, at the bottom edge of the sidebar with `pinToBottom`. Pinned items stay visible when the other items scroll, and they don't show a section title.
Use the composer sidebar to display available tools and settings in the composer environment.
Position it below the <ComposerHeader/> and fix it to the start of the remaining composer content area.
| Name | Type | Default | Description |
|---|---|---|---|
dataHook | string | — | Applies a data-hook HTML attribute to be used in the tests. |
ellipsis | boolean | true | Controls the ellipsis of the item label. |
items | ComposerSidebarItem[] | — | Defines an array of items, each a button with a label, to show on the sidebar: - label: text string next to a button - icon: icon shown in the toggle button - disabled: disables the item - onClick: defines what happens when the item is clicked on - sectionTitle: defines a section under which each item is placed - pinToBottom: pins the item to a group at the bottom edge of the sidebar. |
labelPlacement | "end" | "start" | "bottom" | "tooltip" | 'end' | Controls the items' label placement. |
labelTooltipProps | TooltipCommonProps | — | Controls the items' label tooltip when labelPlacement is set to tooltip. |
onClick | ComposerSidebarItemClickHandler | — | Defines a default click handler for items, called with the click event and the clicked item's id and label. |
ref | null | string | (instance: null) => void | RefObject<never> | — | Allows getting a ref to the component instance. Once the component unmounts, React will set ref.current to null (or call the ref with null if you passed a callback ref). |
selectedId | string | number | null | Defines which item is currently selected. |
size | string | 'medium' | Sets the size of the items. |
toggleButtonProps | ButtonAsButtonProps<{ className?: string | undefined; children?: ReactNode; skin?: ToggleButtonSkin | undefined; size?: "small" | "tiny" | "medium" | "large" | undefined; ... 10 more ...; tooltipDisabled?: boolean | undefined; }> | ButtonAsAnchorProps<{ className?: string | undefined; children?: ReactNode; skin?: ToggleButtonSkin | undefined; size?: "small" | "tiny" | "medium" | "large" | undefined; ... 10 more ...; tooltipDisabled?: boolean | undefined; }> | ButtonGenericProps<{ className?: string | undefined; children?: ReactNode; skin?: ToggleButtonSkin | undefined; size?: "small" | "tiny" | "medium" | "large" | undefined; ... 10 more ...; tooltipDisabled?: boolean | undefined; }> | ButtonAsComponentProps<{ className?: string | undefined; children?: ReactNode; skin?: ToggleButtonSkin | undefined; size?: "small" | "tiny" | "medium" | "large" | undefined; ... 10 more ...; tooltipDisabled?: boolean | undefined; }> | — | Applies additional props to every item's <ToggleButton/>, such as skin or shape. Sidebar props (size, labelPlacement, labelTooltipProps) and item state take precedence. |
width | string | number | — | Sets the width of the container. |
Import the driver matching your test environment:
| Method | Description |
|---|---|
getSelectedItemId | returns selected item id |
isItemDisabled | returns true if item is disabled |
clickOnItem | clicks on given item by id |
getItemLabel | returns item label value by id |
getLabelPlacement | returns label placement value |
getItemSectionTitle | returns item section title by id |
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. |
pinToBottom to items, which keeps an item in a group at the bottom edge of the sidebar that stays visible while the other items scroll. (#17606) — has visual changesToggleButtons non-interactive (#14560)Last updated: 30 October 2026