SidePanel

Components/Overlays

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

Overview

Copy

Side panel is a component that presents supplementary information, navigation options, or controls alongside or overlaying the main content of the page.

Do

  • Display supplementary actions or settings that affect the main page content, such as data filters.
  • Display tools that can be used on the page.
  • Provide more details in context.
  • Let users interact with the main page while the side panel is open.

Don't

  • Don't display content while blocking interactions on the main page. Use <Modal/> instead.

Feature examples

Structure

Side panels are composed of up to four compound components:

  • <SidePanel.Header/>
  • <SidePanel.Content/>
  • <SidePanel.Divider/>
  • <SidePanel.Footer/>

All of these components are optional.

Copy

Skin

Control the component style with skin prop:

  • standard is the default style used in all common cases.
  • floating is used for settings panels that float on top of content in editor platforms (Wix or Wix Studio).
Copy

Width

Set the side panel's width using the width property. The default width is 420px.

Copy

Height

By default, panel height depends on the amount of content it contains. To define the maximum height it can grow to use maxHeight property.

Fix the panel height to a specific number with height property.

Copy

Padding

Content padding is enabled in the side panel by default, but can be disabled with the noPadding property for:

  • <SidePanel.Header/>
  • <SidePanel.Content/>
  • <SidePanel.Footer/>

The padding can be removed to display lists or other components with built-in padding.

Copy

Dividers

Dividers are enabled in the side panel by default but can be disabled using the showDivider property for:

  • <SidePanel.Header/>
  • <SidePanel.Footer/>

Always show dividers in the side panel if users have the option to scroll vertically inside the panel.

Copy

Customize the side panel's header using these properties:

  • title
  • subtitle
Copy

Header Actions

Header has these properties for actions available:

  • infoTooltipContent - provides additional details or an explanation in a tooltip
  • onHelpButtonClick- allows users to access help articles and contextual information
  • onBackButtonClick- allows users to navigate back in the Side Panel
  • backButtonDescription - sets content of the back button's tooltip
Copy

Custom header

Create a custom header layout by adding children elements to the <SidePanel.Header/> container.

Copy

Text overflow

Panel title and subtitle wraps to multiple lines by default. Limit the amount of lines using ellipsis and maxLines properties.

Ellipsis do not apply to the subtitle, as its main purpose is to provide more information.

Copy

Content sections

Create sections inside of a panel by adding multiple <SidePanel.Content/> areas.

Separate them from one another with a dedicated <SidePanel.Divider/> element.

Copy

Content fields

Separate controls inside of a panel from one another by wrapping each one into <SidePanel.Field/> container.

Copy

To display confirmation or close actions use the <SidePanel.Footer/> container.

Copy

Draggable

Let users know that panel position on the screen can be changed by changing the mouse cursor to grab with draggable property.

The behaviour itself has to be developed separately.

Copy

Mobile examples

Mobile usage

Keep <SidePanel/> as the layout of the panel and change only its container per screen. On desktop the panel slides in over the page from an absolutely positioned wrapper, as in the common use cases above. On mobile the same panel renders inside a bottom <Drawer/> that is non-modal and has no backdrop, so the page behind it stays visible and usable while users adjust settings. The panel takes the height of its content, capped by maxHeight, so the footer actions are always in view and longer content scrolls inside <SidePanel.Content/>.

Set dismissible and resizable to false so a tap on the page does not close the panel and there is no drag handle. Closing goes through the panel's close button and footer actions on both screens.

To see the change, toggle 'Enable mobile support' in the top bar of Storybook.

Copy

Common use case examples

Settings panel

Use side panel to create settings panels that allow users to control the design and behavior aspects of their app.

Copy

Group content in settings panels

Use <SidePanel.Section/> wrapper to organize panel info into categories.

It will make the whole panel easier to scan.

Copy

Data filter

Use side panels to display data filters. When opened, the panels should slide in from the right side of the screen. Add close buttons in the header and/or footer that can be used to close the panel.

