Skip to main content
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.

Modal

Modals are a special type of overlay that shift focus towards a specific action/set of information before the main flow can proceed. They must be specified inside the overlay prop of an activator component (Button, Link, or Pressable).

The library automatically applies the WAI-ARIA Dialog pattern to both the activator and the modal content.

Support
Targets (50)

Supported targets

Anchor to ModalPropsModalProps

Anchor to accessibilityLabel
accessibilityLabel
string

A label that describes the purpose of the modal, announced by screen readers. If not set, it will use the value of title.

Anchor to id
id
string

A unique identifier for the modal. When no id is set, a globally unique value will be used instead.

Anchor to onClose
onClose
() => void

A callback fired when the modal is closed. This is triggered when the close button, the backdrop, or the escape key are pressed.

Anchor to onOpen
onOpen
() => void

A callback fired when the modal is opened. This is called at the beginning of the transition that opens the modal.

Anchor to padding
padding
boolean

Whether to add default spacing around both the header (which holds the title) and the content of the modal.

Anchor to primaryAction
primaryAction
RemoteFragment

The primary action to perform, provided as a button component. Only one button can be rendered.

Anchor to secondaryActions
secondaryActions
RemoteFragment

The secondary actions to perform, provided as button components. Only one button can be rendered.

Anchor to size
size
'small' | 'auto' | 'large' | 'max'
Default: 'auto'

Adjust the size of the modal.

  • 'small': A compact modal for simple confirmations or short messages.
  • 'auto': Automatically sizes the modal based on its content.
  • 'large': A large modal for complex content or forms.
  • 'max': Expands the modal to its maximum size, on both the horizontal and vertical axes.
Anchor to title
title
string

A title rendered at the top of the modal.

Anchor to ExamplesExamples

Anchor to Basic ModalBasic Modal

Basic Modal

Example

Basic Modal

import {
reactExtension,
useApi,
Button,
Link,
Modal,
TextBlock,
} from '@shopify/ui-extensions-react/checkout';

export default reactExtension(
'purchase.checkout.block.render',
() => <Extension />,
);

function Extension() {
const {ui} = useApi();

return (
<Link
overlay={
<Modal
id="my-modal"
padding
title="Return policy"
>
<TextBlock>
We have a 30-day return policy, which
means you have 30 days after receiving
your item to request a return.
</TextBlock>
<TextBlock>
To be eligible for a return, your item
must be in the same condition that you
received it, unworn or unused, with
tags, and in its original packaging.
You’ll also need the receipt or proof
of purchase.
</TextBlock>
<Button
onPress={() =>
ui.overlay.close('my-modal')
}
>
Close
</Button>
</Modal>
}
>
Return policy
</Link>
);
}
import {
extension,
Button,
Link,
Modal,
TextBlock,
} from '@shopify/ui-extensions/checkout';

export default extension('purchase.checkout.block.render', (root, {ui}) => {
const modalFragment = root.createFragment();
const modal = root.createComponent(
Modal,
{id: 'my-modal', title: 'Return policy', padding: true},
[
root.createComponent(
TextBlock,
undefined,
'We have a 30-day return policy, which means you have 30 days after receiving your item to request a return.',
),
root.createComponent(
TextBlock,
undefined,
'To be eligible for a return, your item must be in the same condition that you received it, unworn or unused, with tags, and in its original packaging. You’ll also need the receipt or proof of purchase.',
),
root.createComponent(
Button,
{
onPress() {
ui.overlay.close('my-modal');
},
},
'Close',
),
],
);
modalFragment.appendChild(modal);
const link = root.createComponent(
Link,
{overlay: modalFragment},
'Return policy',
);

root.appendChild(link);
});

Anchor to Best PracticesBest Practices

Use modals if:

  • The information needed to be shown isn't critical in completing the checkout process and the information can't be condensed into one sentence.

  • The information the buyer is entering requires less than two rows of input fields.

  • The information the buyer is entering isn't reliant on information on the page (which is underneath the modal and not visible to them).

Anchor to RelatedRelated

APIUi
Was this page helpful?