Dictionary

getTranslations()

Référence API pour la fonction de traduction côté serveur getTranslations

Aperçu

getTranslations() est utilisé pour obtenir les traductions de chaînes de caractères à partir du dictionnaire de traduction pour les composants côté serveur.

const d = await getTranslations(); // Obtenir la fonction de traduction
d('greeting.hello'); // passer l'id pour obtenir une traduction

getTranslations() prend en charge :

  • La traduction de contenu de chaînes de caractères et jsx.
  • L'insertion de variables et la logique conditionnelle dans les traductions.
  • Le préfixage d'id optionnel.

Pour les traductions côté client, voir useTranslations().

getTranslations() et useTranslations() utilisent un dictionnaire pour stocker tout le contenu à traduire. Ceci est différent de l'utilisation du composant <T> pour la traduction. Si vous êtes uniquement intéressé par l'utilisation des composants <T> pour la traduction, alors ce document n'est pas pertinent.

Référence

Props

PropTypeDefault
id??
string
undefined

Description

PropDescription
idUn préfixe optionnel à ajouter devant toutes les clés de traduction. Ceci est utile pour travailler avec des valeurs de dictionnaire imbriquées.

Retourne

Une promesse d'une fonction de traduction d() qui, étant donné un id, retournera la version traduite de l'entrée correspondante

Promise<(id: string, options?: DictionaryTranslationOptions) => React.ReactNode>
NomTypeDescription
idstringL'id de l'entrée à traduire
options?DictionaryTranslationOptionsOptions de traduction pour personnaliser le comportement de d().

Exemples

Utilisation de base

Chaque entrée de votre dictionnaire est traduite.

dictionary.jsx
const dictionary = {
  greeting: <>Hello, Alice!</>, 
};
export default dictionary;

Lorsque nous voulons accéder à ces entrées (côté serveur), nous appelons getTranslations(). Cela retourne une fonction qui accepte la clé d'une traduction du dictionnaire.

TranslateGreeting.jsx
import { getTranslations } from 'gt-next/server';

export default async function TranslateGreeting() {
  
  const d = await getTranslations(); 

  return (
    <p>
      {d('greeting')} // Hello, Alice // [!code highlight]
    </p>
  );
}

Utilisation de variables

Pour passer des valeurs, vous devez (1) assigner un identifiant et (2) référencer l'identifiant lors de l'appel de la fonction d().

Dans cet exemple, nous utilisons {} pour passer des variables aux traductions. Dans le dictionnaire, nous assignons l'identifiant {userName}.

dictionary.jsx
const dictionary = {
  greeting: "Hello, {userName}!", 
};
export default dictionary;
TranslateGreeting.jsx
import { getTranslations } from 'gt-next/server';

export default async function TranslateGreeting() {
  const d = await getTranslations();
  
  // Hello Alice!
  const greetingAlice = d('greeting', { userName: "Alice" }); 

  return (
    <p>
      {greetingAlice}
    </p>
  );
}

Utilisation de préfixes

Nous pouvons utiliser des préfixes pour récupérer seulement un sous-ensemble du dictionnaire.

dictionary.jsx
const dictionary = {
  prefix1: { 
    prefix2: { 
      greeting: "Hello, Bob",
    }
  }
};
export default dictionary;

Parce que nous avons ajouté la valeur 'prefix1.prefix2' à la méthode getTranslations, toutes les clés sont préfixées avec prefix1.prefix2 :

UserDetails.jsx
import { getTranslations } from 'gt-next/server';

export default function UserDetails() {
  const d = await getTranslations('prefix1.prefix2'); 
  return (
    <div>
      <p>{d('greeting')}</p> // greeting => prefix1.prefix2.greeting // [!code highlight]
    </div>
  );
}

Notes

  • La fonction getTranslations() vous permet d'accéder aux traductions du dictionnaire côté serveur.

Prochaines étapes

Comment trouvez-vous ce guide ?