@shopify/app-bridge

App Bridge

The App Bridge enables Apps on Shopify to access native Shopify features across different platforms.

Use App Bridge in a project

yarn add @shopify/app-bridge

Set up a client

Import the client library from the app-bridge package and provide configuration:

import createApp, {getShopOrigin} from '@shopify/app-bridge';

const app = createApp({
  apiKey: 'my api key from partner dashboard',
  shopOrigin: getShopOrigin(),
});

Use actions

A list of available actions can be found in the actions source folder.

Development

Build Scripts

• yarn build build the files into CommonJS into the lib and ES6 inside thelib-esm folder with source map
• yarn start build a development version of the libraries, and run the test app inside test
• yarn watch build a development version of the libraries and automatically rebuild when files have changed
• yarn clean remove the lib and lib-esm folders
• yarn lint run the linter
• yarn check run typescript checking

Test Scripts

• yarn test run all tests using jest
• yarn test:watch run all tests in watch mode and auto-run on changes
• yarn test:coverage run all tests and generate coverage report

Prettier config

To enable automatic prettier formatting copy or link the pre-commit script to .git/hooks/pre-commit and make sure it's executable, e.g.:

ln -s -f ../../scripts/pre-commit .git/hooks/pre-commit