Copy

Quick view

Use side panels to provide quick views of list items.

Panels can either push the page content aside or overlay it, depending on the use case:

  • Overlay content when part of the page's content can be covered.
  • Push content aside when the user should see all the information and actions on the main page.
Copy

Composer actions

Use side panels to display composer settings and actions. These should be anchored to the left edge of the screen since they're opened through the <ComposerSidebar/>.

Copy

Code

Copy

Props

NameTypeDefaultDescription
backButtonDescriptionReactNode—When provided, sets the content of the back button's tooltip.
backButtonPropsSidePanelBackButtonProps—Back button props.
backButtonTooltipPropsTooltipCommonProps—Allows to pass all common tooltip props to back button's tooltip.
border"end" | "start"—Applies a border to the chosen side of the panel (works only with standard skin).
buttonTextstring—Has no effect. <SidePanel/> doesn't render it.
childrenReactNode—Accepts any item as a child element. For standard panel layout pass compound elements of the panel: * <SidePanel.Header/> * <SidePanel.Content/> * <SidePanel.Footer/> * <SidePanel.Divider/>
closeButtonPropsSidePanelCloseButtonProps—Close button props.
dataHookstring—Applies a data-hook HTML attribute to be used in the tests.
draggableboolean—Specifies if panel is draggable (works only with floating skin).
heightstring | number'100%'Controls the height of the panel.
helpButtonPropsSidePanelButtonProps—Help button props.
hideOverflowboolean—Hides all overflow of side panel.
maxHeightstring | number—Controls the maximum height of the panel.
onBackButtonClick() => void—Defines a callback function which is called every time a back button is clicked.
onCloseButtonClick() => void—Defines a callback function which is called every time a close button is clicked.
onHelpButtonClick() => void—Defines a callback function which is called every time a help button is clicked.
refnull | string | (instance: SidePanelComponent | null) => void | RefObject<SidePanelComponent>—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).
skin"standard" | "floating"—Specifies the skin of the side panel.
widthstring | number'420px'Controls the width of the panel.

Testkit

Import the driver matching your test environment:

Copy

Driver methods

