Sharing

Requirements

These actions require the following app versions:

  • Shopify iOS v8.22.0 or above
  • Shopify Android v8.25.0 or above
  • Point of Sale iOS v5.29.0 or above
  • Point of Sale Android v3.24.0 or above

Setup

Create an app and import the Share module from @shopify/app-bridge/actions. Note that we'll be referring to this sample application throughout the examples below.

import createApp from '@shopify/app-bridge';
import {Group, Share} from '@shopify/app-bridge/actions';

var app = createApp({
  apiKey: '12345',
  shopOrigin: shopOrigin
});

var share = Share.create(app);

Share Close action

Group Share
Action CLOSE
Action Type APP::SHARE::CLOSE
Description Dispatches after closing the Share Sheet.

The Share action lets you share content from your app to any third-party app on the user's device, as long as the app supports the payload type. Some apps only support text and some support URLs and text.

Subscribe to Share Close:

scanner.subscribe(Share.Action.CLOSE, function(payload) {
  // The payload will contain `success` as its only property. This is set to `true` upon a successful share and set to `false` if the action is canceled.
});

Response

Key Type Description
success Boolean Whether the share was successful or canceled.

Share Open action

Group Share
Action SHOW
Action Type APP::SHARE::SHOW
Description Opens a Share Sheet that allows you to share content with other apps.
share.dispatch(Share.Action.SHOW, {
    text: "Hey check this out!",
    url: "https://www.reallyawesomesite.com"
});

Request

Key Type Description
text String? The text to share.
url String? The URL to share.

Sign up for a Partner account to get started.

Sign up