---
title: Save bar API
description: >-
  The Save Bar API indicates that a form on the current page has unsaved
  information. You can implement save bar behavior in two ways: 1.
api_name: app-home
source_url:
  html: >-
    https://shopify.dev/docs/api/app-home/apis/user-interface-and-interactions/save-bar-api
  md: >-
    https://shopify.dev/docs/api/app-home/apis/user-interface-and-interactions/save-bar-api.md
---

# Save bar API

The Save Bar API indicates that a form on the current page has unsaved information. You can implement save bar behavior in one of two ways:

1. **Automatic (form attribute)**: Add the `data-save-bar` attribute to a [`form` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/form). The save bar displays automatically when there are unsaved changes. The [`submit`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLFormElement/submit_event) event fires when the merchant clicks **Save**, and the [`reset`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLFormElement/reset_event) event fires when the merchant clicks **Discard**. This is the simplest approach for standard form workflows.

2. **Programmatic (web component)**: Add a `<ui-save-bar>` element with a unique `id` to your page, then use `shopify.saveBar.show(id)`, `shopify.saveBar.hide(id)`, and `shopify.saveBar.toggle(id)` to control it. The `<ui-save-bar>` element can contain `<button>` children for **Save** (with `variant="primary"`) and **Discard**. This approach gives you full control over when the save bar appears and what happens when merchants interact with it.

**Caution:**

Choose one approach for each form. Don't combine `data-save-bar` on a form with programmatic `shopify.saveBar` methods — each approach manages save bar visibility independently and using both can cause unexpected behavior.

### Use cases

* **Standard forms:** Use the `data-save-bar` attribute on a `form` element to automatically detect and manage unsaved changes with save and discard actions.
* **Custom state management:** Use the `<ui-save-bar>` web component with `shopify.saveBar` methods to control the save bar based on application state that isn't tied to a single form.
* **Data protection:** Prevent accidental data loss by prompting users when leaving a page with unsaved changes using `shopify.saveBar.leaveConfirmation()`.

### Methods

The `saveBar` object provides methods to programmatically control save bar visibility.

* **hide**

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

  Hides the save bar. Call this after the merchant saves or discards their changes.

* **leaveConfirmation**

  **() => Promise\<void>**

  Prompts the merchant to confirm before leaving the page when there are unsaved changes. The promise resolves when the merchant confirms or when no save bar is visible. Use this before programmatic navigation (for example, using `window.location` or custom routing) to prevent accidental data loss.

* **show**

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

  Displays the save bar to indicate unsaved changes. Call this when you want to prompt the merchant to save.

* **toggle**

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

  Toggles save bar visibility between shown and hidden states.

Examples

## Preview

