@shopify/app-bridge/README.md

# `@shopify/app-bridge`

[![Build Status](https://travis-ci.com/Shopify/app-bridge.svg?token=RBRyvqQyN525bnfz7J8p&branch=master)](https://travis-ci.com/Shopify/app-bridge)
[![codecov](https://codecov.io/gh/Shopify/app-bridge/branch/master/graph/badge.svg?token=nZ21m39Dr6)](https://codecov.io/gh/Shopify/app-bridge)
[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE.md)
[![npm version](https://badge.fury.io/js/%40shopify%2Fapp-bridge.svg)](https://badge.fury.io/js/%40shopify%2Fapp-bridge.svg)
[![npm bundle size (minified + gzip)](https://img.shields.io/bundlephobia/minzip/@shopify/app-bridge.svg)](https://img.shields.io/bundlephobia/minzip/@shopify/app-bridge.svg)

You can use Shopify App Bridge to embed apps and channels directly into the Shopify admin, Shopify Mobile, and Shopify POS. Shopify App Bridge helps to reduce your development time by accessing native Shopify features across different platforms, and makes sure that the user experience is consistent wherever merchants are using your app.

Shopify App Bridge is currently being released as an update to all current consumers of the [Embedded App SDK](https://help.shopify.com/en/api/embedded-apps/embedded-app-sdk). Since it’s backwards compatible, you don't need to update your existing apps for them to support Shopify App Bridge.

## Installation

You can install Shopify App Bridge by using [Yarn](https://yarnpkg.com):

``` sh
yarn add @shopify/app-bridge
```

## Usage

### Set up your app

In the following example, you need to store `shopOrigin` during the authentication process and then retrieve it for the code to work properly. To learn more about this process, see [Getting and storing the shop origin](https://help.shopify.com/en/api/embedded-apps/shop-origin).

Import the library from the `@shopify/app-bridge` package and provide a configuration:

``` ts
import createApp from '@shopify/app-bridge';

const app = createApp({
  apiKey: 'API key from Shopify Partner Dashboard',
  shopOrigin: shopOrigin,
});
```

### Actions

Shopify App Bridge introduces the concept of actions. An action provides a way for applications and hosts to trigger events with a statically-typed payload.

To learn more about the supported actions, see the [actions source folder](./src/actions).

### App State

Once the app is set up, you can access additional details and the state of the app at
any time by making async call `app.getState()`:

```ts
app.getState().then((state: any) => {
  console.info('App State: %o', state)
});
```

You can also use a shorthand to retrieve nested properties by passing in a `query` when calling `getState(query)`, for example:

```ts
app.getState('pos.user').then((user: any) => {
  console.log('POS User: %o', user);
});
```

### Hooks

Shopify App Bridge can be extended with hooks, which run when actions are dispatched and updated.
Hooks are middleware that can modify or cancel actions.

To learn more about hooks, see the [hooks documentation](./src/client/Hooks.md).

### Development & Debugging

Shopify App Bridge is shipped with a development build which includes the [validation middleware](./src/validate/README.MD) in order to provide helpful information during development.

If you're consuming App Bridge from a CDN or using the UMD build, simply include the development version:
`umd/index.development.js` instead of `umd/index.js`

When consumed as JS Modules, development/production build is dynamically selected based on the `NODE_ENV` variable. Development build is used when `NODE_ENV=development`.

Please note that the development build is not intended for production use, as the resulting file size is significantly larger due to the validator being present.

## Contributing

### Useful scripts

- `yarn start` - Start a development server.
- `yarn build` - Build the library, compiling the source TypeScript into JavaScript.
- `yarn clean` - Remove any artifacts produced by the `build` script.
- `yarn lint` - Run the source linter.
- `yarn check` - Run the TypeScript type checker.

### Running the tests

- `yarn test` - Run the tests.
- `yarn test:watch` - Run the tests in watch mode and auto-rerun on changes.
- `yarn test:coverage` - Run the tests and generate a coverage report.

### Prettier config

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

### Conventional Commits

Please follow a standardized commit message format when contributing to this repo:
https://www.conventionalcommits.org/en/v1.0.0-beta.2/