TLocale¶

The TLocale object represents a locale available in the shop with its configuration and metadata.

Properties¶

locale¶

Type: TLocaleIsoUnderscore

The locale code in ISO format with underscore separator (e.g., "en_US", "pl_PL").

name¶

Type: string

The display name of the locale in its native language.

region¶

Type: string

The region or country name associated with the locale.

url¶

Type: string

The URL path or identifier for the locale in the shop.

alternateUrl¶

Type: string | null

The URL of the current page's equivalent (rel="alternate" hreflang) version in this locale, or null if no such alternate exists for the current page (e.g. the resource isn't available/translated in this locale).

currencyCode¶

Type: TCurrencyIsoCode

The default currency code for this locale in ISO format.

localized¶

Type: { name: string; region: string }

The locale's own name and region, localized into that locale's language (as opposed to name/region, which are localized into the current page's language).

Example¶

const locale: TLocale = {
    locale: 'pl_PL',
    name: 'Polski',
    region: 'Poland',
    url: '/pl/',
    alternateUrl: 'https://example.com/pl/p/Samsung-WB550/56',
    currencyCode: 'PLN',
    localized: {
        name: 'Polski',
        region: 'Polska'
    }
};