Helpers

useLocale

API Reference für den useLocale Hook

Übersicht

Der useLocale-Hook ruft die aktuelle Locale des Nutzers aus dem <GTProvider>-Kontext ab. Die zurückgegebene Locale ist als Zeichenkette formatiert, z. B. „en-US“.

useLocale ist ein clientseitiger Hook und kann nur in clientseitigen Komponenten verwendet werden. Stelle sicher, dass deine App von einem <GTProvider> umschlossen wird.

Für serverseitiges Locale-Management siehe getLocale.

Referenzen

Rückgabewert

Eine Zeichenfolge, die die aktuelle locale des Benutzers angibt, z. B. en-US.


Fallback-Verhalten

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

Beispielsweise gilt im Fall einer nicht unterstützten locale: Wenn (1) der Nutzer mehrere bevorzugte locales in seinen Browsereinstellungen konfiguriert hat und (2) eine dieser locales von Ihrer Anwendung unterstützt wird, dann wird die locale auf die am besten passende Sprache gesetzt.

Zusätzlich gilt: Wenn keine möglichen Fallback-locales verfügbar sind, aber zwei locales dieselbe Sprache haben (z. B. en-US und en-GB), dann wird die locale auf die unterstützte locale gesetzt, die dieselbe Sprache hat.

Wenn keine der Bedingungen erfüllt ist, 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 aktuelle locale ab und zeigen Sie sie in Ihrer Komponente an.

CurrentLocale.jsx
"use client";
import { useLocale } from 'gt-next';

export default function CurrentLocale() {
    const locale = useLocale(); 
    return <p>Aktuelle Locale: {locale}</p>;
}

Hinweise

  • Der useLocale-Hook setzt auf den <GTProvider>, um auf den Kontext zuzugreifen. Stellen Sie sicher, dass Ihre App auf Root-Ebene mit einem Provider versehen ist.
  • useLocale ist ausschließlich clientseitig.
  • Erfahren Sie mehr über Locale-Strings hier.

Nächste Schritte

  • Erfahren Sie, wie Sie unterstützte locales in Ihrer Anwendung mit der Datei gt.config.json verwalten und festlegen.

Wie ist diese Anleitung?