Helpers

useLocale

Référence de l’API pour le hook useLocale

Présentation

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, en cas de locale non prise en charge, si (1) l’utilisateur a configuré plusieurs locales préférées dans les paramètres de son navigateur et (2) si l’une de ces locales est prise en charge par votre application, alors la locale basculera vers la langue la plus appropriée.

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 cette langue.

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

Voir <GTProvider> pour des informations sur la configuration des locales prises en charge.


Exemples

Utilisation de base

Récupérez la locale en cours et affichez-la dans votre composant.

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

export default function CurrentLocale() {
    const locale = useLocale(); 
    return <p>Paramètre régional actif : {locale}</p>;
}

Notes

  • Le hook useLocale repose sur le <GTProvider> pour accéder au contexte. Assurez-vous que votre application est encapsulée dans un provider à la racine.
  • En savoir plus sur les locale strings ici.

Prochaines étapes

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

Que pensez-vous de ce guide ?

useLocale