getRegionProperties
Справочник по API метода GT getRegionProperties
Обзор
Метод getRegionProperties получает подробные сведения о коде региона, включая его локализованное название и соответствующий эмодзи-флаг.
Это удобный способ получить регион‑специфичную информацию для отображения при создании интернационализированных пользовательских интерфейсов.
const gt = new GT({
sourceLocale: 'en-US',
targetLocale: 'fr-FR'
});
// Получить свойства региона
const usProps = gt.getRegionProperties('US');
console.log(usProps);
// { code: 'US', name: 'Соединённые Штаты', emoji: '🇺🇸' }
const frProps = gt.getRegionProperties('FR');
console.log(frProps);
// { code: 'FR', name: 'Франция', emoji: '🇫🇷' }
// Автоопределение по текущей локали
const currentRegion = gt.getRegionProperties(); // Использует регион из targetLocale
console.log(currentRegion);
// { code: 'FR', name: 'Франция', emoji: '🇫🇷' }Справка
Параметры
Prop
Type
Описание параметров
| Параметр | Описание |
|---|---|
region | Код региона по ISO 3166-1 alpha-2 или UN M.49. Если не указан, используется регион из целевой локали данного инстанса |
customMapping | Необязательное пользовательское соответствие регионов для переопределения стандартных названий и эмодзи регионов |
Возвращает
{ code: string; name: string; emoji: string } — объект, содержащий:
code: исходный код регионаname: локализованное название региона на языке целевой локалиemoji: соответствующий флаг-эмодзи или символ
Примеры
Основная информация о регионе
const gt = new GT({
sourceLocale: 'en-US',
targetLocale: 'en-US'
});
// Распространённые коды регионов
console.log(gt.getRegionProperties('US')); // { code: 'US', name: 'Соединённые Штаты', emoji: '🇺🇸' }
console.log(gt.getRegionProperties('GB')); // { code: 'GB', name: 'Соединённое Королевство', emoji: '🇬🇧' }
console.log(gt.getRegionProperties('DE')); // { code: 'DE', name: 'Германия', emoji: '🇩🇪' }
console.log(gt.getRegionProperties('JP')); // { code: 'JP', name: 'Япония', emoji: '🇯🇵' }Примечания
- Использует API
Intl.DisplayNamesдля локализованных названий регионов - Поддерживает коды регионов ISO 3166‑1 alpha‑2 и UN M.49
- Пользовательские соответствия переопределяют стандартные названия и эмодзи
- Автоматически определяет регион по целевой локали, если параметр не указан
- При невозможности получить отображаемое имя используется код региона как название
Следующие шаги
- Получите все свойства локали с помощью
getLocaleProperties - Получите эмодзи локали с помощью
getLocaleEmoji
Насколько полезно это руководство?