useLocale()
API-Referenz für den useLocale-Hook
Überblick
Der useLocale
Hook ruft die aktuelle Locale des Benutzers 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.
Stellen Sie sicher, dass Ihre App in einen <GTProvider>
eingebettet ist.
Für die serverseitige Locale-Verwaltung siehe getLocale()
.
Referenz
Rückgaben
Ein String, der die aktuelle Gebietsschema des Benutzers darstellt, z.B. 'en-US'
.
Fallback-Verhalten
Wenn eine nicht unterstützte Locale angefordert wird, wird eine Fallback-Locale ausgewählt.
Zum Beispiel, im Falle einer nicht unterstützten Locale, wenn (1) der Benutzer 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 beste Sprache zurückfallen.
Zusätzlich, wenn keine möglichen Fallback-Locales verfügbar sind,
aber zwei Locales die gleiche Sprache teilen (z.B. en-US
und en-GB
),
dann wird die Locale auf die unterstützte Locale zurückfallen, die die gleiche Sprache teilt.
Wenn keine der Bedingungen erfüllt werden kann, wird die Standard-Locale verwendet.
Siehe den Locale-Management-Leitfaden()
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.
Notizen
- 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. useLocale()
ist nur clientseitig.- Erfahren Sie mehr über Locale-Strings hier.
Nächste Schritte
- Erfahren Sie, wie Sie unterstützte Gebietsschemas in Ihrer Anwendung verwalten und angeben können mit Gebietsschema-Verwaltung.
- Um auf die Fallback-Sprache zuzugreifen, siehe
useDefaultLocale()
.