Skip to main content

Hydrogen

Hydrogen is Shopify’s opinionated stack for headless commerce, built on React Router. It provides a set of tools, utilities, and best-in-class examples for building dynamic and performant commerce applications.

Anchor to setupSetup

  1. Create a new Hydrogen project with your preferred package manager.
  2. Import components, hooks, or utilities that you want to use in your app. For more, see the getting started guide.
TutorialGetting started with Hydrogen and Oxygen

Create a new Hydrogen project

npm create @shopify/hydrogen@latest

Anchor to authenticationAuthentication

To make full use of Hydrogen, you need to authenticate with and make requests to the Storefront API and the Customer Account API. Hydrogen includes full-featured API clients to securely handle API queries and mutations.

You can create access tokens for your own Shopify store by installing the Hydrogen sales channel, which includes built-in support for Oxygen, Shopify’s global edge hosting platform. Or install the Headless sales channel to host your Hydrogen app anywhere.

Both the Storefront API and Customer Account API offer public credentials for client-side applications.

InstallHydrogen sales channel
InstallHeadless sales channel

Authenticate a Hydrogen app

/**
* server.js
* ---------
* Create a storefront client.
* Check the server.js file in the root of your new Hydrogen project to see
* an example implementation of this function. If you start from an official
* Hydrogen template (Hello World or Demo Store), then the client is already
* set up for you. Update the Shopify store domain and API token to start
* querying your own store inventory.
*/
const {storefront} = createStorefrontClient({
cache,
waitUntil,
i18n: {language: 'EN', country: 'US'},
// `env` provides access to runtime data, including environment variables
publicStorefrontToken: env.PUBLIC_STOREFRONT_API_TOKEN,
privateStorefrontToken: env.PRIVATE_STOREFRONT_API_TOKEN,
storeDomain: env.PUBLIC_STORE_DOMAIN,
storefrontId: env.PUBLIC_STOREFRONT_ID,
storefrontHeaders: getStorefrontHeaders(request),
});

Anchor to versioningVersioning

Hydrogen is tied to specific versions of the Storefront API, which is versioned quarterly. For example, if you're using Storefront API version 2023-10, then Hydrogen versions 2023.10.x are fully compatible.

Caution

If a Storefront API version includes breaking changes, then the corresponding Hydrogen version will include the same breaking changes.

Learn moreShopify API versioning
Learn moreAPI release notes

Anchor to hydrogen_reactHow Hydrogen works with Hydrogen React

Hydrogen is built on React Router. But many of the components, hooks and utilities built into Hydrogen come from Hydrogen React, an underlying package that’s framework-agnostic. For convenience, the Hydrogen package re-exports those resources. This means that if you’re building a Hydrogen app, then you should import modules from the @shopify/hydrogen package.

Importing Hydrogen components

example-page.jsx

import {ShopPayButton} from '@shopify/hydrogen';

export function renderShopPayButton({variantId, storeDomain}) {
return <ShopPayButton variantIds={[variantId]} storeDomain={storeDomain} />;
}

Anchor to resourcesResources

Custom storefronts on Shopify
Learn more about how to design, build, and manage custom storefronts on Shopify.
Hydrogen on GitHub
Follow the Hydrogen project, file bugs and feature requests, preview upcoming features, and more