FloatingHelper

Components/Overlays/FloatingHelper

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

Overview

Copy

Floating helper is a popover that points to an element on the page to introduce a new or updated feature. It can hold a title, body text, an image and an action, and users close it with its close button.

Do

  • Use it to introduce a new or updated feature next to the element it describes.
  • Keep the title and body short, and add one action at most.
  • Show one floating helper at a time.

Don't

  • Don't use it for information users need to complete a task. Use <SectionHelper/> instead.
  • Don't use it to explain how a control works. Use <Tooltip/> or <InfoIcon/> instead.

Feature examples

Full Example

A full example with an action button and an image.

Copy

Programmatic Open Example (Uncontrolled mode)

In `Uncontrolled` mode, the default behavior is that the popover content is opened when mouse-enter is triggered on the target and closes when the close button is clicked. This option is not recommended but is still supported for backward compatibility.

Copy

Controlled Example

Copy

Skins

<FloatingHelper/> has two skins: `dark` (default) and `light`.

Copy

Code

Copy

Props

NameTypeDefaultDescription
appearance"light" | "dark"—Controls the skin of the floating helper when skin isn't set.
appendTonull | Element | "window" | "scrollParent" | "viewport" | "parent" | Predicate'window'Enables calculations in relation to a dom element.
childrenReactNode—Sets the trigger and the content of the popover, as Popover.Element and Popover.Content elements.
content (required)ReactNode—A <FloatingHelper.Content> component.
dataHookstring—Applied as data-hook HTML attribute that can be used in the tests.
hideDelaynumber—Set a delay on closing.
initiallyOpenedbooleantrueControls whether the popover's content is initially opened (In Uncontrolled mode only)
moveByMoveByOffset—Moves the floating helper relative to the parent by x or y.
onClose() => void—Defines a callback function which is called when the popover content is requested to be closed. In controlled mode, it's called when the close button is clicked. In uncontrolled mode, it's called after the popover closes.
onOpen() => void—Callback to call when the popover content is requested to be opened (Uncontrolled mode only)
openedboolean—Controls whether the popover's content is shown or not (aka Controlled mode). When undefined, then the component is Uncontrolled. See open/close behaviour section in docs.
placement (required)"right" | "left" | "top" | "bottom" | "auto" | "auto-start" | "auto-end" | "top-start" | "top-end" | "right-start" | "right-end" | "bottom-end" | "bottom-start" | "left-end" | "left-start"—The location to display the content.
skin"light" | "dark"—Skin : dark or light
target (required)ReactNode—The target of the popover.
widthstring | number'444px'Width HTML attribute of the content. If a number is passed then it defaults to px. e.g width={400} => width="400px"
zIndexnumber—Floating helper z-index.

Testkit

No testkit for this component — it doesn't expose a unidriver testkit.

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.332.0 (2026-10-05) — fix: hideDelay now keeps the helper shown for the given number of milliseconds after it's closed. Previously the prop was ignored and the helper closed right away. (#17292)
  • 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.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) — feat: add whiteOutline, dark, and darkOutline action button skins. (#17097) — has visual changes
  • 1.325.0 (2026-09-17) — maintenance release, no component-specific changes
  • 1.310.0 (2026-08-10) — maintenance release, no component-specific changes
  • 1.308.0 (2026-08-04) — fix: respect the width prop when content is appended to the window (#16726)
  • 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.288.0 (2026-06-15) — maintenance release, no component-specific changes
  • 1.279.0 (2026-05-13) — maintenance release, no component-specific changes
  • 1.278.0 (2026-05-08) — maintenance release, no component-specific changes
  • 1.277.0 (2026-05-07) — fix: pass moveBy prop to Popover (#16245)
  • 1.275.0 (2026-05-04) — fix: fixed issue with appendTo prop (#16219)
  • 1.272.0 (2026-04-27) — fix: use correct open prop in ClosablePopover (#16198)
  • 1.271.0 (2026-04-22) — fix: moved closablepopover down (#16182)
  • 1.267.0 (2026-04-09) — 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.241.0 (2025-12-17) — maintenance release, no component-specific changes
  • 1.220.0 (2025-09-29) — maintenance release, no component-specific changes
  • 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.165.0 (2025-02-27) — maintenance release, no component-specific changes
  • 1.138.1 (2024-10-30) — maintenance release, no component-specific changes
  • 1.104.1 (2024-05-14) — 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: 30 October 2026

Did this help?