Upgrade to Polaris
Version 2025-07 is the last API version to support React-based UI components. Later versions use Polaris web components, native UI elements with built-in accessibility, better performance, and consistent styling with Shopify's design system. Check out the upgrade guide to upgrade your extension and avoid being blocked from updating your extension after October 1st 2026.
Announcement API
The API for interacting with the announcement bar.
Anchor to AnnouncementApiAnnouncement
The API object provided to the purchase.thank-you.announcement.render extension target.
- Anchor to announcementannouncementannouncementAnnouncementAnnouncementrequiredrequired
Announcement
- addEventListener
Listen for events from the announcement bar.
(type: "close", cb: () => void) => void - close
Close the Announcement bar.
() => void - removeEventListener
Remove a listener for events from the announcement bar.
(type: "close", cb: () => void) => void
Was this page helpful?