Helpers

getLocale

API Reference für die serverseitige Methode getLocale

Überblick

Die Funktion getLocale ermittelt die aktuelle Locale des Nutzers während des serverseitigen Renderings. Die zurückgegebene Locale ist als Zeichenkette formatiert, z. B. 'en-US'.

getLocale ist eine serverseitige Methode und kann nur in serverseitigen Komponenten verwendet werden.

Für die clientseitige Verwendung siehe useLocale.

Referenzen

Rückgabewert

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


Fallback-Verhalten

Wenn eine nicht unterstützte locale angefordert wird, wird eine Standardwert-locale ausgewählt.

Wenn beispielsweise im Fall einer nicht unterstützten locale (1) die Nutzerin oder der Nutzer mehrere bevorzugte locales in den Browser-Einstellungen konfiguriert hat und (2) eine dieser locales von Ihrer Anwendung unterstützt wird, dann wird die locale auf die bestmögliche Sprache zurückfallen.

Wenn außerdem keine möglichen Standardwert-locales verfügbar sind, aber zwei locales dieselbe Sprache haben (z. B. en-US und en-GB), dann fällt die locale auf die unterstützte locale zurück, die dieselbe Sprache hat.

Wenn keine der 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

Ermitteln Sie die locale des Benutzers während des serverseitigen Renderings.

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

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

Hinweise

  • Die Funktion getLocale ist asynchron und muss mit await aufgerufen 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 Format der Locale-Strings.

Nächste Schritte

  • Erfahren Sie, wie Sie unterstützte locales mit withGTConfig() konfigurieren.

Wie ist dieser Leitfaden?

getLocale