Migrate to Polaris

Version 2025-07 is the last API version to support React-based UI components. Later versions use web components, native UI elements with built-in accessibility, better performance, and consistent styling with Shopify's design system. Check out the migration guide to upgrade your extension.

Choose a version:

Toast API

The Toast API provides temporary notification functionality for POS UI extensions, allowing you to display brief, non-intrusive messages to users for feedback, confirmations, and status updates that automatically disappear after a specified duration. Toast messages appear as overlay notifications that don't interrupt the user's workflow.

Anchor to Use casesUse cases

Action feedback: Provide immediate feedback for successful data saves or API call completions.
Error messages: Display error messages and warnings without blocking workflow.
Progress updates: Show progress updates for long-running operations.
Status changes: Communicate system status changes like connectivity issues.

Support

Targets (25)

Supported targets

Anchor to PropertiesProperties

The Toast API object provides temporary notification functionality for POS UI extensions. Access the following properties on the API object to display brief, non-intrusive messages for feedback, confirmations, and status updates.

Anchor to show show (content: string, options?: ) => void required: Displays a toast notification with the specified text content. The message appears as a temporary overlay that automatically dismisses after the specified duration. Use for providing immediate user feedback, confirming actions, or communicating status updates without interrupting the user's workflow.

ShowToastOptions

Specifies configuration options for displaying toast notifications. Controls the duration and display behavior of temporary notification messages.

duration
The duration in milliseconds that the toast message should remain visible before automatically dismissing. If not specified, the toast will use the default system duration. Use shorter durations for simple confirmations and longer durations for important messages that users need time to read.
```
number
```

Examples

import React from 'react';

import {

Tile,

useApi,

reactExtension,

} from '@shopify/ui-extensions-react/point-of-sale';

const SmartGridTile = () => {

const api = useApi<'pos.home.tile.render'>();

return (

<Tile

title="My App"

onPress={() => api.toast.show('Toast content', 5000)}

enabled

);

};

export default reactExtension('pos.home.tile.render', () => <SmartGridTile />);

Examples

Show a toast notification

Description

Display a brief, non-intrusive notification message that automatically dismisses. This example demonstrates using `toast.show()` to provide immediate feedback after user actions, confirmations for successful operations, or status updates without interrupting the merchant's workflow.

React

import React from 'react';
import {
  Tile,
  useApi,
  reactExtension,
} from '@shopify/ui-extensions-react/point-of-sale';

const SmartGridTile = () => {
  const api = useApi<'pos.home.tile.render'>();

  return (
    <Tile
      title="My App"
      onPress={() => api.toast.show('Toast content', 5000)}
      enabled
    />
  );
};

export default reactExtension('pos.home.tile.render', () => <SmartGridTile />);

TS

import {Tile, extension} from '@shopify/ui-extensions/point-of-sale';

export default extension('pos.home.tile.render', (root, api) => {
  const tile = root.createComponent(Tile, {
    title: 'My App',
    onPress: () => api.toast.show('Toast content', 5000),
    enabled: true,
  });

  root.append(tile);
});

Anchor to Best practicesBest practices

Use appropriate timing: Choose duration values that give users enough time to read the message without keeping notifications visible longer than necessary.
Provide meaningful feedback: Use toast messages to confirm successful actions, explain errors clearly, or communicate important status changes that users need to know about.
Avoid overuse: Reserve toast notifications for important feedback and avoid showing multiple toasts simultaneously, as this can overwhelm users and reduce the effectiveness of the notifications.

Anchor to LimitationsLimitations

Toast messages are temporary and can't be made persistent. For important information that users need to reference later, consider using other UI components or storage mechanisms.
Multiple toast messages may overlap or interfere with each other if shown in rapid succession. Consider queuing or spacing out notifications appropriately.
Toast content is limited to plain text and can't include rich formatting, links, or interactive elements.

Was this page helpful?