AnnouncementModalLayout

Components/Overlays/Modal/AnnouncementModalLayout

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

Overview

Copy

Use this component inside a Modal component to display content in the AnnouncementModalLayout. You may place a title and/or a footer with actions relevant to the displayed content

Do

  • Keep the message concise and benefit-focused.
  • Make it easy to dismiss.
  • Include an illustration.

Don't

  • Don't use it for critical information or destructive actions. Use <MessageModalLayout/> instead.
  • Don't use it for forms or other inputs. Use <CustomModalLayout/> instead.
  • Don't overload it with multiple CTAs or complex content.

Feature examples

Simple Usage

A simple example with compact preview

Copy

Secondary Button Example

With a Secondary Button action instead of the link.

Copy

No Illustration Example

Copy

Footnote Example

The basic example with the addition of a footnote

Copy

Skin Example

The basic example with a premium skin

Copy

Help Button Example

The basic example with a help button shown

Copy

Developer examples

Mobile usage

On mobile, AnnouncementModalLayout should transform to FullScreenModalLayout for promotions.

For smaller, less intrusive promotions you can use Drawer as well

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

Copy

Common use case examples

Promotions

Use AnnouncementModalLayout for Premium feature promotion

Copy

Code

Copy

Props

NameTypeDefaultDescription
actionsSize"small" | "tiny" | "medium" | "large"'medium'Controls the size of the action buttons.
childrenReactNode—Accepts any item as a child element. For all common cases pass a standard text string.
closeButtonPropsModalCloseButtonProps—Close button props.
contentReactNode—Accepts any content to render in the modal body. Children passed directly are treated as content as well.
contentClassNamestring—
dataHookstring—Applies a data-hook HTML attribute to be used in the tests.
footerClassNamestring—
footnoteReactNode—Accepts any content to render as a footnote at the bottom of the modal.
footnoteClassNamestring—
footnoteSkin"light" | "neutral"—Sets the look and feel of the footnote.
headerClassNamestring—
helpButtonPropsModalControlButtonProps—Help button props.
illustrationReactNode—The illustration src or the illustration node itself.
illustrationClassNamestring—
linkOnClick() => void—Defines a callback function which is called when the link is clicked.
linkTextReactNode—When not provided, the primary link won't be rendered.
onCloseButtonClickMouseEventHandler—
onHelpButtonClickMouseEventHandler—
primaryButtonOnClick() => void—a callback for when the primary action button is clicked.
primaryButtonPropsOmit<ButtonProps, "internalDataHook">—Passed to the primary action button as props without any filter / mutation.
primaryButtonTextReactNode—Sets the text of the primary action button.
primaryButtonTooltipPropsOmit<TooltipProps, "children">—
secondaryButtonOnClick() => void—callback for when the secondary action button is clicked.
secondaryButtonPropsOmit<ButtonProps, "internalDataHook">—Passed to the secondary button as props without any filter / mutation.
secondaryButtonTextReactNode—Sets the text of the secondary action button.
sideActionsReactNode—Accepts any content to render as the first element on the same row as the action buttons.
skin"standard" | "premium"—Controls the skin of the modal. It's also applied to the footer buttons and the link.
styleCSSProperties—
subtitleReactNode—The modal's subtitle.
theme"standard" | "premium"—Controls the skin of the modal.
titleReactNode—The modal's title.

Testkit

Import the driver matching your test environment:

Copy

Driver methods

MethodDescription
getLinkTextReturns if the link component text content
clickLinkClicks the link component
getThemeGets the modal theme
getSkinGets the modal skin
clickCloseButtonClicks the modal close-button
clickHelpButtonClicks the modal help-button
childExistsChecks whether a node with the provided dataHook exists
getTitleTextGets the title's text
getSubtitleTextGets the subtitle's text
secondaryButtonDriverGets the secondary button driver
getSecondaryButtonDriverGets the secondary button driver
primaryButtonDriverGets the primary button driver
getPrimaryButtonDriverGets the primary button driver
getPrimaryButtonTooltipContentGets the primary button's tooltip content
getIllustrationSrcGets the illustration source
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.339.0 (2026-10-19) — maintenance release, no component-specific changes
  • 1.338.0 (2026-10-15) — maintenance release, no component-specific changes
  • 1.335.0 (2026-10-12) — 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.1 (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.324.0 (2026-09-14) — maintenance release, no component-specific changes
  • 1.310.0 (2026-08-10) — maintenance release, no component-specific changes
  • 1.308.0 (2026-08-04) — maintenance release, no component-specific changes
  • 1.305.1 (2026-07-30) — maintenance release, no component-specific changes
  • 1.305.0 (2026-07-28) — maintenance release, no component-specific changes
  • 1.299.0 (2026-07-17) — breaking: update to harmony design tokens & "Help" icon (#16577) — 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.288.0 (2026-06-15) — maintenance release, no component-specific changes
  • 1.273.0 (2026-04-30) — 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.254.0 (2026-02-03) — maintenance release, no component-specific changes
  • 1.253.0 (2026-01-30) — maintenance release, no component-specific changes
  • 1.247.2 (2026-01-21) — maintenance release, no component-specific changes
  • 1.235.0 (2025-12-04) — maintenance release, no component-specific changes
  • 1.220.0 (2025-09-29) — maintenance release, no component-specific changes
  • 1.214.0 (2025-08-22) — maintenance release, no component-specific changes
  • 1.213.0 (2025-08-19) — maintenance release, no component-specific changes
  • 1.202.0 (2025-06-27) — breaking: tokenization (#15003)
  • 1.196.0 (2025-06-04) — maintenance release, no component-specific changes
  • 1.105.0 (2024-05-21) — 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: 21 October 2026

Did this help?