GT ClassMethodsLocales

getLocaleProperties

Référence de l’API pour la méthode getLocaleProperties de GT

Vue d’ensemble

La méthode getLocaleProperties récupère l’ensemble des propriétés pour un code de locale, fournissant des informations détaillées, notamment les noms d’affichage, les codes de région, les données d’écriture (script) et les drapeaux emoji. Elle renvoie un objet LocaleProperties complet contenant toutes les données nécessaires pour créer des interfaces utilisateur internationalisées riches.

const gt = new GT({
  sourceLocale: 'en',
  targetLocale: 'es'
});

const props = gt.getLocaleProperties('fr-CA');
console.log(props.name); // "français (Canada)"
console.log(props.nativeName); // "français (Canada)"
console.log(props.emoji); // "🇨🇦"

Références

Paramètres

Prop

Type

Description des paramètres

ParamètreDescription
localeCode de locale BCP‑47 dont récupérer les propriétés. S’il n’est pas fourni, utilise le targetLocale de l’instance

Renvoie

LocaleProperties - Un objet complet contenant toutes les informations de locale :

  • code : code de locale standardisé
  • name : nom d’affichage dans la locale source
  • nativeName : nom d’affichage dans la locale elle‑même
  • languageCode, languageName, nativeLanguageName : informations sur la langue
  • regionCode, regionName, nativeRegionName : informations sur la région
  • scriptCode, scriptName, nativeScriptName : informations sur l’écriture
  • maximizedCode, minimizedCode : formes canoniques
  • nameWithRegionCode, nativeNameWithRegionCode : formats d’affichage combinés
  • emoji : drapeau ou emoji représentatif

Exceptions

  • Error - Si aucune locale n’est fournie et qu’aucune targetLocale n’est configurée pour l’instance

Exemples

Utilisation de base

const gt = new GT({
  sourceLocale: 'en',
  targetLocale: 'fr'
});

// Obtenir les propriétés pour la localeCible
const props = gt.getLocaleProperties();
console.log(props.name); // "French (France)"
console.log(props.nativeName); // "français (France)"
console.log(props.languageCode); // "fr"
console.log(props.regionCode); // "FR"
console.log(props.emoji); // "🇫🇷"

// Obtenir les propriétés pour d'autres locales
const germanProps = gt.getLocaleProperties('de-AT');
console.log(germanProps.name); // "Austrian German"
console.log(germanProps.nativeName); // "Österreichisches Deutsch"
console.log(germanProps.regionName); // "Austria"
console.log(germanProps.nativeRegionName); // "Österreich"

Notes

  • Tous les noms d’affichage respectent le paramètre sourceLocale de l’instance
  • Les propriétés de mapping personnalisées ont priorité sur les API Intl standard

Prochaines étapes

Que pensez-vous de ce guide ?

getLocaleProperties