Documentação: Função getLocaleName em intlayer

Descrição

A função getLocaleName retorna o nome localizado de um determinado locale (targetLocale) no locale de exibição (displayLocale). Se nenhum targetLocale for fornecido, ela retorna o nome do displayLocale em seu próprio idioma.

Parâmetros

• displayLocale: Locales

  • Descrição: O locale no qual o nome do locale alvo será exibido.
  • Tipo: Enum ou string representando locales válidos.

• targetLocale?: Locales

  • Descrição: O locale cujo nome deve ser localizado.
  • Tipo: Opcional. Enum ou string representando locales válidos.

Retorno

• Tipo: string
• Descrição: O nome localizado do targetLocale no displayLocale, ou o próprio nome do displayLocale se targetLocale não for fornecido. Se nenhuma tradução for encontrada, retorna "Unknown locale".

Exemplo de Uso

import { Locales, getLocaleName } from "intlayer";

getLocaleName(Locales.ENGLISH); // Saída: "English"
getLocaleName(Locales.ENGLISH, Locales.FRENCH); // Saída: "Anglais"
getLocaleName(Locales.ENGLISH, Locales.ESPANOL); // Saída: "Inglés"
getLocaleName(Locales.ENGLISH, Locales.ENGLISH); // Saída: "English"

getLocaleName(Locales.FRENCH); // Saída: "Français"
getLocaleName(Locales.FRENCH, Locales.FRENCH); // Saída: "Français"
getLocaleName(Locales.FRENCH, Locales.ESPANOL); // Saída: "Francés"
getLocaleName(Locales.FRENCH, Locales.ENGLISH); // Saída: "French"

getLocaleName(Locales.CHINESE); // Saída: "中文"
getLocaleName(Locales.CHINESE, Locales.FRENCH); // Saída: "Chinois"
getLocaleName(Locales.CHINESE, Locales.ESPANOL); // Saída: "Chino"
getLocaleName(Locales.CHINESE, Locales.ENGLISH); // Saída: "Chinese"

getLocaleName("unknown-locale"); // Saída: "Unknown locale"

Casos Especiais

• Nenhum targetLocale fornecido:
  • A função retorna por padrão o próprio nome do displayLocale.
• Traduções ausentes:
  • Se localeNameTranslations não contiver uma entrada para o targetLocale ou para o displayLocale específico, a função recorre ao ownLocalesName ou retorna "Unknown locale".

Polyfills para React Native e ambientes mais antigos

A função getLocaleName depende da API Intl.DisplayNames, que não está disponível no React Native ou em ambientes JavaScript mais antigos. Se você estiver usando getLocaleName nesses ambientes, precisa adicionar polyfills.

Importe os polyfills no início da sua aplicação, idealmente no seu arquivo de entrada (por exemplo, index.js, App.tsx ou main.tsx):

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

Para mais detalhes, consulte a documentação de polyfills do FormatJS.