Types

InlineTranslationOptions

Référence de l’API du type InlineTranslationOptions

Vue d’ensemble

Le type InlineTranslationOptions sert à passer des variables aux traductions inline et à préciser leur mode de rendu. Vous pouvez aussi ajouter du contexte et un identifiant à la traduction. Il s’emploie avec useGT et msg pour passer des variables aux traductions de chaînes inline.

Buildtime Translation : Les traductions useGT et msg s’effectuent au moment du build ; toutefois, les variables ne sont jamais traduites. Elles sont insérées dans la traduction avec le formatage approprié. Assurez-vous de suivre le guide de déploiement.

Références

Paramètres

Prop

Type

Description

PropDescription
variablesUn objet dont les clés indiquent l’emplacement où chaque valeur est insérée dans la chaîne.
$contextVous pouvez inclure $context comme variable dans l’objet variables pour fournir du contexte au contenu (utilisé pour la traduction).
$idVous pouvez inclure $id comme variable dans l’objet variables pour fournir un identifiant à utiliser avec l’éditeur de traduction.

Exemples

Contexte

Pour ajouter du contexte à la chaîne, nous utilisons la prop $context.

Component.tsx
import { useGT } from 'gt-react';

const Component = () => {
  const t = useGT();
  return <div>{t('Bonjour, monde !', { $context: 'salutation formelle' })}</div>;
};

Passage de variables

Pour ajouter une variable à une chaîne, utilisez la syntaxe {variable-name}, où des accolades entourent le nom de la variable.

Component.tsx
import { useGT } from 'gt-react';

const Component = () => {
  const t = useGT();
  return <div>{t('Bonjour, {username} ! Comment se passe votre journée ?', { username: 'Brian123' })}</div>;
};

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.

Component.tsx
import { useGT } from 'gt-react';

const Component = () => {
  const t = useGT();
  return <div>
    { t(
      'Solde de votre compte : {dollars, number, ::currency/USD} !',
      {
        "dollars" : 1000000,
      }
    ) }
  </div>;
};

Consultez la documentation du format de message ICU pour en savoir plus sur le format de message ICU.


Notes

  • InlineTranslationOptions est utilisé pour les traductions de chaînes en ligne.
  • L’objet variables transmet des valeurs au texte.
  • L’objet variablesOptions définit le comportement des variables.

Prochaines étapes

  • Consultez useGT pour en savoir plus sur les traductions de chaînes en ligne.
  • Consultez le format de message ICU pour en savoir plus sur les options de formatage.

Que pensez-vous de ce guide ?

InlineTranslationOptions