![Display a save bar. This example adds the \`data-save-bar\` attribute to a form element. When the form has unsaved changes, the save bar appears automatically.](https://shopify.dev/assets/assets/images/templated-apis-screenshots/admin/apis/contextual-save-bar-D20oMpjo.png)

### Examples

* ####

  ##### Description

  Display a save bar. This example adds the \`data-save-bar\` attribute to a form element. When the form has unsaved changes, the save bar appears automatically.

  ##### html

  ```html
  <form
    data-save-bar
    onsubmit="console.log('submit', new FormData(event.target)); event.preventDefault();"
  >
    <label>
      Name:
      <input name="username" />
    </label>
  </form>
  ```

* ####

  ##### Description

  Handle discard events. This example subscribes to the \[\`reset\`]\(https://developer.mozilla.org/en-US/docs/Web/API/HTMLFormElement/reset\_event) event to run custom logic when the merchant clicks the Discard button.

  ##### Event handler property

  ```html
  <form
    data-save-bar
    onreset="console.log('discarding')"
  >
    <label>
      Name:
      <input name="username" />
    </label>
  </form>
  ```

  ##### Event listener

  ```html
  <form data-save-bar>
    <label>
      Name:
      <input name="username" />
    </label>
  </form>

  <script>
    const form = document.querySelector('form');
    form.addEventListener('reset', (e) => {
      console.log('discarding');
    });
  </script>
  ```

* ####

  ##### Description

  Handle save events. This example subscribes to the \[\`submit\`]\(https://developer.mozilla.org/en-US/docs/Web/API/HTMLFormElement/submit\_event) event to run custom logic when the merchant clicks the Save button.

  ##### Event handler property

  ```html
  <form
    data-save-bar
    onsubmit="console.log('submitting');"
  >
    <label>
      Name:
      <input name="username" />
    </label>
  </form>
  ```

  ##### Event listener

  ```html
  <form data-save-bar>
    <label>
      Name:
      <input name="username" />
    </label>
  </form>

  <script>
    const form = document.querySelector('form');
    form.addEventListener('submit', (e) => {
      console.log('submitting');
    });
  </script>
  ```

* ####

  ##### Description

  Show discard confirmation. This example adds the \`data-discard-confirmation\` attribute to show a confirmation modal when the merchant clicks the Discard button, preventing accidental data loss.

  ##### html

  ```html
  <form
    data-save-bar
    data-discard-confirmation
    onsubmit="console.log('submit', new FormData(event.target)); event.preventDefault();"
  >
    <label>
      Name:
      <input name="username" />
    </label>
  </form>
  ```

* ####

  ##### Description

  Control the save bar programmatically. This example defines a \`\<ui-save-bar>\` element with an \`id\`, then uses \`shopify.saveBar.show(id)\` and \`shopify.saveBar.hide(id)\` to manage visibility based on application state.

  ##### tsx

  ```tsx
  function SaveBarExample() {
    const saveBarId = 'settings-save-bar';
    const [hasUnsavedChanges, setHasUnsavedChanges] = React.useState(false);

    const handleFieldInput = () => {
      if (!hasUnsavedChanges) {
        setHasUnsavedChanges(true);
        shopify.saveBar.show(saveBarId);
      }
    };

    const handleDiscard = () => {
      setHasUnsavedChanges(false);
      shopify.saveBar.hide(saveBarId);
    };

    const handleSave = async () => {
      // Save to your backend
      setHasUnsavedChanges(false);
      shopify.saveBar.hide(saveBarId);
    };

    return (
      <s-page heading="Settings">
        <ui-save-bar id={saveBarId}>
          <button variant="primary" onClick={handleSave}>Save</button>
          <button onClick={handleDiscard}>Discard</button>
        </ui-save-bar>
        <s-section heading="Configuration">
          <s-text-field
            label="Store name"
            onInput={handleFieldInput}
          />
        </s-section>
      </s-page>
    );
  }
  ```

* ####

  ##### Description

  Toggle the save bar. This example defines a \`\<ui-save-bar>\` element with an \`id\`, then uses \`shopify.saveBar.toggle(id)\` to switch between shown and hidden states.

  ##### tsx

  ```tsx
  function ToggleExample() {
    const saveBarId = 'toggle-save-bar';

    const handleToggle = () => {
      shopify.saveBar.toggle(saveBarId);
    };

    return (
      <s-page heading="Settings">
        <ui-save-bar id={saveBarId}>
          <button variant="primary">Save</button>
          <button>Discard</button>
        </ui-save-bar>
        <s-section heading="Controls">
          <s-button onClick={handleToggle}>
            Toggle save bar
          </s-button>
        </s-section>
      </s-page>
    );
  }
  ```

* ####

  ##### Description

  Leave confirmation. This example uses \`shopify.saveBar.leaveConfirmation()\` to prompt the merchant before programmatic navigation when there are unsaved changes.

  ##### tsx

  ```tsx
  function LeaveConfirmationExample() {
    const saveBarId = 'leave-confirm-save-bar';
    const [hasUnsavedChanges, setHasUnsavedChanges] = React.useState(false);

    const handleFieldInput = () => {
      if (!hasUnsavedChanges) {
        setHasUnsavedChanges(true);
        shopify.saveBar.show(saveBarId);
      }
    };

    const handleCustomNavigation = async () => {
      // Call leaveConfirmation before programmatic navigation
      await shopify.saveBar.leaveConfirmation();
      // Navigation proceeds after merchant confirms or if no unsaved changes
      window.location.href = '/other-page';
    };

    return (
      <s-page heading="Settings">
        <ui-save-bar id={saveBarId}>
          <button variant="primary">Save</button>
          <button>Discard</button>
        </ui-save-bar>
        <s-section heading="Configuration">
          <s-text-field
            label="Store name"
            onInput={handleFieldInput}
          />
          <s-button onClick={handleCustomNavigation}>
            Go to other page
          </s-button>
        </s-section>
      </s-page>
    );
  }
  ```

***