Документация: функция getLocaleName в intlayer

Описание

Функция getLocaleName возвращает локализованное название заданной локали (targetLocale) на языке отображения (displayLocale). Если targetLocale не указан, функция возвращает название displayLocale на его собственном языке.

Параметры

• displayLocale: Locales

  • Описание: Локаль, на языке которой будет отображаться название целевой локали.
  • Тип: Enum или строка, представляющая допустимые локали.

• targetLocale?: Locales

  • Описание: Локаль, название которой нужно локализовать.
  • Тип: Необязательный параметр. Enum или строка, представляющая допустимые локали.

Возвращаемое значение

• Тип: string
• Описание: Локализованное название targetLocale на языке displayLocale, или собственное название displayLocale, если targetLocale не указан. Если перевод не найден, возвращается "Unknown locale".

Пример использования

import { Locales, getLocaleName } from "intlayer";

getLocaleName(Locales.ENGLISH); // Вывод: "English"
getLocaleName(Locales.ENGLISH, Locales.FRENCH); // Вывод: "Anglais"
getLocaleName(Locales.ENGLISH, Locales.ESPANOL); // Вывод: "Inglés"
getLocaleName(Locales.ENGLISH, Locales.ENGLISH); // Вывод: "English"

getLocaleName(Locales.FRENCH); // Вывод: "Français"
getLocaleName(Locales.FRENCH, Locales.FRENCH); // Вывод: "Français"
getLocaleName(Locales.FRENCH, Locales.ESPANOL); // Вывод: "Francés"
getLocaleName(Locales.FRENCH, Locales.ENGLISH); // Вывод: "French"

getLocaleName(Locales.CHINESE); // Вывод: "中文"
getLocaleName(Locales.CHINESE, Locales.FRENCH); // Вывод: "Chinois"
getLocaleName(Locales.CHINESE, Locales.ESPANOL); // Вывод: "Chino"
getLocaleName(Locales.CHINESE, Locales.ENGLISH); // Вывод: "Chinese"

getLocaleName("unknown-locale"); // Вывод: "Unknown locale"

Крайние случаи

• Если targetLocale не указан:
  • Функция по умолчанию возвращает собственное имя displayLocale.
• Отсутствие переводов:
  • Если localeNameTranslations не содержит записи для targetLocale или конкретного displayLocale, функция возвращает ownLocalesName или "Unknown locale".

Polyfills для React Native и старых сред

Функция getLocaleName зависит от API Intl.DisplayNames, которая недоступна в React Native или старых средах JavaScript. Если вы используете getLocaleName в этих средах, вам нужно добавить polyfills.

Импортируйте polyfills в начале вашего приложения, желательно в файле точки входа (например, index.js, App.tsx или main.tsx):

import "intl";import "@formatjs/intl-locale/polyfill";import "@formatjs/intl-displaynames/polyfill";

Для получения дополнительной информации см. документацию по polyfills FormatJS.