Localizing customer UI extensions

Localization is the process of adapting content to meet the language and cultural requirements of a specific country or region. Shopify localizes customer account UI extensions by resolving customer and shop locales against the extensions' translation data.

The following diagram shows customers in France and Canada that are interacting with a store in Germany. The customers receive localized experiences based on the translation data that's supplied by an app extension.

You supply translation data for your extension's strings in .json-formatted locale files, which are stored in the extension's locales folder.

The customer account UI extension queries the locale files for a match against locale data and translates the extension UI.

To choose a translation, Shopify evaluates locale data in the following order of precedence:

1. The customer locale. Example: de-DE.

2. The non-regional customer locale. Example: de.

3. The shop locale. Example: fr-FR.

4. The non-regional shop locale. Example: fr.

5. The extension's default locale.

Locale files are UTF-8-encoded JSON files that contain a set of translations for your UI extension's strings. You can create non-regional, regional, and default locales.

Translations consist of key/value pairs. You can supply singular and plural translations.

Use an IETF BCP 47 language tag:

Insert an ISO 3166-1 region code after the language tag:

Insert .default between the locale and the .json file extension:

The implementation of plural translation keys follows the language plural rules included in the Common Locale Data Repository. You can specify any pluralization key that Intl.PluralRules.select() supports and that's appropriate for the locale.

The following are additional details for localizing pluralized content:

• The call to translate() must have a single count option.

• Shopify uses count to determine a plural key for the given locale.

• The translation must define all possible plural keys for the given locale. For example:

• Merchants can't override or add translations for extensions.

• Complex pluralization, like for dynamic numeric ranges, isn't supported. For example, you can't localize a phrase that lists a numeric range of items left in stock. This is because the range will change as items are sold, and for some languages, the localizer would need to update the grammar as well.

• Translations can't contain HTML.

• Use our i18n functions to localize content. However, if you need to use Intl functions for more advanced formatting, only the following are supported:

  • Intl.NumberFormat
  • Intl.DateTimeFormat
  • Intl.PluralRules