MethodDescription
clickHelpClick help button
clickCloseClick close button
clickBackClick back button
getHelpButtonAriaLabelGet help button aria-label
getCloseButtonAriaLabelGet close button aria-label
getBackButtonAriaLabelGet back button aria-label
getTitleTextGet title text
getPrefixGet Prefix element
getSuffixGet Suffix element
getContentGet Content Element
getSubtitleTextGet subtitle text
getTooltipContentGet tooltip text
getBackButtonTooltipContentGet back button tooltip content
isHeaderDividerExistsCheck if divider exists
isCloseButtonExistsCheck if close button exists
isHelpButtonExistsCheck if help button exists
isFooterDividerExistsCheck if divider exists
isBackButtonExistsCheck if back button exists
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.3 (2026-09-29) — 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.325.0 (2026-09-17) — maintenance release, no component-specific changes
  • 1.321.0 (2026-09-08) — feat: new border prop adds a border to the left or right edge of a standard-skin panel, for separating a docked panel from adjacent content (visible in themes that define a side panel border, such as odeditor-dark). (#16958) — has visual changes
  • 1.320.1 (2026-09-04) — maintenance release, no component-specific changes
  • 1.318.0 (2026-08-28) — maintenance release, no component-specific changes
  • 1.313.1 (2026-08-18) — fix: restored the SidePanel and SidePanel.Header type exports used for typing refs (e.g. useRef<SidePanel>(null)), which were lost when the components were wrapped with withDefaultProps. (#16824)
  • 1.310.0 (2026-08-10) — maintenance release, no component-specific changes
  • 1.299.0 (2026-07-17) — breaking: round standard skin, add shadow, shrink subtitle (Harmony theme) (#16566) — has visual changes
  • 1.298.0 (2026-07-14) — fix: center-align header title with back/close buttons (#16491) — has visual changes
  • 1.298.0 (2026-07-14) — breaking: update Header close/help button size and close button fill token (#16532) — has visual 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.289.0 (2026-06-17) — maintenance release, no component-specific changes
  • 1.288.0 (2026-06-15) — fix: solid background fallback when backdrop-filter unsupported (#16382)
  • 1.288.0 (2026-06-15) — fix: use border-box on floating root to prevent overflow (#16381)
  • 1.277.0 (2026-05-07) — maintenance release, no component-specific changes
  • 1.275.0 (2026-05-04) — feat: data-hook being public (#16223)
  • 1.273.0 (2026-04-30) — feat: add subtitle token and update header text sizes for odeditor-dark (#16208)
  • 1.272.0 (2026-04-27) — fix: onMouseDown accept event in SidePanelButtonProps type (#16164)
  • 1.270.0 (2026-04-20) — feat: new property hideoverflow (#16153) — has visual changes
  • 1.269.0 (2026-04-15) — fix: added two new component level tokens for harmony dark side panel border (#16140)
  • 1.268.0 (2026-04-13) — fix: made standard skin also use the blur background color (#16123)
  • 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.254.0 (2026-02-03) — maintenance release, no component-specific changes
  • 1.247.2 (2026-01-21) — maintenance release, no component-specific changes
  • 1.247.0 (2026-01-13) — maintenance release, no component-specific changes
  • 1.235.0 (2025-12-04) — maintenance release, no component-specific changes
  • 1.233.0 (2025-12-01) — feat: added onMouseDown for SidePanel header buttons | E3-5563 (#15598)
  • 1.221.1 (2025-10-16) — fix: removed excessive space from back button in the SidePanel header (#15416)
  • 1.220.2 (2025-10-06) — maintenance release, no component-specific changes
  • 1.220.0 (2025-09-29) — breaking: floating skin title in madefor display (#15305)
  • 1.217.0 (2025-09-08) — maintenance release, no component-specific changes
  • 1.214.0 (2025-08-22) — maintenance release, no component-specific changes
  • 1.213.0 (2025-08-19) — breaking: new header actions props (#15190)
  • 1.204.1 (2025-07-10) — maintenance release, no component-specific changes
  • 1.198.0 (2025-06-07) — fix: deprecation messages (#14966)
  • 1.197.0 (2025-06-06) — feat: aria-label for back, close, help buttons (#14928)
  • 1.172.0 (2025-03-20) — maintenance release, no component-specific changes
  • 1.161.0 (2025-02-12) — feat: add back button (#14522)
  • 1.139.0 (2024-11-07) — maintenance release, no component-specific changes
  • 1.138.1 (2024-10-30) — maintenance release, no component-specific changes
  • 1.129.0 (2024-09-25) — fix: move uni driver descriptions from the interface (#14178)
  • 1.120.1 (2024-08-08) — breaking: update vertical field padding for studio theme (#14020)
  • 1.115.0 (2024-07-17) — maintenance release, no component-specific changes
  • 1.111.0 (2024-06-26) — maintenance release, no component-specific changes
  • 1.104.1 (2024-05-14) — maintenance release, no component-specific changes
  • 1.103.1 (2024-04-24) — maintenance release, no component-specific changes
  • 1.103.0 (2024-04-23) — breaking: header affixes, floating skin header size change (#13594)
  • 1.102.0 (2024-04-16) — maintenance release, no component-specific changes
  • 1.101.0 (2024-04-12) — maintenance release, no component-specific changes
  • 1.97.2 (2024-03-04) — feat: replace content shifting scrollbar with overlay one (#13354)
  • 1.93.0 (2024-02-08) — maintenance release, no component-specific changes
  • 1.92.1 (2024-02-05) — maintenance release, no component-specific changes

Last updated: 22 October 2026

Did this help?