Vue d’ensemble

La fonction msg sert à marquer et encoder des chaînes en vue de leur traduction.

const encodedString = msg('Bonjour le monde !');

La chaîne encodée doit être transmise au hook useMessages ou à la fonction getTranslations pour récupérer les traductions.

Décodage

Pour récupérer la chaîne d’origine, vous devez la décoder avec decodeMsg

import { msg, decodeMsg } from 'gt-react';
const encodedString = msg('Bonjour le monde !');
const decodedString = decodeMsg(encodedString);
console.log(decodedString); // "Bonjour le monde !"

Référence

Paramètres

Renvoie

Une encoded string, avec les variables interpolées (le cas échéant) remplacées par leurs valeurs.

Comportement

Production

Pendant le processus de CD (Continuous Delivery/Déploiement continu), tout contenu à l’intérieur d’une fonction msg est traduit avant le déploiement de votre application. Cela garantit des temps de chargement rapides pour toutes les locales, mais ne peut traduire que le contenu connu au moment du build.

Une fois générées, les traductions sont soit (1) stockées dans le CDN (Content Delivery/Distribution Network), soit (2) intégrées dans le résultat de build de votre application, selon votre configuration. À partir de là, le contenu traduit est diffusé à vos utilisateurs. Si une traduction est introuvable, un contenu de secours est utilisé et l’original est affiché.

Assurez-vous de suivre le guide de déploiement ici.

Développement

Pendant le développement, la fonction msg traduira le contenu à la demande. C’est utile pour prototyper l’apparence de votre application dans différentes langues. N’oubliez pas d’ajouter une clé d’API de développement à votre environnement pour activer ce comportement.

Vous constaterez un délai lors des traductions à la demande en développement. Cela ne se produira pas dans les builds de production, sauf si le contenu est explicitement traduit à la demande, p. ex., en utilisant tx ou <Tx>.

Exemple

Utilisation de base

Vous pouvez utiliser msg pour marquer des chaînes de caractères à traduire.

import { msg, useMessages } from 'gt-react';

const encodedString = msg('Bonjour le monde !');

export default function TranslateGreeting() {
  const m = useMessages();
  return (
    <p>
      {m(encodedString)}
    </p>
  );
}

Remarque : « Hello, world! » sera traduit dans la langue de préférence de l’utilisateur.

Utilisation des variables

Vous pouvez passer des variables aux traductions du dictionary.

import { msg, useMessages } from 'gt-react';

const encodedString = msg('Bonjour, {name} !', { name: 'Alice' });

export default function TranslateGreeting() {
  const m = useMessages();

  return (
    <p>
      {m(encodedString)}
    </p>
  );
}

Remarque : « Alice » ne sera pas traduit dans la langue préférée de l’utilisateur, car il s’agit d’une variable.

Utiliser le format de message ICU

gt-react prend en charge le format de message ICU, ce qui vous permet également de mettre en forme vos variables.

import { msg, useMessages } from 'gt-react';

const encodedString = msg('Il y a {count, plural, =0 {aucun article} =1 {un article} other {{count} articles}} dans le panier', { count: 10 });

export default function TranslateGreeting() {
  const m = useMessages();
  return (
    <p>
      {m(encodedString)}
    </p>
  );
}

Notes

• La fonction msg sert à marquer les chaînes à traduire.
• Les chaînes marquées avec msg sont traitées avant l’exécution, lors du processus de build (sauf en développement).

Prochaines étapes

• Consultez useMessages pour traduire des chaînes de caractères.