getLocale()

Übersicht

Die Funktion getLocale() ruft das aktuelle Gebietsschema des Benutzers während des serverseitigen Renderings ab. Das zurückgegebene Gebietsschema ist als Zeichenkette formatiert, z. B. 'en-US'.

Für die clientseitige Nutzung siehe useLocale().

Referenz

Rückgabewert

Ein Promise, das mit einem String aufgelöst wird, der die aktuelle Spracheinstellung des Benutzers darstellt, z. B. 'en-US'.

Fallback-Verhalten

Wenn eine nicht unterstützte Locale angefordert wird, wird eine Fallback-Locale ausgewählt.

Wenn zum Beispiel eine nicht unterstützte Locale angefordert wird, und (1) der Benutzer mehrere bevorzugte Locales in seinen Browsereinstellungen konfiguriert hat, und (2) eine dieser Locales von Ihrer Anwendung unterstützt wird, dann wird auf die am besten passende Sprache zurückgegriffen.

Falls keine möglichen Fallback-Locales verfügbar sind, aber zwei Locales dieselbe Sprache teilen (z. B. en-US und en-GB), dann wird auf die unterstützte Locale zurückgegriffen, die dieselbe Sprache verwendet.

Wenn keine dieser Bedingungen erfüllt werden kann, wird die Standard-Locale verwendet.

Siehe die Dokumentation zu gt.config.json für Informationen zur Konfiguration unterstützter Locales.

Beispiele

Grundlegende Verwendung

Rufen Sie die Sprache des Benutzers während des serverseitigen Renderings ab.

import { getLocale } from 'gt-next/server';

export default async function GetUserLocale() {
    const locale = await getLocale(); 
    return <p>User locale: {locale}</p>;
}

Hinweise

• Die Funktion getLocale() ist asynchron und muss abgewartet werden, um die Locale abzurufen.
• Sie ist speziell für die serverseitige Verwendung konzipiert. Siehe useLocale() für clientseitige Komponenten.
• Die zurückgegebene Locale entspricht dem Locale-Strings Format.

Nächste Schritte

• Erfahren Sie, wie Sie unterstützte Sprachversionen mit withGTConfig() konfigurieren.
• Informationen zur Verwaltung von Fallback-Sprachversionen finden Sie unter getDefaultLocale().