Migrating from legacy SDKs
Shopify App Bridge offers the same functionality as the EASDK and POS App SDK. Shopify App Bridge is designed to replace both of these legacy libraries, providing a consistent experience to both developers and merchants.
Using the backwards compatibility layer
Although Shopify App Bridge is intended to replace EASDK and POS App SDK, you do not need to rewrite your existing apps. Shopify App Bridge works with a backwards compatibility layer that listens for legacy EASDK and POS App SDK methods and translates them to Shopify App Bridge actions. If your app is calling EASDK methods today, these are already passing through Shopify App Bridge’s backwards compatibility layer.
This means that all existing embedded apps, without updating any of their code, get some of the benefits of Shopify App Bridge for free:
- more consistent cross-platform rendering and functionality
- access to better developer tools for debugging and better error reporting
- increased stability
- tighter integration with Polaris
- access to some new Shopify features, including the Navigation app extension and Resource Pickers for products and collections
Using Shopify App Bridge directly
Apps that don’t use the backwards compatibility layer, such as new apps built using Shopify App Bridge or apps that choose to upgrade to use Shopify App Bridge actions directly, get a number of additional benefits not available through the backwards compatibility layer:
- strict versioning using SemVer, for even more stability and predictability
- more and clearer error messaging than is available through the backwards compatibility layer
Access to new Shopify features and Shopify App Bridge actions that will not be made available through the backwards compatibility layer, including a new Product Variant Resource Picker and new Redirect actions.
In the future, most new features will be added to Shopify App Bridge only, and will not be made available to the EASDK. We recommend that you upgrade to using Shopify App Bridge if you’re building a new app or doing significant upgrades to your existing app.
Migrating your EASDK app
The best place to start is the Embedded App SDK (EASDK) documentation, which has been updated with corresponding App Bridge methods. Here are a few additional things to keep in mind when migrating an existing app from EASDK to Shopify App Bridge.
Input modals are not supported in Shopify App Bridge.
You can use an iFrame modal instead.
Modal size is set in increments in App Bridge.
Modals will not accept URLs from outside of your app’s origin.
To embed content from another domain, create an iFrame modal and embed the content there.
Tertiary modal buttons
Because Shopify App Bridge gives you full control over button styling, primary and secondary buttons can now cover all use cases.
Setting an app icon via
ShopifyApp.Bar.initialize with an
icon param has been deprecated.
You can now set your app icon on the App setup page in the Partners Dashboard.
init with the
debug option is not supported in App Bridge.
We recommend using the Redux DevTools instead.
Since App Bridge allows you to fully customize titlebar buttons, adding pagination to the title bar using
ShopifyApp.Bar.setPagination has been deprecated.
protocol URL parameter
Since all embedded apps must use HTTPS, the
protocol parameter is no longer relevant.
Keeping the frame URL in sync
initialize function automatically updates the Shopify admin URL.
If your app uses links or server-side redirects for navigation, you can keep the URL in sync by dispatching a
History.Action.PUSH action wherever you called EASDK’s
initialize method (for example, after
Using ES5 and the CDN-hosted version:
Migrating your POS App SDK app
The POS App SDK documentation has been updated with corresponding Shopify App Bridge methods. Here are a few more things to keep in mind when migrating an existing app to Shopify App Bridge.
All cart-related functionality is handled by the
Cart action set in Shopify App Bridge.
There are three steps to dispatch a cart action.
- Create the
Cartaction group instance:
- Subscribe to the cart update action, which returns an unsubscribe function:
- Dispatch the desired cart action. Depending on the action, you may need to construct the action using a method from
A simple cart action, passing the action type to
A more complex cart action, using an action constructor method:
Fetching user and location data
In the POS App SDK, user and location data were fetched using dedicated methods.
In Shopify App Bridge, this data is accessed using
POS Close Modal
There is no equivalent action in Shopify App Bridge.