useLocalization
The useLocalization hook returns the locale, country, and language of the current page. It can be used within server or client components and it must be a descendent of a ShopifyProvider component.
Example code
Anchor link to section titled "Example code"
Return value
Anchor link to section titled "Return value"This hook returns an object with the following properties:
| Property | Description |
|---|---|
country |
An object with the country's isoCode. |
language |
An object with the language's isoCode. |
locale |
The locale string based on country and language. See how we determine locale. |
Determine the locale for i18n
Anchor link to section titled "Determine the locale for i18n"We use the assigned language and countryCode in the ShopifyProvider to determine the locale.
If the language doesn't contain language tag extensions, then we try to merge language and countryCode. For example, if language is EN (English) and countryCode is US (United States), then locale is EN-US.
Alternatively if the language contains a language tag extension, then we use it directly as locale. For example, if
language is PT_BR (Brazilian Portuguese) and countryCode is US (United States), then locale is PT_BR