withGTConfig()

Aperçu

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

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

const nextConfig = {
    // your existing next.config.js
}

export default withGTConfig(nextConfig, {
  // Additional configuration options
});

Utilisez withGTConfig() pour :

• Configurer les langues prises en charge et la langue par défaut (également appelée 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.
• Mettre en place des points de terminaison personnalisés.
• Personnaliser le comportement de traduction, la mise en cache et le regroupement des requêtes.

Référence

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

Ce fichier json sera chargé et fusionné avec la configuration passée à withGTConfig().

Consultez la référence gt.config.json pour plus d'informations sur le fichier de configuration.

Props Requises

Props Recommandées

Props Avancées

Retours

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

Exceptions

Lève une Error si le projectId est manquant et que les URLs 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 ne s'applique qu'aux traductions effectuées à l'exécution. 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 en attendant.
• default : Pour les locales avec la même langue (par exemple en-US et en-GB), se comporte comme replace. Pour les locales avec des langues différentes (par exemple en-US et fr), se comporte comme skeleton.

Délai d'expiration

Les délais d'expiration ne s'appliquent qu'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 disposent d'un délai d'expiration par défaut de 10 secondes pour les fonctions serverless sur le plan gratuit.

Exemples

Paramètres de rendu

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

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

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

const nextConfig = {
  // Your other next.js configurations
};

export default withGTConfig(nextConfig, {
  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.