---
title: Modal API
description: >-
  The Modal API lets you display an overlay that prevents interaction with the
  rest of the app until dismissed. Use modals for confirmations, forms, or
  important information that requires merchant
api_name: app-home
source_url:
  html: >-
    https://shopify.dev/docs/api/app-home/apis/user-interface-and-interactions/modal-api
  md: >-
    https://shopify.dev/docs/api/app-home/apis/user-interface-and-interactions/modal-api.md
---

# Modal API

The Modal API lets you display an overlay that prevents interaction with the rest of the app until dismissed. Use modals for confirmations, forms, or important information that requires merchant acknowledgement before proceeding.

### Use cases

* **Confirmation dialogs:** Display confirmation prompts before destructive actions like deleting resources.
* **Detail views:** Show detailed information in an overlay without navigating away from the current page.
* **Form workflows:** Present focused forms for data entry in a distraction-free overlay.
* **Content preview:** Preview content like templates or messages before publishing.

### Methods

The `modal` function provides methods to control modal visibility by a component's ID. These methods work with the [`s-modal` component](https://shopify.dev/docs/api/app-home/polaris-web-components/overlays/modal) and are alternatives to calling instance methods directly on the element.

* **hide**

  **(id: string) => Promise\<void>**

  Hides the modal element. An alternative to the `hideOverlay` instance method on the `s-modal` component.

* **show**

  **(id: string) => Promise\<void>**

  Shows the modal element. An alternative to the `showOverlay` instance method on the `s-modal` component.

* **toggle**

  **(id: string) => Promise\<void>**

  Toggles the modal element visibility. An alternative to the `toggleOverlay` instance method on the `s-modal` component.

Examples

## Preview

![Show a modal. This example opens a modal using the \`show\` method with a unique modal ID. The modal remains visible until the merchant dismisses it or you call the \`hide\` method.](https://shopify.dev/assets/assets/images/apps/tools/app-bridge-modal-BUQeTJIG.png)

### Examples

* ####

  ##### Description

  Show a modal. This example opens a modal using the \`show\` method with a unique modal ID. The modal remains visible until the merchant dismisses it or you call the \`hide\` method.

  ##### html

  ```html
  <s-modal id="my-modal">
    <s-text>Hello, World!</s-text>
  </s-modal>

  <s-button onclick="shopify.modal.show('my-modal')">
    Open Modal
  </s-button>
  ```

* ####

  ##### Description

  Hide a modal. This example closes an open modal using the \`hide\` method with the modal ID. Use this when you need to programmatically dismiss a modal after an action completes or when a condition is met.

  ##### html

  ```html
  <s-modal id="my-modal">
    <s-text>Hello, World!</s-text>
    <s-button onclick="shopify.modal.hide('my-modal')">
      Close
    </s-button>
  </s-modal>

  <s-button onclick="shopify.modal.show('my-modal')">
    Open Modal
  </s-button>
  ```

* ####

  ##### Description

  Toggle a modal. This example switches the modal visibility using the \`toggle\` method. If the modal is hidden it becomes visible, and if visible it becomes hidden. Use this for UI elements that open and close the same modal.

  ##### html

  ```html
  <s-modal id="my-modal">
    <s-text>Hello, World!</s-text>
  </s-modal>

  <s-button onclick="shopify.modal.toggle('my-modal')">
    Toggle Modal
  </s-button>
  ```

***