getLocale()

Aperçu

La fonction getLocale() récupère la locale actuelle de l'utilisateur lors du rendu côté serveur. La locale retournée est formatée sous forme de chaîne, par exemple, 'en-US'.

Pour une utilisation côté client, voir useLocale().

Référence

Renvoie

Une promesse qui se résout en 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 la documentation gt.config.json pour plus d'informations sur la configuration des locales prises en charge.

Exemples

Utilisation de base

Récupérez la langue de l'utilisateur lors du rendu côté serveur.

import getLocale from 'gt-next/server';

export default async function GetUserLocale() {
    const locale = await getLocale(); 
    return <p>User locale: {locale}</p>;
}

Notes

• La fonction getLocale() est asynchrone et doit être utilisée avec await pour récupérer la locale.
• Elle est spécialement conçue pour une utilisation côté serveur. Voir useLocale() pour les composants côté client.
• La locale retournée respecte le format des chaînes de locale.

Prochaines étapes

• Découvrez comment configurer les langues prises en charge avec withGTConfig().
• Pour gérer les langues de secours, consultez getDefaultLocale().