getLocaleName
Référence de l’API pour la fonction autonome getLocaleName
Vue d’ensemble
La fonction autonome getLocaleName renvoie le nom d’affichage d’un code de locale sans nécessiter d’instance de GT.
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', 'en');
console.log(name); // "français (Canada)"Références
Paramètres
Prop
Type
Description des paramètres
| Paramètre | Description |
|---|---|
locale | code de locale BCP-47 pour lequel obtenir le nom d’affichage |
defaultLocale | Locale à utiliser pour la localisation du nom d’affichage (par défaut « en ») |
customMapping | Mappage personnalisé optionnel pour les codes et noms de locale |
Renvoie
string - Le nom d’affichage localisé de la locale.
Comportement
Résolution de la langue d’affichage
La fonction localise les noms selon la priorité suivante :
- Paramètre
defaultLocale(si fourni) - Locale par défaut de la bibliothèque (« en »)
Intégration des correspondances personnalisées
- Les correspondances personnalisées sont vérifiées en premier pour les codes de locale et les noms
- Prend en charge la résolution des alias et les noms d’affichage personnalisés
- Bascule sur Intl.DisplayNames standard pour les codes non associés
Stratégie de résolution des noms
- Nom de correspondance personnalisé (priorité la plus élevée)
- Intl.DisplayNames dans la locale par défaut
- Intl.DisplayNames dans la locale par défaut de la bibliothèque (« en »)
- 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éer des 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 correspondances personnalisées priment sur Intl.DisplayNames standard
- Renvoie 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 renvoyé
Prochaines étapes
- Récupérez l’emoji du locale avec
getLocaleEmoji - Utilisez la méthode de la classe GT pour des opérations stateful
getLocaleName - En savoir plus sur le type
CustomMapping
Comment trouvez-vous ce guide ?