Helpers

useLocale

API Reference für den Hook useLocale

Überblick

Der Hook useLocale ruft die aktuelle Locale des Nutzers aus dem Kontext von <GTProvider> 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. Stellen Sie sicher, dass Ihre App von einem <GTProvider> umschlossen wird.

Für serverseitiges Locale-Management siehe getLocale.

Referenzen

Rückgabe

Eine Zeichenfolge, die die aktuelle Locale des Nutzers darstellt, z. B. 'en-US'.


Fallback-Verhalten

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

Wenn beispielsweise eine locale nicht unterstützt wird, der Benutzer (1) in seinen Browser-Einstellungen mehrere bevorzugte locales konfiguriert hat und (2) eine dieser locales von Ihrer Anwendung unterstützt wird, dann wechselt die locale auf die bestmögliche Sprache.

Zusätzlich, wenn keine geeigneten Fallback-locales verfügbar sind, aber zwei locales dieselbe Sprache haben (z. B. en-US und en-GB), dann wechselt die locale auf die unterstützte locale mit derselben Sprache.

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

Ermitteln Sie die aktuelle locale 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 Sprache: {locale}</p>;
}

Hinweise

  • Der Hook useLocale greift über den <GTProvider> auf den Kontext zu. Stelle sicher, dass deine App auf Root-Ebene von einem Provider umschlossen wird.
  • useLocale ist ausschließlich clientseitig.
  • Mehr zu Locale-Strings erfährst du hier.

Nächste Schritte

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

Wie ist dieser Leitfaden?

useLocale