[{"_1":2,"_371":-5,"_372":-5},"loaderData",{"_3":4,"_165":166},"routes/global-wrapper",{"_5":6,"_85":86,"_93":94,"_162":163,"_164":15},"search",{"_7":8,"_20":21},"selectableVersions",{"_9":10},"default",{"_11":12,"_19":17},"values",[13,14,15,16,17,18],"unstable","2025-10","2025-07","2025-04","2025-01","2024-10","stable_version","categories",[22,31,35,38,41,44,47,50,53,56,59,62,66,70,73,76,79,82],{"_23":24,"_25":26,"_27":28,"_29":30},"name","API: Admin Extensions","referenceName","admin-extensions","versioned",true,"cookieName","api_version",{"_23":32,"_25":33,"_27":34,"_29":30},"API: App Bridge Library","app-bridge-library",false,{"_23":36,"_25":37,"_27":34,"_29":30},"API: App home","app-home",{"_23":39,"_25":40,"_27":28,"_29":30},"API: Checkout UI extensions","checkout-ui-extensions",{"_23":42,"_25":43,"_27":28,"_29":30},"API: Customer account UI extensions","customer-account-ui-extensions",{"_23":45,"_25":46,"_27":34,"_29":30},"API: Generate docs","generate-docs",{"_23":48,"_25":49,"_27":28,"_29":30},"API: Hydrogen","hydrogen",{"_23":51,"_25":52,"_27":28,"_29":30},"API: Hydrogen React","hydrogen-react",{"_23":54,"_25":55,"_27":34,"_29":30},"API: MDX components","mdx-components",{"_23":57,"_25":58,"_27":28,"_29":30},"API: POS UI Extensions","pos-ui-extensions",{"_23":60,"_25":61,"_27":34,"_29":30},"API: Shop Minis","shop-minis",{"_23":63,"_25":64,"_27":28,"_29":65},"API: shopify app react router","shopify-app-react-router","api_version_shopify-app-react-router",{"_23":67,"_25":68,"_27":28,"_29":69},"API: shopify app remix","shopify-app-remix","api_version_shopify-app-remix",{"_23":71,"_25":72,"_27":34,"_29":30},"API: Shopify CLI","shopify-cli",{"_23":74,"_25":75,"_27":34,"_29":30},"API: Storefront web components","storefront-web-components",{"_23":77,"_25":78,"_27":34,"_29":30},"API: Tutorials","tutorials",{"_23":80,"_25":81,"_27":34,"_29":30},"API: Web Pixels API","web-pixels-api",{"_23":83,"_25":84,"_27":28,"_29":30},"API: Webhooks","webhooks","userPreferences",{"_87":88,"_89":90,"_30":15,"_91":92},"gqlLanguage","remix","webhooksReference","toml","pickerPreferences",{},"features",[95,96,97,98,99,100,101,102,103,104,105,106,107,108,109,110,111,112,113,114,115,116,117,118,119,120,121,122,123,124,125,126,127,128,129,130,131,132,133,134,135,136,137,138,139,140,141,142,143,144,145,146,147,148,149,150,151,152,153,154,155,156,157,158,159,160,161],"adaptive_rate_limiter","ai_theme_block_gen","automated_privacy","cli_managed_subscription_link_creation_and_migration","combined_listings","conditional_settings","customer_account_ui_extensions_stable_docs","dat_scheduled_feature_tho","dev_assistant_ui_changes","dev_assistant_vscode_extension","dev_tools_liquiddoc_v2","discounts_allocator_function","editor_extension_collections_docs","enforce_fulfillment_order_status_on_create_fulfillment","explicit_buyer_consent","flex_sections","functions_references","functions_wasm","functions-next","gql_ai","gql_ai_v2","gql_example_switcher","gql_operation_cache","headless_cmp","identity_dropdown","identity_integration","markdown_download","mcp_dev_docs","mockshop_ai","mockshop_ai_disable_force_ai","multi_class_discount_functions","multi_class_discount_ui","nested_lines","net_new_webhooks_reference_2024","next-gen-dev-platform","online_store_new_datasources","online_store_passing_preset_names","open_source_subscriptions_1p_app","optional_scopes","product_configuration_ui_extension_url_config","product_discount_cart_line_targeting","purchase_options_extensions","remove_php_example","rest_admin_api_deprecation","rev_share_jan24","sched_2","schedule_test","shipping_discount_functions_general_availability","shop_minis","ssr-changelog","ssr-erb","ssr-gqlMDX","ssr-graphql","ssr-liquid","ssr-markdown","ssr-rest","ssr-templatedRefs","ssr-tutorial","static_blocks","storefront_components","style_settings","subs_thank_you_extensions","theme_blocks","theme_blocks_data_sources","theme_blocks_ga","versioned_app_config","zero_redirect_auth","hostname","shopify-dev.shopifycloud.com","apiVersion","templated-resource-hydrogen",{"_167":168,"_357":28,"_358":359,"_364":365,"_164":366,"_367":49,"_368":369,"_370":34},"pageContent",{"_23":169,"_170":171,"_172":34,"_173":174,"_175":176,"_177":178,"_179":180,"_199":200,"_348":349,"_350":-7,"_232":-7,"_351":-7,"_352":353,"_354":355,"_356":-7},"getSeoMeta","category","utilities","isVisualComponent","related",[],"description","Generate a [Remix meta array](https://remix.run/docs/en/main/route/meta) from one or more SEO configuration objects. Pass SEO configuration for the parent route(s) and the current route to preserve meta data for all active routes. Similar to [`Object.assign()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/assign), each property is overwritten based on the object order. The exception is `jsonLd`, which is preserved so that each route has it's own independent jsonLd meta data. Learn more about [how SEO works in Hydrogen](https://shopify.dev/docs/custom-storefronts/hydrogen/seo).","type","utility","defaultExample",{"_175":181,"_182":183,"_198":-7},"I am the default example","codeblock",{"_184":185,"_187":197},"tabs",[186,193],{"_187":188,"_189":190,"_191":192},"title","JavaScript","code","import {getSeoMeta} from '@shopify/hydrogen';\n\nexport async function loader({context}) {\n const {shop} = await context.storefront.query(`\n query layout {\n shop {\n name\n description\n }\n }\n `);\n\n return {\n seo: {\n title: shop.title,\n description: shop.description,\n },\n };\n}\n\nexport const meta = ({data, matches}) => {\n // Pass one or more arguments, preserving properties from parent routes\n return getSeoMeta(matches[0].data.seo, data.seo);\n};\n","language","js",{"_187":194,"_189":195,"_191":196},"TypeScript","import {MetaFunction} from '@remix-run/react';\nimport {LoaderFunctionArgs} from '@remix-run/server-runtime';\nimport {getSeoMeta} from '@shopify/hydrogen';\n\nexport async function loader({context}: LoaderFunctionArgs) {\n const {shop} = await context.storefront.query(`\n query layout {\n shop {\n name\n description\n }\n }\n `);\n\n return {\n seo: {\n title: shop.title,\n description: shop.description,\n },\n };\n}\n\nexport const meta: MetaFunction<typeof loader> = ({data, matches}) => {\n // Pass one or more arguments, preserving properties from parent routes\n return getSeoMeta((matches as any).data.seo, data!.seo);\n};\n","ts","Example code","image","definitions",[201],{"_187":169,"_175":202,"_177":203,"_204":205},"","GetSeoMetaTypeForDocs","typeDefinitions",{"_203":206,"_220":221,"_284":285,"_303":304,"_281":314},{"_207":208,"_209":210,"_23":203,"_211":212,"_175":202,"_213":214},"filePath","/seo/getSeoMeta.ts","syntaxKind","TypeAliasDeclaration","value","{\n /** `getSeoMeta` takes an arbitrary number of configuration object parameters. Values in each object are overwritten based on the object order. \\`jsonLd\\` properties are preserved between each configuration object. */\n seoInputs: SeoConfig[];\n}","members",[215],{"_207":208,"_209":216,"_23":217,"_211":218,"_175":219},"PropertySignature","seoInputs","SeoConfig[]","`getSeoMeta` takes an arbitrary number of configuration object parameters. Values in each object are overwritten based on the object order. \\`jsonLd\\` properties are preserved between each configuration object.","SeoConfig",{"_207":222,"_23":220,"_175":202,"_213":223,"_211":283},"/seo/generate-seo-tags.ts",[224,228,239,248,250,253,261,270,279],{"_207":222,"_209":216,"_23":187,"_211":225,"_175":226,"_227":28},"Maybe","The `title` HTML element defines the document's title that is shown in a browser's title bar or a page's tab. It only contains text; tags within the element are ignored.","isOptional",{"_207":222,"_209":216,"_23":229,"_211":230,"_175":231,"_227":28,"_232":233},"titleTemplate","string","Generate the title from a template that includes a `%s` placeholder for the title.","examples",[234],{"_187":235,"_175":202,"_184":236},"Example",[237],{"_189":238,"_187":235},"{\n title: 'My Page',\n titleTemplate: 'My Site - %s',\n}",{"_207":222,"_209":216,"_23":240,"_211":241,"_175":242,"_227":28,"_232":243},"media","string | Partial | (string | Partial)[]","The media associated with the given page (images, videos, etc). If you pass a string, it will be used as the `og:image` meta tag. If you pass an object or an array of objects, that will be used to generate `og:` meta tags. The `url` property should be the URL of the media. The `height` and `width` properties are optional and should be the height and width of the media. The `altText` property is optional and should be a description of the media.",[244],{"_187":235,"_175":202,"_184":245},[246],{"_189":247,"_187":235},"{\n media: [\n {\n url: 'https://example.com/image.jpg',\n type: 'image',\n height: '400',\n width: '400',\n altText: 'A custom snowboard with an alpine color pallet.',\n }\n ]\n}",{"_207":222,"_209":216,"_23":175,"_211":225,"_175":249,"_227":28},"The description of the page. This is used in the `name=\"description\"` meta tag as well as the `og:description` meta tag.",{"_207":222,"_209":216,"_23":251,"_211":225,"_175":252,"_227":28},"url","The canonical URL of the page. This is used to tell search engines which URL is the canonical version of a page. This is useful when you have multiple URLs that point to the same page. The value here will be used in the `rel=\"canonical\"` link tag as well as the `og:url` meta tag.",{"_207":222,"_209":216,"_23":254,"_211":225,"_175":255,"_227":28,"_232":256},"handle","The handle is used to generate the `twitter:site` and `twitter:creator` meta tags. Include the `@` symbol in the handle.",[257],{"_187":235,"_175":202,"_184":258},[259],{"_189":260,"_187":235},"{\n handle: '@shopify'\n}",{"_207":222,"_209":216,"_23":262,"_211":263,"_175":264,"_227":28,"_232":265},"jsonLd","WithContext | WithContext[]","The `jsonLd` property is used to generate the `application/ld+json` script tag. This is used to provide structured data to search engines. The value should be an object that conforms to the schema.org spec. The `type` property should be the type of schema you are using. The `type` property is required and should be one of the following:\n\n- `Product` - `ItemList` - `Organization` - `WebSite` - `WebPage` - `BlogPosting` - `Thing`\n\nThe value is validated via [schema-dts](https://www.npmjs.com/package/schema-dts)",[266],{"_187":235,"_175":202,"_184":267},[268],{"_189":269,"_187":235},"{\n jsonLd: {\n '@context': 'https://schema.org',\n '@type': 'Product',\n name: 'My Product',\n image: 'https://hydrogen.shop/image.jpg',\n description: 'A product that is great',\n sku: '12345',\n mpn: '12345',\n brand: {\n '@type': 'Thing',\n name: 'My Brand',\n },\n aggregateRating: {\n '@type': 'AggregateRating',\n ratingValue: '4.5',\n reviewCount: '100',\n },\n offers: {\n '@type': 'Offer',\n priceCurrency: 'USD',\n price: '100',\n priceValidUntil: '2020-11-05',\n itemCondition: 'https://schema.org/NewCondition',\n availability: 'https://schema.org/InStock',\n seller: {\n '@type': 'Organization',\n name: 'My Brand',\n },\n },\n }\n}",{"_207":222,"_209":216,"_23":271,"_211":272,"_175":273,"_227":28,"_232":274},"alternates","LanguageAlternate | LanguageAlternate[]","The `alternates` property is used to specify the language and geographical targeting when you have multiple versions of the same page in different languages. The `url` property tells search engines about these variations and helps them to serve the correct version to their users.",[275],{"_187":235,"_175":202,"_184":276},[277],{"_189":278,"_187":235},"{\n alternates: [\n {\n language: 'en-US',\n url: 'https://hydrogen.shop/en-us',\n default: true,\n },\n {\n language: 'fr-CA',\n url: 'https://hydrogen.shop/fr-ca',\n },\n ]\n}",{"_207":222,"_209":216,"_23":280,"_211":281,"_175":282,"_227":28},"robots","RobotsOptions","The `robots` property is used to specify the robots meta tag. This is used to tell search engines which pages should be indexed and which should not.","export interface SeoConfig {\n /**\n * The `title` HTML element defines the document's title that is shown in a browser's title bar or a page's tab. It\n * only contains text; tags within the element are ignored.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/title\n */\n title?: Maybe;\n /**\n * Generate the title from a template that includes a `%s` placeholder for the title.\n *\n * @example\n * ```js\n * {\n * title: 'My Page',\n * titleTemplate: 'My Site - %s',\n * }\n * ```\n */\n titleTemplate?: Maybe | null;\n /**\n * The media associated with the given page (images, videos, etc). If you pass a string, it will be used as the\n * `og:image` meta tag. If you pass an object or an array of objects, that will be used to generate `og:` meta tags. The `url` property should be the URL of the media. The `height` and `width` properties are\n * optional and should be the height and width of the media. The `altText` property is optional and should be a\n * description of the media.\n *\n * @example\n * ```js\n * {\n * media: [\n * {\n * url: 'https://example.com/image.jpg',\n * type: 'image',\n * height: '400',\n * width: '400',\n * altText: 'A custom snowboard with an alpine color pallet.',\n * }\n * ]\n * }\n * ```\n *\n */\n media?:\n | Maybe\n | Partial\n | (Partial | Maybe)[];\n /**\n * The description of the page. This is used in the `name=\"description\"` meta tag as well as the `og:description` meta\n * tag.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/meta\n */\n description?: Maybe;\n /**\n * The canonical URL of the page. This is used to tell search engines which URL is the canonical version of a page.\n * This is useful when you have multiple URLs that point to the same page. The value here will be used in the\n * `rel=\"canonical\"` link tag as well as the `og:url` meta tag.\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link\n */\n url?: Maybe;\n /**\n * The handle is used to generate the `twitter:site` and `twitter:creator` meta tags. Include the `@` symbol in the\n * handle.\n *\n * @example\n * ```js\n * {\n * handle: '@shopify'\n * }\n * ```\n */\n handle?: Maybe;\n /**\n * The `jsonLd` property is used to generate the `application/ld+json` script tag. This is used to provide structured\n * data to search engines. The value should be an object that conforms to the schema.org spec. The `type` property\n * should be the type of schema you are using. The `type` property is required and should be one of the following:\n *\n * - `Product`\n * - `ItemList`\n * - `Organization`\n * - `WebSite`\n * - `WebPage`\n * - `BlogPosting`\n * - `Thing`\n *\n * The value is validated via [schema-dts](https://www.npmjs.com/package/schema-dts)\n *\n * @example\n * ```js\n * {\n * jsonLd: {\n * '@context': 'https://schema.org',\n * '@type': 'Product',\n * name: 'My Product',\n * image: 'https://hydrogen.shop/image.jpg',\n * description: 'A product that is great',\n * sku: '12345',\n * mpn: '12345',\n * brand: {\n * '@type': 'Thing',\n * name: 'My Brand',\n * },\n * aggregateRating: {\n * '@type': 'AggregateRating',\n * ratingValue: '4.5',\n * reviewCount: '100',\n * },\n * offers: {\n * '@type': 'Offer',\n * priceCurrency: 'USD',\n * price: '100',\n * priceValidUntil: '2020-11-05',\n * itemCondition: 'https://schema.org/NewCondition',\n * availability: 'https://schema.org/InStock',\n * seller: {\n * '@type': 'Organization',\n * name: 'My Brand',\n * },\n * },\n * }\n * }\n * ```\n *\n * @see https://schema.org/docs/schemas.html\n * @see https://developers.google.com/search/docs/guides/intro-structured-data\n * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/script\n *\n */\n jsonLd?: WithContext | WithContext[];\n /**\n * The `alternates` property is used to specify the language and geographical targeting when you have multiple\n * versions of the same page in different languages. The `url` property tells search engines about these variations\n * and helps them to serve the correct version to their users.\n *\n * @example\n * ```js\n * {\n * alternates: [\n * {\n * language: 'en-US',\n * url: 'https://hydrogen.shop/en-us',\n * default: true,\n * },\n * {\n * language: 'fr-CA',\n * url: 'https://hydrogen.shop/fr-ca',\n * },\n * ]\n * }\n * ```\n *\n * @see https://support.google.com/webmasters/answer/189077?hl=en\n */\n alternates?: LanguageAlternate | LanguageAlternate[];\n /**\n * The `robots` property is used to specify the robots meta tag. This is used to tell search engines which pages\n * should be indexed and which should not.\n *\n * @see https://developers.google.com/search/reference/robots_meta_tag\n */\n robots?: RobotsOptions;\n}","SeoMedia",{"_207":222,"_209":210,"_23":284,"_211":286,"_175":202,"_213":287},"{\n /**\n * Used to generate og: meta tag\n */\n type: 'image' | 'video' | 'audio';\n /**\n * The url value populates both url and secure_url and is used to infer the og::type meta tag.\n */\n url: Maybe | undefined;\n /**\n * The height in pixels of the media. This is used to generate the og::height meta tag.\n */\n height: Maybe | undefined;\n /**\n * The width in pixels of the media. This is used to generate the og::width meta tag.\n */\n width: Maybe | undefined;\n /**\n * The alt text for the media. This is used to generate the og::alt meta tag.\n */\n altText: Maybe | undefined;\n}",[288,291,293,297,300],{"_207":222,"_209":216,"_23":177,"_211":289,"_175":290},"\"audio\" | \"video\" | \"image\"","Used to generate og: meta tag",{"_207":222,"_209":216,"_23":251,"_211":230,"_175":292},"The url value populates both url and secure_url and is used to infer the og::type meta tag.",{"_207":222,"_209":216,"_23":294,"_211":295,"_175":296},"height","number","The height in pixels of the media. This is used to generate the og::height meta tag.",{"_207":222,"_209":216,"_23":298,"_211":295,"_175":299},"width","The width in pixels of the media. This is used to generate the og::width meta tag.",{"_207":222,"_209":216,"_23":301,"_211":230,"_175":302},"altText","The alt text for the media. This is used to generate the og::alt meta tag.","LanguageAlternate",{"_207":222,"_23":303,"_175":202,"_213":305,"_211":313},[306,308,311],{"_207":222,"_209":216,"_23":191,"_211":230,"_175":307},"Language code for the alternate page. This is used to generate the hreflang meta tag property.",{"_207":222,"_209":216,"_23":9,"_211":309,"_175":310,"_227":28},"boolean","Whether the alternate page is the default page. This will add the `x-default` attribution to the language code.",{"_207":222,"_209":216,"_23":251,"_211":230,"_175":312},"The url of the alternate page. This is used to generate the hreflang meta tag property.","export interface LanguageAlternate {\n /**\n * Language code for the alternate page. This is used to generate the hreflang meta tag property.\n */\n language: string;\n /**\n * Whether the alternate page is the default page. This will add the `x-default` attribution to the language code.\n */\n default?: boolean;\n /**\n * The url of the alternate page. This is used to generate the hreflang meta tag property.\n */\n url: string;\n}",{"_207":222,"_23":281,"_175":202,"_213":315,"_211":347},[316,320,323,326,329,332,335,338,341,344],{"_207":222,"_209":216,"_23":317,"_211":318,"_175":319,"_227":28},"maxImagePreview","\"none\" | \"standard\" | \"large\"","Set the maximum size of an image preview for this page in a search results Can be one of the following:\n\n- `none` - No image preview is to be shown. - `standard` - A default image preview may be shown. - `large` - A larger image preview, up to the width of the viewport, may be shown.\n\nIf no value is specified a default image preview size is used.",{"_207":222,"_209":216,"_23":321,"_211":295,"_175":322,"_227":28},"maxSnippet","A number representing the maximum of amount characters to use as a textual snippet for a search result. This value can also be set to one of the following special values:\n\n- 0 - No snippet is to be shown. Equivalent to nosnippet. - 1 - The Search engine will choose the snippet length that it believes is most effective to help users discover your content and direct users to your site - -1 - No limit on the number of characters that can be shown in the snippet.",{"_207":222,"_209":216,"_23":324,"_211":295,"_175":325,"_227":28},"maxVideoPreview","The maximum number of seconds for videos on this page to show in search results. This value can also be set to one of the following special values:\n\n- 0 - A static image may be used with the `maxImagePreview` setting. - 1 - There is no limit to the size of the video preview.\n\nThis applies to all forms of search results (at Google: web search, Google Images, Google Videos, Discover, Assistant).",{"_207":222,"_209":216,"_23":327,"_211":309,"_175":328,"_227":28},"noArchive","Do not show a cached link in search results.",{"_207":222,"_209":216,"_23":330,"_211":309,"_175":331,"_227":28},"noFollow","Do not follow the links on this page.",{"_207":222,"_209":216,"_23":333,"_211":309,"_175":334,"_227":28},"noImageIndex","Do not index images on this page.",{"_207":222,"_209":216,"_23":336,"_211":309,"_175":337,"_227":28},"noIndex","Do not show this page, media, or resource in search results.",{"_207":222,"_209":216,"_23":339,"_211":309,"_175":340,"_227":28},"noSnippet","Do not show a text snippet or video preview in the search results for this page.",{"_207":222,"_209":216,"_23":342,"_211":309,"_175":343,"_227":28},"noTranslate","Do not offer translation of this page in search results.",{"_207":222,"_209":216,"_23":345,"_211":230,"_175":346,"_227":28},"unavailableAfter","Do not show this page in search results after the specified date/time.","export interface RobotsOptions {\n /**\n * Set the maximum size of an image preview for this page in a search results Can be one of the following:\n *\n * - `none` - No image preview is to be shown.\n * - `standard` - A default image preview may be shown.\n * - `large` - A larger image preview, up to the width of the viewport, may be shown.\n *\n * If no value is specified a default image preview size is used.\n */\n maxImagePreview?: 'none' | 'standard' | 'large';\n /**\n * A number representing the maximum of amount characters to use as a textual snippet for a search result. This value\n * can also be set to one of the following special values:\n *\n * - 0 - No snippet is to be shown. Equivalent to nosnippet.\n * - 1 - The Search engine will choose the snippet length that it believes is most effective to help users discover\n * your content and direct users to your site\n * - -1 - No limit on the number of characters that can be shown in the snippet.\n */\n maxSnippet?: number;\n /**\n * The maximum number of seconds for videos on this page to show in search results. This value can also be set to one\n * of the following special values:\n *\n * - 0 - A static image may be used with the `maxImagePreview` setting.\n * - 1 - There is no limit to the size of the video preview.\n *\n * This applies to all forms of search results (at Google: web search, Google Images, Google Videos, Discover,\n * Assistant).\n */\n maxVideoPreview?: number;\n /**\n * Do not show a cached link in search results.\n */\n noArchive?: boolean;\n /**\n * Do not follow the links on this page.\n *\n * @see https://developers.google.com/search/docs/advanced/guidelines/qualify-outbound-links\n */\n noFollow?: boolean;\n /**\n * Do not index images on this page.\n */\n noImageIndex?: boolean;\n /**\n * Do not show this page, media, or resource in search results.\n */\n noIndex?: boolean;\n /**\n * Do not show a text snippet or video preview in the search results for this page.\n */\n noSnippet?: boolean;\n /**\n * Do not offer translation of this page in search results.\n */\n noTranslate?: boolean;\n /**\n * Do not show this page in search results after the specified date/time.\n */\n unavailableAfter?: string;\n}","version","2024-04","thumbnail","subCategory","id","getseometa","categoryLabel","Utilities","subCategoryLabel","unsupported","navData",{"_187":360,"_361":362,"_363":34},"Hydrogen","navItems",[],"collapsed","versionUrls",{},"current","apiName","latestVersion","2025-05","isInternal","actionData","errors"]