Présentation

withGTConfig est le moyen principal de configurer la bibliothèque gt-next. Il encapsule directement un objet NextConfig.

import { withGTConfig } from 'gt-next/config';

const nextConfig = {
    // votre next.config.js existant
}

export default withGTConfig(nextConfig, {
  // Options de configuration supplémentaires
});

Utilisez withGTConfig pour :

• Configurer les langues prises en charge et la locale par défaut (langue de secours).
• Définir les API Keys et les IDs de projet pour accéder aux services GT.
• Définir le comportement de chargement.
• Configurer les paramètres de délai d’attente.
• Mettre en place des endpoints personnalisés.
• Personnaliser le comportement de traduction, la mise en cache et le regroupement des requêtes.
• Configurer la validation au moment du build via le plugin SWC.

Référence

Par défaut, withGTConfig cherchera un fichier gt.config.json dans le même répertoire que votre fichier next.config.js.

Ce fichier JSON sera chargé puis fusionné avec la configuration transmise à withGTConfig.

Consultez la documentation de référence gt.config.json pour en savoir plus sur le fichier de configuration.

Props requises

Props recommandées

Props avancées

Renvoie

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

Exceptions

Déclenche une Error si le projectId est manquant et que des URL par défaut sont utilisées, ou si une clé d’API est requise mais absente.

Paramètres de rendu

Les paramètres de rendu contrôlent le comportement des traductions pendant leur chargement. Cela ne s’applique qu’aux traductions exécutées au runtime. Si la traduction est mise en cache, le temps de réponse est trop court pour justifier un comportement de chargement.

Méthodes de rendu

• skeleton : Affiche un fragment.
• replace : Affiche le contenu dans la langue par défaut pendant l’attente.
• default : Pour les locales partageant la même langue (p. ex. en-US et en-GB), se comporte comme replace. Pour des locales avec des langues différentes (p. ex. en-US et fr), se comporte comme skeleton.

Délai d’attente

Les délais d’attente ne s’appliquent qu’aux traductions à l’exécution, c’est‑à‑dire aux traductions effectuées à la demande lorsqu’elles n’ont pas été mises en cache.

Les délais d’attente sont fixés à 8 secondes par défaut. Ce choix de conception vise à faciliter les utilisateurs de Vercel, qui disposent d’un délai d’attente par défaut de 10 secondes pour les fonctions serverless sur l’offre gratuite.

Exemples

Paramètres d’affichage

Cet exemple configure gt-next pour afficher un écran de chargement (squelette) en attendant que les traductions se chargent. Si le chargement des traductions dépasse 8 secondes, la méthode arrive à expiration et affiche le contenu dans la langue par défaut.

{
  "defaultLocale": "en-US",
  "locales": ["en-US", "es", "fr"],
}

import { withGTConfig } from 'gt-next/config';

const nextConfig = {
  // Vos autres configurations Next.js
};

export default withGTConfig(nextConfig, {
  renderSettings: {
    method: 'skeleton',
    timeout: 10000,
  },
});

Validation à la compilation

Cet exemple configure le plug-in SWC pour traiter les violations de contenu dynamique comme des erreurs de compilation plutôt que comme de simples avertissements.

import { withGTConfig } from 'gt-next/config';

const nextConfig = {
  // Autres paramètres Next.js
};

export default withGTConfig(nextConfig, {
  // Échouer la compilation en cas d’infractions JSX dynamiques
  dynamicJsxCheckLogLevel: 'error',
  // Avertir en cas d’infractions de chaînes dynamiques
  dynamicStringCheckLogLevel: 'warn',
});

Notes

• withGTConfig intègre les fonctionnalités de traduction de GT à 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 via des variables d'environnement.
• Des paramètres avancés comme renderSettings et _batchInterval permettent un contrôle fin du comportement et des performances de la traduction.

Prochaines étapes

• Ajoutez la traduction à votre processus de CD (Continuous Delivery/Déploiement continu).