Share API

Use the navigator.share() method to share text and URLs from your app.

On desktop devices, navigator.share() uses the browser's built-in sharing functionality. See the navigator.share() documentation to learn more about browser support for this method.

On mobile devices, navigator.share() doesn't work natively inside the app's iframe. When you call this method from apps in Shopify Mobile or Shopify POS, App Bridge intercepts the method and invokes the native iOS or Android share sheet.

Sharing files using the files property isn't supported.

Anchor to Use casesUse cases

Content sharing: Share app content like reports or product details using the device's native share sheet.
Link sharing: Share deep links to specific app pages or Shopify resources with team members.
Social sharing: Enable merchants to share content to social media or messaging apps.
Collaboration: Share text and URLs with other apps on the merchant's device.

Examples

js

try {

const shareData = {

text: 'Learn more about Shopify App Bridge',

url: 'https://shopify.dev/docs/api/app-bridge',

};

await navigator.share(shareData);

} catch (err) {

console.log('Share error', err);

}

Examples

Description

Share a URL along with a text description using `navigator.share()`. Wrap the call in a try/catch block to handle cases where the user cancels the share or sharing is not supported.

js

try {
  const shareData = {
    text: 'Learn more about Shopify App Bridge',
    url: 'https://shopify.dev/docs/api/app-bridge',
  };
  await navigator.share(shareData);
} catch (err) {
  console.log('Share error', err);
}

Description

Share a text message without a URL. This is useful for sharing summaries or custom messages that are not tied to a specific link.

js

try {
  await navigator.share({
    text: 'Check out this order summary from my Shopify app!',
  });
} catch (err) {
  console.log('Share failed', err);
}

Was this page helpful?