SectionHelper

Components/Feedback

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

Overview

Copy

Section helper is a notification message that allows us to communicate with users and provide feedback anywhere on the page.

Do

  • Use it to provide application-level status updates; for example, to inform the user that their payment method has expired.
  • Use it to share the status of application sections; for example, to inform users that settings are turned on in a way that they might not prefer.

Don't

  • Don't use it for status updates after users perform actions, like validation errors and success messages. Use <StatusToast/> instead.

Feature examples

Structure

The component consists of 4 majors elements: title, content, action and close button.

Control the action label with actionText and its interaction with onAction props, and the close button with the onClose prop.

Copy

Size

Adjust the size of the section helper with the size prop:

  • medium (default) can be used in all common cases.
  • small is best for dense layouts.
  • tiny fits a single line of text with an action, such as a strip inside a card.
Copy

Skin

Control the style of the section helper with the appearance prop. It supports 7 options:

  • standard is meant to provide additional information relevant to current user task.
  • success is used to inform users about a successful action.
  • warning (default) is intended to draw the user's attention to unresolved issues.
  • danger is used for error messages and information about critical issues.
  • premium is only intended for premium upgrades, packages that let users accept payments, connect domains, and have business email. Read more about Premium patterns.
  • preview is meant to present process status or related additional data.
  • experimentalDark is used to emphasize informational messages in the context of other content.
Copy

Prefix

  • Use the showPrefixIcon prop to show the default status icon.
  • Add more context for the section helper by also using the prefixIcon prop.
Copy

Close button

Control whether the user can dismiss th section helper with the showCloseButton prop.

Copy

Secondary action

Add a second, lower-emphasis action beside the main one with secondaryActionProps, passing its label and an onClick handler.

Keep actionText for the step you want people to take, and use the secondary action for the way out, postponing, dismissing or reading more.

Copy

Border

Use the border prop to choose between:

  • standard (default) for all common cases.
  • topBottom for banner type use cases.
Copy

Layout

Change how the content and action are stacked using the layout props:

  • vertical (default) arranges the content and action vertically.
  • horizontal arranges the content and action horizontally.
Copy

Content width

Enable content width to be 100% wide with the fullWidth prop.

By default, the component's title and content are limited to a maximum width of 420 pixels to ensure readability.

Copy

Common use case examples

Application error

Errors occur because of breaches in application logic or conditions; for example, when users reach storage limits or their payment method has expired. These errors can occur before users even open the application or a specific page, making it essential for them to be visible upon arrival.

Place application errors at the top of the page below the page header using the error banner.

Copy

Inline with content

Place the section helper at the top of the section that it applies to.

Copy

In front of content

Position the section helper on top of content in modals to update users about the status change.

Copy

Code

Copy

Props

NameTypeDefaultDescription
actionDisabledboolean—Disables the action button.
actionTextReactNode—Text or any child component for the action button.
appearance"warning" | "standard" | "premium" | "success" | "danger" | "preview" | "experimentalDark"—Sets the look and feel of the component. Used only when skin isn't set.
border"standard" | "topBottom"standardControls the component border.
childrenReactNode—Sets the body content of the section helper.
dataHookstring—Applied as data-hook HTML attribute that can be used in the tests.
fullWidthboolean—Set the content width to 100%.
layout"horizontal" | "vertical"verticalControls the component layout.
onActionMouseEventHandler—When provided, displays an action button that invokes this callback on click.
onCloseMouseEventHandler—Defines a callback function which is called when the close button is clicked. The close button is displayed only when showCloseButton is true.
prefixIconReactNode—Overrides default prefix icon.
secondaryActionProps{ label?: ReactNode; onClick?: MouseEventHandler<HTMLButtonElement> | undefined; }—Defines properties for the secondary action button.
showCloseButtonboolean—Specifies whether the close button is displayed.
showPrefixIconboolean—Enables showing prefix icon.
size"small" | "tiny" | "medium"—Controls the component padding.
skin"warning" | "standard" | "premium" | "success" | "danger" | "preview" | "experimentalDark"—Sets the look and feel of the component.
titleReactNode—Adds text as the title.

Testkit

Import the driver matching your test environment:

Copy

Driver methods

