Components

LocaleSelector

Référence de l’API du composant <LocaleSelector>

Vue d’ensemble

Le composant <LocaleSelector> permet de sélectionner le locale de l’utilisateur. C’est un composant côté client qui affiche une liste déroulante pour choisir le locale.

Références

Renvoie

Un composant permettant à l’utilisateur de sélectionner sa locale.

Props

  • locales (facultatif) : string[]
    • Une liste optionnelle de locales (p. ex. ['en', 'es-MX', 'fr']) pour renseigner le menu déroulant. Si elle n’est pas fournie, la liste de locales du contexte <GTProvider> est utilisée.
  • customNames (facultatif) : {[locale: string]: string}
    • Un objet optionnel qui fait correspondre des codes de locale à des noms d’affichage personnalisés.
    • Exemple : {{ 'en-US': 'English (United States)', 'es': 'Español' }}

Exemples

Utilisation basique

import { LocaleSelector } from 'gt-next';

export default function MonComposant() {
    return (
        <LocaleSelector />
    );
}

Utilisation avec customNames

import { LocaleSelector } from 'gt-next';

export default function MyComponent() {
    const myCustomNames = {
        'en': 'Anglais',
        'es': 'Español',
        'fr-CA': 'Français (Canada)'
    };
    return (
        <LocaleSelector customNames={myCustomNames} />
    );
}

Notes

  • Le composant <LocaleSelector> vous permet de sélectionner un autre locale pour votre application.
  • Le composant <LocaleSelector> n’est pas disponible dans les composants serveur.

Prochaines étapes

  • En savoir plus sur le hook useLocale.
  • Découvrez le hook useLocaleSelector pour définir un sélecteur de langue personnalisé.
  • En savoir plus sur les chaînes de locale ici.

Que pensez-vous de ce guide ?

LocaleSelector