Utility FunctionsLocales

getLocaleName

API Reference für die eigenständige Funktion getLocaleName

Übersicht

Die eigenständige Funktion getLocaleName ruft den Anzeigenamen eines Locale-Codes ab, ohne eine Instanz der GT-Klasse zu benötigen. Sie verwendet die API Intl.DisplayNames, um lokalisierte Locale-Namen für jeden gültigen BCP‑47 Locale-Code bereitzustellen.

import { getLocaleName } from 'generaltranslation';

const name = getLocaleName('fr-CA', 'en');
console.log(name); // „Französisch (Kanada)“

Referenzen

Parameter

Prop

Type

Parameterbeschreibung

ParameterBeschreibung
localeBCP‑47-Locale-Code, für den der Anzeigename ermittelt wird
defaultLocaleLocale zur Lokalisierung des Anzeigenamens (Standard: 'en')
customMappingOptionale benutzerdefinierte Zuordnung für Locale-Codes und -Namen

Rückgabewert

string - Der lokalisierte Anzeigename der locale.


Verhalten

Ermittlung der Anzeigesprache

Die Funktion lokalisiert Namen in dieser Reihenfolge:

  1. defaultLocale-Parameter (falls angegeben)
  2. Standard-Locale der Bibliothek („en“)

Integration benutzerdefinierter Zuordnungen

  • Benutzerdefinierte Zuordnungen werden zuerst geprüft – sowohl für locale codes als auch für names
  • Unterstützt Aliasauflösung und benutzerdefinierte Anzeigenamen
  • Fällt für nicht zugeordnete Codes auf das Standard‑Intl.DisplayNames zurück

Strategie zur Namensauflösung

  1. Benutzerdefinierter Mappingname (höchste Priorität)
  2. Intl.DisplayNames in der Standard‑Locale
  3. Intl.DisplayNames in der Bibliotheksstandard‑Locale ('en')
  4. Locale-Code selbst (Standardwert)

Beispiele

import { getLocaleName } from 'generaltranslation';

// Englische Anzeigenamen
console.log(getLocaleName('es', 'en')); // "Spanisch (Spanien)"
console.log(getLocaleName('ja', 'en')); // "Japanisch (Japan)"
console.log(getLocaleName('zh', 'en')); // "Chinesisch (China)"

Locale-Options erstellen

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: 'Englisch (USA)', emoji: '🇺🇸' },
//   { value: 'es', label: 'Spanisch (Spanien)', emoji: '🇪🇸' },
//   ...
// ]

Hinweise

  • Benutzerdefinierte Zuordnungen haben Vorrang vor Intl.DisplayNames
  • Gibt den locale code selbst zurück, wenn kein Anzeigename ermittelt werden kann
  • Der Anzeige-locale-Parameter bestimmt die Sprache des zurückgegebenen Namens

Nächste Schritte

Wie ist dieser Leitfaden?

getLocaleName