MethodDescription
hasSizeChecks whether the resolved rendered size matches the given size, including defaults
titleTextGets the title text
actionTextGets the action text
clickActionClicks the action
isActionDisabledChecks whether the action button is disabled
secondaryActionTextGets the secondary action text
clickSecondaryActionClicks the secondary action
isSecondaryActionDisplayedChecks whether the secondary action is displayed
clickCloseClicks the close button
isCloseButtonDisplayedChecks whether the close button is displayed
hasPrefixChecks whether the prefix is displayed
textContentGets the text content
isWarningChecks whether the component appears as "warning"
isStandardChecks whether the component appears as "standard"
isDangerChecks whether the component appears as "danger"
isExperimentalDarkChecks whether the component appears as "experimentalDark"
isSuccessChecks whether the component appears as "success"
isPremiumChecks whether the component appears as "premium"
isPreviewChecks whether the component appears as "preview"
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.342.0 (2026-10-26) — maintenance release, no component-specific changes
  • 1.341.0 (2026-10-22) — breaking: on mobile, text that was 12px is now 14px: the message in Harmony (odeditor), and the title and message in Studio 2.0 (odeditor-dark, studio2-light) and Studio (studio). (#17574) — has visual 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) — breaking: the experimentalDark skin stands out more in Studio 2.0 (odeditor-dark). Its background is a stronger blue tint and its border matches the blue of the primary action button. Other themes are unchanged. (#17450) — has visual changes
  • 1.335.0 (2026-10-12) — maintenance release, no component-specific changes
  • 1.332.0 (2026-10-05) — maintenance release, no component-specific changes
  • 1.331.0 (2026-10-01) — maintenance release, no component-specific changes
  • 1.330.3 (2026-09-29) — fix: the experimentalDark skin is a light lavender banner with a visible border in Studio 2.0 (odeditor-dark), matching the standard skin in Harmony (odeditor), instead of the white-on-white it rendered there. Other themes are unchanged. (#17285) — has visual 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.313.1 (2026-08-18) — feat: new secondaryActionProps prop adds an optional secondary action next to the action button, rendered as a text button. In the horizontal layout it sits to the left of the action button, in the vertical layout to its right. (#16774) — has visual changes
  • 1.310.0 (2026-08-10) — 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.282.0 (2026-05-27) — feat: add actionDisabled prop to action button (#16307)
  • 1.278.0 (2026-05-08) — maintenance release, no component-specific changes
  • 1.272.0 (2026-04-27) — 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.250.0 (2026-01-27) — maintenance release, no component-specific changes
  • 1.247.2 (2026-01-21) — maintenance release, no component-specific changes
  • 1.242.0 (2025-12-19) — maintenance release, no component-specific changes
  • 1.220.0 (2025-09-29) — maintenance release, no component-specific changes
  • 1.214.2 (2025-08-25) — fix: remove char from stylesheet (#15236)
  • 1.213.0 (2025-08-19) — breaking: add tokens (#15186)
  • 1.212.0 (2025-08-11) — fix: broken legacy testkit (#15177)
  • 1.196.0 (2025-06-04) — maintenance release, no component-specific changes
  • 1.195.0 (2025-06-03) — maintenance release, no component-specific changes
  • 1.161.0 (2025-02-12) — maintenance release, no component-specific changes
  • 1.154.0 (2025-01-16) — fix: testkit (#14463)
  • 1.146.0 (2024-12-10) — feat: override font-size and line-height for studio tokens (#14337)
  • 1.143.0 (2024-11-25) — maintenance release, no component-specific changes
  • 1.137.0 (2024-10-25) — fix: fix button overflow on horizontal layouts (#14240)
  • 1.135.0 (2024-10-23) — feat: add prefix icon (#14219)
  • 1.134.1 (2024-10-21) — fix: fix content overflow (#14230)
  • 1.134.0 (2024-10-18) — feat: introduce layout with vertical and horizontal values (#14203)
  • 1.134.0 (2024-10-18) — feat: add border support (#14204)
  • 1.132.0 (2024-10-11) — fix: fix default showCloseButton value (#14212)
  • 1.131.0 (2024-10-10) — maintenance release, no component-specific changes
  • 1.120.1 (2024-08-08) — breaking: fix spacing between content and action (#13968)
  • 1.115.0 (2024-07-17) — maintenance release, no component-specific changes
  • 1.102.0 (2024-04-16) — maintenance release, no component-specific changes
  • 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: 26 October 2026

Did this help?