The Modal API allows you to display an overlay that prevents interaction with the rest of the app until dismissed.
<ui-modal id="my-modal">
<p>Hello, World!</p>
</ui-modal>
<button onclick="shopify.modal.show('my-modal')">Open Modal</button>
The `modal` API provides a `show` method to display a Modal, a `hide` method to hide a Modal, and a `toggle` method to toggle the visibility of a Modal. These are used in conjunction with the [`ui-modal` element](/docs/api/app-bridge-library/web-components/ui-modal). They are alternatives to the `show`, `hide`, and `toggle` instance methods.
Hides the modal element. An alternative to the `hide` instance method on the `ui-modal` element.
Shows the modal element. An alternative to the `show` instance method on the `ui-modal` element.
Toggles the modal element visibility. An alternative to the `toggle` instance method on the `ui-modal` element.