withGTConfig()

Aperçu

withGTConfig() est la principale méthode pour configurer la bibliothèque gt-next. Il enveloppe directement un objet NextConfig.

import { withGTConfig } from 'gt-next/config';
 
const nextConfig = {
    // votre next.config.js existant
}
 
export default withGTConfig(nextConfig, {
  defaultLocale: 'en-US',
  locales: ['en-US', 'es', 'fr'],
});

Il n'est pas nécessaire d'utiliser withGTConfig() pour activer la fonctionnalité de traduction, mais il est recommandé de configurer la bibliothèque selon vos besoins.

Utilisez withGTConfig() pour :

• Configurer les langues prises en charge et la langue par défaut (alias langue de secours).
• Définir les clés API et les identifiants de projet pour accéder aux services GT.
• Définir le comportement de chargement.
• Configurer les paramètres de délai d'attente.
• Configurer des points de terminaison personnalisés.
• Personnaliser le comportement de traduction, la mise en cache et le regroupement des requêtes.

Référence

Props Requis

Props Recommandés

Props Avancés

Retours

Une fonction (NextConfig) => NextConfig qui améliore l'objet de configuration Next.js avec les paramètres GT spécifiés.

Exceptions

Lance une Error si le projectId est manquant et que les URL par défaut sont utilisées, ou si la clé API est requise et manquante.

Paramètres de rendu

Les paramètres de rendu contrôlent le comportement des traductions pendant leur chargement. Cela s'applique uniquement aux traductions qui se produisent à l'exécution. Si la traduction est mise en cache, le temps de réponse est trop court pour justifier le comportement de chargement.

Méthodes de rendu

• skeleton: Rend un fragment.
• replace: Rend le contenu dans la langue par défaut en attendant.
• default: Pour les locales avec la même langue (c'est-à-dire en-US et en-GB), se comporte comme replace. Pour les locales avec des langues différentes (c'est-à-dire en-US et fr), se comporte comme skeleton.

Délai d'expiration

Les délais d'expiration s'appliquent uniquement aux traductions à l'exécution, ou aux traductions qui doivent être effectuées à la demande car elles n'ont pas été mises en cache.

Les délais d'expiration sont fixés à 8 secondes par défaut. Cette décision de conception vise à faciliter les utilisateurs de vercel qui ont un délai d'expiration par défaut de 10 secondes pour les fonctions serverless sur le plan gratuit.

Exemples

Locales prises en charge

Cet exemple configure gt-next avec l'anglais (en-US) comme langue par défaut. Il prend exclusivement en charge les traductions en espagnol (es) et en français (fr), et fournit une description pour une traduction contextuelle.

Le site reviendra à la langue la plus appropriée si aucune des locales ne correspond. Il recherchera les langues correspondantes (c'est-à-dire, en-US et en-GB), ainsi que les autres langues préférées que l'utilisateur a définies dans son navigateur. Si tout échoue, il reviendra alors à la langue par défaut.

import { withGTConfig } from 'gt-next/config';
 
const nextConfig = {
  // Your other next.js configurations
}
 
export default withGTConfig(nextConfig, {
  defaultLocale: 'en-US',
  locales: ['en-US', 'es', 'fr'],
  description: 'A personal blog about technology and travel',
});

Paramètres de rendu

Cet exemple configure gt-next pour rendre un squelette en attendant que les traductions se chargent. Si la traduction prend plus de 8 secondes, la méthode expirera et rendra le contenu de la langue par défaut.

import { withGTConfig } from 'gt-next/config';
 
const nextConfig = {
  // Your other next.js configurations
};
 
// locales field is left empty, so this configuration supports all 100+ languages
export default withGTConfig(nextConfig, {
  defaultLocale: 'en-US',
  renderSettings: {
    method: 'skeleton',
    timeout: 10000,
  },
});

Notes

• withGTConfig() intègre la fonctionnalité de traduction GT dans votre application Next.js et doit être utilisé dans le fichier de configuration racine.
• Des paramètres comme apiKey et projectId peuvent être définis directement dans la configuration ou comme variables d'environnement.
• Des paramètres avancés comme renderSettings et _batchInterval permettent un contrôle précis du comportement et des performances de la traduction.

Prochaines étapes

• Ajoutez la traduction à votre processus CD.
• Lisez-en plus sur la configuration i18n dans notre guide de référence.