Vue d’ensemble

La fonction getLocale récupère la locale actuelle de l’utilisateur lors du rendu côté serveur. La locale renvoyée est formatée comme une chaîne, par exemple : 'en-US'.

Pour une utilisation côté client, consultez useLocale.

Références

Renvoie

Une promesse qui se résout par une chaîne représentant le locale actuel de l’utilisateur, par exemple 'en-US'.

Comportement de secours

Lorsqu’un locale non pris en charge est demandé, un locale de secours est sélectionné.

Par exemple, dans le cas d’un locale non pris en charge, si (1) l’utilisateur a configuré plusieurs locales préférés dans les paramètres de son navigateur et (2) que l’un de ces locales est pris en charge par votre application, alors le locale basculera vers la meilleure langue.

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

Si aucune des conditions ne peut être remplie, le locale par défaut sera utilisé.

Consultez la documentation de gt.config.json pour des informations sur la configuration des locales prises en charge.

Exemples

Utilisation de base

Récupérez le locale 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>Locale de l'utilisateur : {locale}</p>;
}

Notes

• La fonction getLocale est asynchrone et doit être await pour récupérer la locale.
• Elle est spécifiquement conçue pour une utilisation côté serveur. Voir useLocale pour les composants côté client.
• La locale renvoyée respecte le format des locale strings.

Prochaines étapes

• Découvrez comment configurer les locales prises en charge avec withGTConfig().