Démarrage rapide de React

Internationalisez votre application React en 5 minutes avec gt-react

Aperçu

Ce guide décrit comment internationaliser un projet React existant.

Nous couvrirons 4 étapes simples :

Installer les bibliothèques requises

Sélectionner les langues

Ajouter le composant <T>

Ajouter vos variables d'environnement

Ce processus entier devrait prendre moins de 5 minutes.


Configuration

1. Installer les bibliothèques

Installez les bibliothèques gt-react et gtx-cli.

npm i gt-react
npm i gtx-cli --save-dev

2. Sélectionner les langues

<GTProvider> est utilisé pour configurer le comportement de gt-react. Il doit être placé aussi haut que possible dans votre application, idéalement à la racine.

Il suffit de passer une liste de codes de locale pour les ajouter à votre application.

App.js
import { GTProvider } from "gt-react";
import MyApp from "./MyApp";
 
export default function App() {
  return (
    // Support du français et du chinois 
    <GTProvider locales={['fr', 'zh']}> 
      <MyApp />
    </GTProvider> 
  );
}

Pour une liste complète des props de <GTProvider> et une documentation étendue, consultez la référence API.

3. Ajouter le composant <T>

Enveloppez tout contenu JSX imbriqué dans le composant <T> pour le rendre traduisible. Pour plus d'informations, consultez le guide sur l'utilisation des composants <T>.

Example.js
import { T } from "gt-react";
 
export default function Example() {
  return (
    <T>
      <p>
        Ceci est traduit.
      </p>
    </T>  
  );
}

Utilisez le composant <Var> pour désigner le contenu JSX qui ne doit pas être traduit.

Example.js
import { T, Var } from "gt-react";
 
export default function Example() {
  return (
    <T>
      <p>
        Ceci est traduit. <Var>Ceci ne l'est pas.</Var>
      </p>
    </T>  
  );
}

Astuce : Pour gagner du temps, exécutez la commande de configuration. Cela analysera votre code pour le JSX traduisible et insérera les balises <T> pour vous.

shell
npx gtx-cli setup

Pour les chaînes de caractères, vous pouvez utiliser useGT() pour la traduction. Pour plus d'informations, consultez ce guide.

Example.js
import { useGT } from "gt-react";
 
export default function Example() {
  const t = useGT(); 
  return (
    <p>
      {t("Ceci est traduit.")}
    </p>
  );
}

4. Ajouter vos variables d'environnement

Ajoutez votre clé API et votre ID de projet à vos variables d'environnement.

Accédez au Tableau de bord.

  • Accédez à la page Clés de développeur dans la barre latérale.

Cliquez sur Créer une clé API de développement puis copiez la clé API et l'ID de projet dans votre presse-papiers.

Ajoutez l'ID de projet et la clé API à vos variables d'environnement. Selon votre framework React, les variables d'environnement peuvent sembler légèrement différentes. Ces instructions sont uniquement pour les ENVIRONNEMENTS DE DÉVELOPPEMENT.

VITE_GT_API_KEY="YOUR_GT_DEV_API_KEY"
VITE_GT_PROJECT_ID="YOUR_GT_PROJECT_ID"

Protégez vos clés API !

Les variables d'environnement React sont souvent intégrées dans votre application au moment de la construction et sont visibles publiquement dans le code côté client. Pour des raisons de sécurité, vous devriez :

  • Utiliser uniquement des clés API de développement pendant le développement local
  • Utiliser uniquement des clés API de production avec l'outil CLI pour le déploiement
  • Ne jamais inclure de clés API comme variables d'environnement en production

Essayons-le !

Félicitations ! 🥳 Votre application est maintenant multilingue ! Voyons-la en action.

Voir votre application dans une autre langue

Ajoutez le composant <LocaleSelector> à votre application. Cela vous permettra de sélectionner une langue différente pour votre application.

Astuce : Vous pouvez également changer votre langue dans les paramètres de votre navigateur.

Démarrez votre application React en mode développement.

npm run dev 

Ouvrez votre application dans votre navigateur préféré (généralement à http://localhost:3000).

Dépannage


Expédition en Production

Suivez notre guide sur l'expédition en production.


Prochaines étapes

  • Consultez notre référence API React pour des informations détaillées sur le composant <T> et d'autres composants disponibles.
  • Créez une liste de langues approuvées pour votre application avec le plugin React.

Sur cette page