Aperçu

La fonction useMessages est un hook qui traduit des encoded strings provenant de msg lors de la build.

const m = useMessages();

<p>{  m(chaineEncodée)  }</p>;

Références

Paramètres

Aucun

Renvoie

Une fonction de rappel, m, qui traduit le contenu encodé fourni depuis msg.

(encodedContent: string, options?: Record<string, any>) => string

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 de la compilation.

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 à l’artefact de build de votre application, selon votre configuration. À partir de là, le contenu traduit est distribué à vos utilisateurs. Si une traduction est introuvable, un contenu de secours s’applique et le texte original est utilisé.

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

Développement

Pendant le développement, la fonction m 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, c’est‑à‑dire en utilisant tx ou <Tx>.

Exemple

Utilisation de base

Vous pouvez utiliser useMessages pour traduire des encoded strings avec msg.

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

const encodedGreeting = msg('Salut, Alice !');

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

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

Remarque : "Alice" sera traduite dans la langue préférée de l’utilisateur.

Utilisation des variables

Vous pouvez remplacer des variables dans des encoded strings.

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

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

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

  return (
    <p>
      {m(encodedGreeting, { name: 'Bob' })}
    </p>
  );
}

Remarque : cela affichera « Hello, Bob! » — la variable est surchargée au moment du rendu.

Utilisation du format de message ICU

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

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

const encodedMessage = 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(encodedMessage)}
    </p>
  );
}

Importation depuis gt-next/client

Si vous utilisez la directive "use client", importez depuis gt-next/client plutôt que depuis gt-next.

"use client";
import { msg, useMessages } from 'gt-next/client';

const encodedGreeting = msg('Salut, Alice !');

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

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

Notes

• La fonction useMessages est un hook qui traduit des encoded strings issues de msg.
• Avec useMessages, les chaînes sont traduites avant l’exécution, lors du processus de build (sauf en développement).

Prochaines étapes

• Consultez getMessages pour traduire de manière asynchrone des chaînes à partir d’encoded strings lors de la compilation.
• Consultez msg pour encoder des chaînes en vue de leur traduction.
• Pour les traductions à l’exécution, consultez tx et <Tx>.