Helpers

useLocale

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

Aperçu

Le hook useLocale récupère la locale actuelle de l’utilisateur à partir du contexte <GTProvider>. La locale renvoyée est au format chaîne, par exemple « en-US ».

Assurez-vous que votre application est enveloppée dans un <GTProvider>.

Références

Renvoie

Une chaîne représentant 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.

Consultez <GTProvider> pour savoir comment configurer les locales prises en charge.


Exemples

Utilisation de base

Récupérez la locale actuelle et affichez‑la dans votre composant.

CurrentLocale.jsx
import { useLocale } from 'gt-react';

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

Notes

  • Le hook useLocale s’appuie sur <GTProvider> pour accéder au contexte. Assurez-vous que votre application est enveloppée dans un provider à la racine.
  • En savoir plus sur les chaînes de locale ici.

Prochaines étapes

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

Comment trouvez-vous ce guide ?