useLocale()

Aperçu

Le hook useLocale récupère la locale actuelle de l'utilisateur à partir du contexte <GTProvider>. La locale retournée est formatée comme une chaîne de caractères, par exemple, 'en-US'.

Référence

Renvoie

Une chaîne représentant la langue actuelle de l'utilisateur, par exemple, 'en-US'.

Comportement de repli

Lorsqu'une locale non prise en charge est demandée, une locale de repli sera sélectionnée.

Par exemple, dans le cas d'une 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) l'une de ces locales est prise en charge par votre application, alors la locale basculera vers la meilleure langue disponible.

De plus, si aucune locale de repli possible n'est disponible, mais que deux locales partagent la même langue (par exemple, 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 obtenir des informations sur la configuration des locales prises en charge.

Exemples

Utilisation de base

Récupérez la langue actuelle et affichez-la dans votre composant.

import { useLocale } from 'gt-react';

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

Notes

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

Prochaines étapes

• Découvrez comment gérer et spécifier les langues prises en charge dans votre application avec le fichier gt.config.json.
• Pour accéder à la langue de secours, consultez useDefaultLocale().