Utility FunctionsLocales

getLocaleProperties

Riferimento API per la funzione standalone getLocaleProperties

Panoramica

La funzione autonoma getLocaleProperties recupera le proprietà di un codice locale senza richiedere un'istanza della classe GT. Fornisce informazioni dettagliate, incluse le etichette visualizzate, i codici di regione, i dati sul sistema di scrittura e le bandiere emoji, in un oggetto LocaleProperties completo.

import { getLocaleProperties } from 'generaltranslation';

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

Riferimenti

Parametri

Prop

Type

Descrizione dei parametri

ParametroDescrizione
localeCodice locale BCP-47 per cui recuperare le proprietà
defaultLocaleLocale da usare per localizzare i nomi visualizzati (valore predefinito: "en")
customMappingMappatura personalizzata facoltativa per codici locale e relative proprietà

Restituisce

LocaleProperties - Un oggetto completo che contiene tutte le informazioni sulla locale:

  • code: Codice locale standardizzato
  • name: Nome visualizzato nella locale predefinita
  • nativeName: Nome visualizzato nella locale stessa
  • languageCode, languageName, nativeLanguageName: Informazioni sulla lingua
  • regionCode, regionName, nativeRegionName: Informazioni sulla regione
  • scriptCode, scriptName, nativeScriptName: Informazioni sul sistema di scrittura
  • maximizedCode, minimizedCode: Forme canoniche
  • nameWithRegionCode, nativeNameWithRegionCode: Formati di visualizzazione combinati
  • emoji: Bandiera o emoji rappresentativa

Comportamento

Integrazione con mapping personalizzati

  • I mapping personalizzati vengono controllati per primi per tutte le proprietà
  • Supporta la risoluzione degli alias e le override delle proprietà
  • Usa le API Intl standard per i codici non mappati
  • Risoluzione canonica delle locale per le locale alias

Esempi

import { getLocaleProperties } from 'generaltranslation';

// Nomi visualizzati in inglese
const enProps = getLocaleProperties('es-MX', 'en');
console.log(enProps.name); // "Spanish (Mexico)"
console.log(enProps.languageName); // "Spanish"
console.log(enProps.regionName); // "Mexico"
console.log(enProps.emoji); // "🇲🇽"

// Nomi visualizzati in francese
const frProps = getLocaleProperties('es-MX', 'fr');
console.log(frProps.name); // "espagnol (Mexique)"
console.log(frProps.languageName); // "espagnol"
console.log(frProps.regionName); // "Mexique"

// I nomi nativi sono sempre nella lingua di destinazione
console.log(enProps.nativeName); // "español (México)"
console.log(frProps.nativeName); // "español (México)"

Note

  • La funzione fornisce i dati della locale senza istanziare la classe GT
  • Le proprietà di mapping personalizzate hanno la precedenza sulle API standard di Intl
  • L’interfaccia completa LocaleProperties viene sempre restituita
  • I nomi nativi sono sempre calcolati nella locale di destinazione

Prossimi passaggi

Come valuti questa guida?

getLocaleProperties