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 au format chaîne de caractères, par exemple 'en-US'.

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

Références

Renvoie

Une promesse qui se résout en une chaîne représentant la locale actuelle 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 d’entre elles est prise en charge par votre application, alors la locale basculera vers la meilleure langue disponible.

De plus, si aucune locale de secours 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 cette langue.

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

Consultez la documentation de gt.config.json pour savoir comment configurer les 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 le locale.
• Elle est conçue spécifiquement pour une utilisation côté serveur. Voir useLocale pour les composants côté client.
• Le locale renvoyé respecte le format des locale strings.

Prochaines étapes

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