ComposerSidebar

Components/Navigation/Composer

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

Overview

Copy

Composer sidebar is a local navigation used to control the composer's settings panel.

Do

  • Use it to list the categories of composer's <SidePanel/> settings.

Don't

  • Don't use it in layouts other than the composer.

Feature examples

Size

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.

Copy

Label Placement

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

Copy

Ellipsis

Use ellipsis prop to change between truncated or wrapped label.

Copy

Selected Item

Highlight currently selected item with `selectedId` prop.

Copy

Disabled Item

Show that a certain action or category in a sidebar is not available with `disabled` prop.

Copy

Section Title

Group related items together with sections using `sectionTitle` prop.

Copy

Pinned Items

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.

Copy

Common use case examples

Composer Settings

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.

Copy

Code

Copy

Props

NameTypeDefaultDescription
dataHookstring—Applies a data-hook HTML attribute to be used in the tests.
ellipsisbooleantrueControls the ellipsis of the item label.
itemsComposerSidebarItem[]—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.
labelTooltipPropsTooltipCommonProps—Controls the items' label tooltip when labelPlacement is set to tooltip.
onClickComposerSidebarItemClickHandler—Defines a default click handler for items, called with the click event and the clicked item's id and label.
refnull | 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).
selectedIdstring | numbernullDefines which item is currently selected.
sizestring'medium'Sets the size of the items.
toggleButtonPropsButtonAsButtonProps<{ 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.
widthstring | number—Sets the width of the container.

Testkit

Import the driver matching your test environment:

Copy

Driver methods

MethodDescription
getSelectedItemIdreturns selected item id
isItemDisabledreturns true if item is disabled
clickOnItemclicks on given item by id
getItemLabelreturns item label value by id
getLabelPlacementreturns label placement value
getItemSectionTitlereturns item section title by id
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.345.0 — feat: added 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 changes
  • 1.344.0 (2026-10-28) — maintenance release, no component-specific changes
  • 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.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.326.0 (2026-09-17) — maintenance release, no component-specific changes
  • 1.325.0 (2026-09-17) — maintenance release, no component-specific changes
  • 1.320.0 (2026-09-03) — maintenance release, no component-specific changes
  • 1.310.0 (2026-08-10) — maintenance release, no component-specific changes
  • 1.303.0 (2026-07-23) — 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.258.0 (2026-02-23) — fix: add arrow navigation (#15929) — has visual changes
  • 1.250.0 (2026-01-27) — maintenance release, no component-specific changes
  • 1.247.2 (2026-01-21) — maintenance release, no component-specific changes
  • 1.208.0 (2025-07-25) — maintenance release, no component-specific changes
  • 1.172.1 (2025-03-21) — fix: enable interactivity of toggle buttons (#14650)
  • 1.165.0 (2025-02-27) — fix: make selected ToggleButtons non-interactive (#14560)
  • 1.138.1 (2024-10-30) — maintenance release, no component-specific changes
  • 1.123.0 (2024-08-26) — feat: add ellipsis prop (#14052)
  • 1.104.0 (2024-05-06) — fix: new padding for small size (#13693)
  • 1.103.1 (2024-04-24) — maintenance release, no component-specific changes
  • 1.103.0 (2024-04-23) — fix: inner container now matches root container width properly (#13619)
  • 1.102.0 (2024-04-16) — maintenance release, no component-specific changes
  • 1.100.0 (2024-04-04) — feat: width prop added (#13548)
  • 1.92.1 (2024-02-05) — maintenance release, no component-specific changes

Last updated: 30 October 2026

Did this help?