Skip to content

Add toast api on standard api #3077

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jul 21, 2025
Merged

Add toast api on standard api #3077

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0035805
Add toast api to standard api
oluwatimio Jul 14, 2025
0234690
add it back
oluwatimio Jul 14, 2025
8a745d2
remove from docs for now
oluwatimio Jul 14, 2025
f594ead
Add changeset
oluwatimio Jul 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/warm-pans-wash.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@shopify/ui-extensions': patch
---

Add toast api on customer accounts standard api
7 changes: 7 additions & 0 deletions packages/ui-extensions/src/surfaces/customer-account/api/shared.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -652,3 +652,10 @@ export interface TrackingConsentChangeResultError {
*/
message: string;
}

export interface ToastApiResult {
hide: () => void;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we currently do not support hide

ui-extensions/packages/ui-extensions/src/surfaces/point-of-sale/render/api/toast-api/toast-api.ts

Line 11 in 93815b4

show: (content: string, options?: ShowToastOptions) => void;

Are we going to implement this as part of the 2025-10 version?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@robin-drexler Yes! we are adding support for it here https://github.com/shop/world/pull/106014

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Im updating this type so I can expose that change on standard api :)

}
export interface ToastApi {
show: (content: string) => ToastApiResult;
}
18 changes: 18 additions & 0 deletions packages/ui-extensions/src/surfaces/customer-account/api/standard-api/standard-api.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import {
Analytics,
CustomerPrivacy,
ApplyTrackingConsentChangeType,
ToastApi,
} from '../shared';

import type {ExtensionTarget} from '../../extension-targets';
Expand Down Expand Up @@ -101,6 +102,23 @@ export interface StandardApi<Target extends ExtensionTarget = ExtensionTarget> {
*/
ui: Ui;
Copy link
Contributor Author

@oluwatimio oluwatimio Jul 14, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will remove toast type on here once we have completed moving this over + docs shipped but for now leaving it in here as we need the toast api on standard api to implement shopify.toast on the host


/**
* The Toast API displays a non-disruptive message that displays at the bottom
* of the interface to provide quick, at-a-glance feedback on the outcome
* of an action.
*
* How to use:
*
* - Use toasts to confirm successful actions.
*
* - Aim for two words.
*
* - Use noun + past tense verb format. For example, \`Changes saved\`.
*
* For errors, or information that needs to persist on the page, use a [banner](/docs/api/checkout-ui-extensions/unstable/components/feedback/banner) component.
*/
toast: ToastApi;

navigation: StandardExtensionNavigation;

/**
Expand Down