Skip to main content

Custom data

Storefront Web Components can be used to display custom data stored in metafields and metaobjects from your Shopify store. This guide covers some of the most common ways to use custom data, and includes ready-to-use examples that you can adapt to your own storefront.

Anchor to custom-data-setupSetup

Although Storefront Web Components don't require an access token for most use cases, you need to provide a Storefront API access token to fetch metafields and metaobjects.

To set up a Storefront API access token:

  1. Install either the Hydrogen or Headless sales channel in your Shopify admin.
  2. Create a new storefront within the sales channel.
  3. Copy your public access token from your storefront settings:
    • Hydrogen: Navigate to Storefront settings and find the public access token in the Storefront API section.
    • Headless: Inside the Manage API access section of your storefront, click on the Manage button for the Storefront API to find the public access token.
  4. Make sure that access is enabled for metaobjects in the Permissions section.
  5. In your Storefront Web Components code, add the public access token to the public-access-token attribute of your shopify-store component.
API docsshopify-store component

Add a store component

<!-- The public-access-token is required
for access to metafields and metaobjects -->
<shopify-store
public-access-token="your-access-token"
store-domain="your-store-domain"
></shopify-store>

Anchor to render-metafieldRender a metafield

To display a product's metafield data on your storefront:

  1. Create a shopify-context component that targets your specific product.
  2. Inside the product context, add another shopify-context component that targets the metafield. Specify the metafield's namespace and key as attributes. You can find the namespace and key in the Metafields and metaobjects settings in your Shopify admin.
  3. Within the metafield context, use a shopify-data component to display the metafield's value on the page.
Anchor to render-a-metafield-render-a-product-metafieldRender a product metafield

This example shows how to render a product's metafield data on your storefront.

Anchor to render-a-metafield-render-a-currency-metafieldRender a currency metafield

This example shows how to render a currency metafield.

Render a product metafield

<!-- The public-access-token is required
for access to metafields and metaobjects -->
<shopify-store
public-access-token="your-access-token"
store-domain="your-store-domain"
></shopify-store>

<shopify-context
type="product"
handle="your-product-handle"
>
<template>
<shopify-context
type="metafield"
query="product.metafield"
key="your-metafield-key"
namespace="your-metafield-namespace"
>
<template>
<shopify-data
query="metafield.value"
></shopify-data>
</template>
</shopify-context>
</template>
</shopify-context>

Anchor to metafield-referencesMetafield references

You can use a metafield to reference other objects in your store. For example, you can use a metafield on a product to reference another product. To render a metafield reference:

  1. Create a shopify-context component that targets your specific product.
  2. Inside the product context, add another shopify-context component that targets the metafield. Specify the metafield's namespace and key as attributes. You can find the namespace and key in the Metafields and metaobjects settings in your Shopify admin.
  3. Within the metafield context, add another shopify-context component that targets the reference.
  4. Within the reference context, use a shopify-data component to display the reference's value on the page.
Anchor to metafield-references-render-a-metafield-referenceRender a metafield reference

This example shows how to render a metafield that references another product.

Anchor to metafield-references-render-a-list-of-metafield-referencesRender a list of metafield references

This example shows how to render a metafield that references a list of products.

Anchor to metafield-references-render-an-image-from-a-metafield-referenceRender an image from a metafield reference

This example shows how to render an image from a metafield reference.

Render a metafield reference

<!-- The public-access-token is required
for access to metafields and metaobjects -->
<shopify-store
public-access-token="your-access-token"
store-domain="your-store-domain"
></shopify-store>

<!-- A context for the product -->
<shopify-context
type="product"
handle="your-product-handle"
>
<template>
<!-- A context for the metafield -->
<shopify-context
type="metafield"
query="product.metafield"
key="your-metafield-key"
namespace="your-metafield-namespace"
>
<template>
<!-- A context for the product
that the metafield references -->
<shopify-context
type="product"
query="metafield.reference"
>
<template>
<div>
<shopify-data
query="product.title"
></shopify-data>
</div>
</template>
</shopify-context>
</template>
</shopify-context>
</template>
</shopify-context>

Anchor to metaobjectsRender a metaobject

Metaobjects are dynamic objects that store custom data in your Shopify store. You can render metaobjects using Storefront Web Components with a shopify-context component:

  1. Create a shopify-context component with type="metaobject" and handle attributes. The handle attribute specifies which metaobject to render. You can find the handle values for each metaobject on the Entries page in your Shopify admin.
  2. Add a metaobject-definition-type attribute to the same shopify-context component to specify the metaobject definition type.
  3. To access metafields within the metaobject, add a nested shopify-context component with type="field" and key attributes. The key attribute identifies which metafield to target. You can find the key values for each metafield in the Metafields and metaobjects settings in your Shopify admin.
  4. Inside the metafield context, add your template and components to display the metafield data.
Anchor to render-a-metaobject-render-a-metaobjectRender a metaobject

This example shows how to render metafields within a metaobject.

Anchor to render-a-metaobject-render-a-list-of-metaobjectsRender a list of metaobjects

This example shows how to render a list of metaobjects with a shopify-list-context component.

Anchor to render-a-metaobject-render-a-metaobject-referenceRender a metaobject reference

This example shows how to render a product and image reference from a metaobject.

Render a metaobject

<!-- The public-access-token is required
for access to metafields and metaobjects -->
<shopify-store
public-access-token="your-access-token"
store-domain="your-store-domain"
></shopify-store>

<!-- A context for the metaobject. It must contain
a metaobject attribute with the metaobject name -->
<shopify-context
type="metaobject"
handle="your-metaobject-handle"
metaobject-definition-type="your-metaobject-definition-type"
>
<template>
<!-- A context for the metafield.
It must contain the metafield key -->
<shopify-context
type="field"
query="metaobject.field"
key="your-metafield-key"
>
<template>
<div>
<shopify-data
query="field.value"
></shopify-data>
</div>
</template>
</shopify-context>
</template>
</shopify-context>

Anchor to custom-componentsCustom components

Metafields support various data types, including rich text, links, numbers, dates, JSON, and file references. The shopify-data component displays the raw metafield value as-is. For more sophisticated presentations of complex data types like JSON objects or structured content, you can build custom components that receive the metafield value as an attribute with the shopify-attr attribute.

API docsshopify-attr attribute

Add a custom component

<script>
// Define a custom component that renders a JSON object
class CustomComponent extends HTMLElement {
constructor() {
super();
}
connectedCallback() {
const value = JSON.parse(
this.getAttribute("value"),
);
this.innerHTML = `
<div>
<h1>${value.title}</h1>
<p>${value.description}</p>
</div>
`;
}
}

// Register the custom component
customElements.define(
"custom-component",
CustomComponent,
);
</script>

<!-- The public-access-token is required
for access to metafields and metaobjects -->
<shopify-store
public-access-token="your-access-token"
store-domain="your-store-domain"
></shopify-store>

<shopify-context
type="product"
handle="your-product-handle"
>
<template>
<shopify-context
type="metafield"
query="product.metafield"
key="your-metafield-key"
namespace="your-metafield-namespace"
>
<template>
<!-- Bind the metafield value to the
value attribute of the custom component -->
<custom-component
shopify-attr--value="metafield.value"
></custom-component>
</template>
</shopify-context>
</template>
</shopify-context>