Utility FunctionsLocales

getLocaleEmoji

Справка по API для отдельной функции getLocaleEmoji

Обзор

Отдельная функция getLocaleEmoji возвращает эмодзи‑флаг или символ для кода локали без необходимости создавать экземпляр класса GT. Она выдаёт подходящие флаг‑эмодзи для стран и территорий на основе региона локали и поддерживает пользовательские сопоставления эмодзи.

import { getLocaleEmoji } from 'generaltranslation';

const emoji = getLocaleEmoji('fr-CA');
console.log(emoji); // "🇨🇦" (флаг Канады)

const usEmoji = getLocaleEmoji('en-US');
console.log(usEmoji); // "🇺🇸" (флаг США)

Справочные материалы

Параметры

Prop

Type

Описание параметров

ПараметрОписание
localeКод локали BCP‑47, для которого нужно получить эмодзи
customMappingНеобязательное пользовательское сопоставление кодов локалей и переопределений эмодзи

Возвращает

string — эмодзи флага или символ, обозначающий локаль:

  • Эмодзи флага страны/региона для локалей с указанием региона (например, 🇺🇸, 🇫🇷, 🇯🇵)
  • Пользовательское эмодзи, если задано в отображении
  • Эмодзи флага по умолчанию (🏳️) для неопознанных локалей

Примеры

Базовое получение эмодзи

import { getLocaleEmoji } from 'generaltranslation';

// Типичные флаги стран
console.log(getLocaleEmoji('en-US')); // "🇺🇸"
console.log(getLocaleEmoji('fr-FR')); // "🇫🇷"
console.log(getLocaleEmoji('de-DE')); // "🇩🇪"
console.log(getLocaleEmoji('ja-JP')); // "🇯🇵"
console.log(getLocaleEmoji('zh-CN')); // "🇨🇳"

// Регионы с несколькими официальными языками
console.log(getLocaleEmoji('en-CA')); // "🇨🇦"
console.log(getLocaleEmoji('fr-CA')); // "🇨🇦"
console.log(getLocaleEmoji('de-CH')); // "🇨🇭"
console.log(getLocaleEmoji('fr-CH')); // "🇨🇭"

Примечания

  • Возвращает эмодзи флагов на основе пар региональных индикаторов Unicode (Regional Indicator Symbols)
  • Пользовательские сопоставления эмодзи имеют приоритет над выбором по региону
  • Поддерживает все двухбуквенные региональные коды ISO 3166-1 alpha-2 для полного охвата

Дальнейшие шаги

  • Используйте метод класса GT getLocaleEmoji
  • Получайте свойства локали с помощью getLocaleProperties
  • Получайте названия локалей с помощью getLocaleName
  • Проверяйте корректность локалей с помощью isValidLocale

Насколько полезно это руководство?

getLocaleEmoji