useLocale()
API-Referenz für den useLocale-Hook
Übersicht
Der useLocale
Hook ruft die aktuelle Spracheinstellung des Benutzers aus dem <GTProvider>
-Kontext ab.
Die zurückgegebene Spracheinstellung ist als Zeichenkette formatiert, z. B. 'en-US'
.
Stelle sicher, dass deine App in einen <GTProvider>
eingebettet ist.
Referenz
Rückgabewert
Ein String, der die aktuelle Spracheinstellung des Benutzers darstellt, z. B. 'en-US'
.
Fallback-Verhalten
Wenn eine nicht unterstützte Locale angefordert wird, wird eine Ersatz-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 Ersatz-Locales verfügbar sind,
aber zwei Locales die gleiche Sprache teilen (z. B. en-US
und en-GB
),
dann wird auf die unterstützte Locale zurückgegriffen, die die gleiche Sprache verwendet.
Wenn keine dieser Bedingungen erfüllt werden kann, wird die Standard-Locale verwendet.
Siehe <GTProvider>
für Informationen zur Konfiguration unterstützter Locales.
Beispiele
Grundlegende Verwendung
Rufen Sie das aktuelle Gebietsschema ab und zeigen Sie es in Ihrer Komponente an.
import { useLocale } from 'gt-react';
export default function CurrentLocale() {
const locale = useLocale();
return <p>Current locale: {locale}</p>;
}
Hinweise
- Der
useLocale()
Hook basiert auf dem<GTProvider>
, um auf den Kontext zuzugreifen. Stellen Sie sicher, dass Ihre App auf der obersten Ebene mit einem Provider umschlossen ist. - Erfahren Sie mehr über Locale-Strings hier.
Nächste Schritte
- Erfahren Sie, wie Sie unterstützte Sprachversionen in Ihrer Anwendung mit der Datei
gt.config.json
verwalten und festlegen können. - Um auf die Fallback-Sprache zuzugreifen, siehe
useDefaultLocale()
.
Wie ist dieser Leitfaden?