Helpers

useLocale

Référence de l’API du hook useLocale

Vue d’ensemble

Le hook useLocale récupère la locale actuelle de l’utilisateur depuis le contexte <GTProvider>. La locale renvoyée est une chaîne de caractères, par exemple 'en-US'.

useLocale est un hook exécuté côté client et ne peut être utilisé que dans des composants côté client. Assurez-vous que votre application est encapsulée dans un <GTProvider>.

Pour la gestion de la locale côté serveur, voir getLocale.

Références

Renvoie

Une chaîne qui représente le locale actuel de l’utilisateur, par exemple : 'en-US'.


Comportement de secours

Lorsqu’une locale non prise en charge est demandée, une locale de secours est sélectionnée.

Par exemple, si une locale n’est pas prise en charge, et que (1) l’utilisateur a défini plusieurs locales préférées dans les paramètres de son navigateur, et que (2) l’une de ces locales est prise en charge par votre application, alors la locale basculera vers la meilleure langue.

De plus, si aucune locale de secours n’est disponible, mais que deux locales partagent la même langue (p. ex. en-US et en-GB), alors la locale basculera vers la locale prise en charge qui partage la même langue.

Si aucune de ces conditions n’est remplie, la locale par défaut sera utilisée.

Voir la documentation de gt.config.json pour la configuration des locales prises en charge.


Exemples

Utilisation de base

Récupérez le locale actuel et affichez-le dans votre composant.

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

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

Remarques

  • Le hook useLocale s’appuie sur <GTProvider> pour accéder au contexte. Assurez-vous que votre application est enveloppée par un provider à la racine.
  • useLocale s’exécute uniquement côté client.
  • Pour en savoir plus sur les chaînes de locale, consultez cette page.

Prochaines étapes

  • Apprenez à gérer et à spécifier les locales prises en charge dans votre application à l’aide du fichier gt.config.json.

Que pensez-vous de ce guide ?

useLocale