Utility FunctionsLocales

getLocaleName

Référence de l’API pour la fonction indépendante getLocaleName

Présentation

La fonction autonome getLocaleName récupère le nom d’affichage d’un code de locale sans nécessiter d’instance de la GT class. Elle utilise l’API Intl.DisplayNames pour fournir des noms de locale localisés pour tout code de locale BCP-47 valide.

import { getLocaleName } from 'generaltranslation';

const name = getLocaleName('fr-CA', 'fr');
console.log(name); // « Français (Canada) »

Référence

Paramètres

Prop

Type

Description des paramètres

ParamètreDescription
localecode de locale BCP‑47 pour lequel récupérer le nom d’affichage
defaultLocaleLocale à utiliser pour localiser le nom d’affichage (par défaut : 'en')
customMappingMappage personnalisé optionnel pour les codes de locale et les noms

Renvoie

string - Le nom d’affichage localisé du locale.


Comportement

Résolution de la langue d’affichage

La fonction localise les noms selon la priorité suivante :

  1. Paramètre defaultLocale (s’il est défini)
  2. Locale par défaut de la bibliothèque (« en »)

Intégration de correspondances personnalisées

  • Les correspondances personnalisées sont vérifiées en priorité pour les codes de locale et les noms
  • Prend en charge la résolution d’alias et les noms d’affichage personnalisés
  • Fait appel à Intl.DisplayNames (standard) pour les codes non mappés

Stratégie de résolution des noms

  1. Mappage de noms personnalisé (priorité la plus élevée)
  2. Intl.DisplayNames dans la locale par défaut
  3. Intl.DisplayNames dans la locale par défaut de la bibliothèque ('en')
  4. Le code de locale lui‑même (secours)

Exemples

import { getLocaleName } from 'generaltranslation';

// Noms d’affichage en anglais
console.log(getLocaleName('es', 'en')); // « Spanish (Spain) »
console.log(getLocaleName('ja', 'en')); // « Japanese (Japan) »
console.log(getLocaleName('zh', 'en')); // « Chinese (China) »

Création d’options de locale

import { getLocaleName, getLocaleEmoji } from 'generaltranslation';

function buildLocaleOptions(
  supportedLocales: string[],
  displayLocale: string = 'en'
) {
  return supportedLocales.map(locale => ({
    value: locale,
    label: getLocaleName(locale, displayLocale),
    emoji: getLocaleEmoji(locale)
  }));
}

const options = buildLocaleOptions([
  'en',
  'es',
  'fr',
  'de',
  'ja'
], 'en');

console.log(options);
// [
//   { value: 'en', label: 'anglais (États‑Unis)', emoji: '🇺🇸' },
//   { value: 'es', label: 'espagnol (Espagne)', emoji: '🇪🇸' },
//   ...
// ]

Notes

  • Les mappages personnalisés ont priorité sur Intl.DisplayNames (standard)
  • Retourne le code de locale lui‑même si aucun nom d’affichage ne peut être déterminé
  • Le paramètre de locale d’affichage détermine la langue du nom retourné

Prochaines étapes

Que pensez-vous de ce guide ?

getLocaleName