Components/Overlays
Interactive docs page: https://wix-pages.com/design-system-documentation/#/component/sidepanel
Side panel is a component that presents supplementary information, navigation options, or controls alongside or overlaying the main content of the page.
<Modal/> instead.Side panels are composed of up to four compound components:
<SidePanel.Header/><SidePanel.Content/><SidePanel.Divider/><SidePanel.Footer/>All of these components are optional.
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).Set the side panel's width using the width property. The default width is 420px.
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.
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.
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.
Customize the side panel's header using these properties:
titlesubtitleHeader has these properties for actions available:
infoTooltipContent - provides additional details or an explanation in a tooltiponHelpButtonClick- allows users to access help articles and contextual informationonBackButtonClick- allows users to navigate back in the Side PanelbackButtonDescription - sets content of the back button's tooltipCreate a custom header layout by adding children elements to the <SidePanel.Header/> container.
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.
Create sections inside of a panel by adding multiple <SidePanel.Content/> areas.
Separate them from one another with a dedicated <SidePanel.Divider/> element.
Separate controls inside of a panel from one another by wrapping each one into <SidePanel.Field/> container.
To display confirmation or close actions use the <SidePanel.Footer/> container.
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.
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.
Use side panel to create settings panels that allow users to control the design and behavior aspects of their app.
Use <SidePanel.Section/> wrapper to organize panel info into categories.
It will make the whole panel easier to scan.
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.
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:
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/>.
| Name | Type | Default | Description |
|---|---|---|---|
backButtonDescription | ReactNode | — | When provided, sets the content of the back button's tooltip. |
backButtonProps | SidePanelBackButtonProps | — | Back button props. |
backButtonTooltipProps | TooltipCommonProps | — | 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). |
buttonText | string | — | Has no effect. <SidePanel/> doesn't render it. |
children | ReactNode | — | 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/> |
closeButtonProps | SidePanelCloseButtonProps | — | Close button props. |
dataHook | string | — | Applies a data-hook HTML attribute to be used in the tests. |
draggable | boolean | — | Specifies if panel is draggable (works only with floating skin). |
height | string | number | '100%' | Controls the height of the panel. |
helpButtonProps | SidePanelButtonProps | — | Help button props. |
hideOverflow | boolean | — | Hides all overflow of side panel. |
maxHeight | string | 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. |
ref | null | 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. |
width | string | number | '420px' | Controls the width of the panel. |
Import the driver matching your test environment:
| Method | Description |
|---|---|
clickHelp | Click help button |
clickClose | Click close button |
clickBack | Click back button |
getHelpButtonAriaLabel | Get help button aria-label |
getCloseButtonAriaLabel | Get close button aria-label |
getBackButtonAriaLabel | Get back button aria-label |
getTitleText | Get title text |
getPrefix | Get Prefix element |
getSuffix | Get Suffix element |
getContent | Get Content Element |
getSubtitleText | Get subtitle text |
getTooltipContent | Get tooltip text |
getBackButtonTooltipContent | Get back button tooltip content |
isHeaderDividerExists | Check if divider exists |
isCloseButtonExists | Check if close button exists |
isHelpButtonExists | Check if help button exists |
isFooterDividerExists | Check if divider exists |
isBackButtonExists | Check if back button exists |
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. |
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 changesSidePanel 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)Last updated: 22 October 2026