---

!npm

Table of Contents

- Installation
- Configuration
- Migration
- Usage
- Components
- Hooks
- Issues
- 🐛 Bugs
- 💡 Feature Requests
- ❓ Questions
- License

Installation

Run the following command using npm:

``bash
npm install --save @shopify/app-bridge-react
`

If you prefer Yarn, use the following command instead:

`bash
yarn add @shopify/app-bridge-react
`

If you prefer pnpm, use the following command instead:

`bash
pnpm add @shopify/app-bridge-react
`

Configuration

1. Include the app-bridge.js script tag in your app. Replace %SHOPIFY_API_KEY% with your app's client ID. This configures your app to use Shopify App Bridge.

The app-bridge.js script is CDN-hosted, so your app always gets the latest version of it.

`html




`

2. This library has peerDependencies listings for react and react-dom. Ensure you're using version 18.0.0 or higher of both packages.

Migration from previous versions

For information on how to migrate from Shopify App Bridge React 3.x.x, see the migration guide.

Usage

$3

App Bridge React provides a few component wrappers for the custom elements available in App Bridge, such as Modal, NavMenu, and TitleBar.

`jsx
import {Modal, TitleBar, useAppBridge} from '@shopify/app-bridge-react';

function SocialMediaModal() {
const shopify = useAppBridge();

function handlePrimaryAction() {
// Perform actions when the primary button is clicked
shopify.modal.show('social-media-modal');
}

return (
<>
modalRef.current?.show()}>
Expand Your Reach





Expand your reach and attract more customers by enabling easy social
media sharing of your products.





Enable Social Sharing




);
}
`

$3

App Bridge React provides the useAppBridge hook to make accessing the shopify global variable simple and helpful when used in a server-side rendered app. This variable exposes various App Bridge functionalities, such as displaying toast notifications or retrieving app configuration details. See the documentation for more information on what is available through the shopify variable.

`jsx
import {useAppBridge} from '@shopify/app-bridge-react';

function GenerateBlogPostButton() {
const shopify = useAppBridge();

function generateBlogPost() {
// Handle generating
shopify.toast.show('Blog post template generated');
}

return Generate Blog Post;
}
``

Issues

$3

Please file an issue for bugs, missing documentation, or unexpected behaviour using this template.

$3

Please file an issue to suggest new features using this template.

$3

For questions related to using the library, please visit the Shopify Partner Slack linked in the Resources page of your Shopify Partner Dashboard.

License

MIT