Helpers

useLocale

API Reference für den Hook useLocale

Übersicht

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

Stellen Sie sicher, dass Ihre App von einem <GTProvider> umschlossen wird.

Referenzen

Rückgabewert

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


Verhalten bei Standardwerten

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

Wenn beispielsweise im Fall einer nicht unterstützten locale (1) der Benutzer in seinen Browsereinstellungen mehrere bevorzugte locales konfiguriert hat und (2) eine dieser locales von Ihrer Anwendung unterstützt wird, dann wird auf die bestpassende Sprache zurückgegriffen.

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

Wenn keine der Bedingungen erfüllt ist, wird die Standard-locale verwendet.

Siehe <GTProvider> 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
import { useLocale } from 'gt-react';

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. Stellen Sie sicher, dass Ihre App auf Root-Ebene mit einem Provider versehen/umwickelt ist.
  • Weitere Informationen zu Locale-Strings finden Sie hier.

Nächste Schritte

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

Wie ist dieser Leitfaden?

useLocale