withGTConfig()

概要

withGTConfig() は、gt-next ライブラリを設定するための主な方法です。 これは NextConfig オブジェクトを直接ラップします。

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

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

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

withGTConfig() を使用して以下を行います:

• サポートする言語とデフォルトロケール（いわゆるフォールバック言語）の設定
• GTサービスへアクセスするためのAPIキーやプロジェクトIDの設定
• ローディング動作の設定
• タイムアウト設定の構成
• カスタムエンドポイントの設定
• 翻訳動作、キャッシュ、リクエストのバッチ処理のカスタマイズ

リファレンス

デフォルトでは、withGTConfig()はnext.config.jsファイルと同じディレクトリにあるgt.config.jsonファイルを探します。

このjsonファイルが読み込まれ、withGTConfig()に渡された設定とマージされます。

設定ファイルの詳細については、gt.config.jsonリファレンスを参照してください。

必須Props

推奨Props

高度なProps

Returns

指定されたGT設定でNext.js設定オブジェクトを拡張する関数(NextConfig) => NextConfig。

Exceptions

projectIdが不足していてデフォルトURLが使用されている場合、またはAPIキーが必要で不足している場合にErrorをスローします。

レンダリング設定

レンダリング設定は、翻訳が読み込まれている間の挙動を制御します。 これは、実行時に行われる翻訳にのみ適用されます。 翻訳がキャッシュされている場合、応答時間が非常に短いため、読み込み挙動を設定する必要はありません。

レンダリング方法

• skeleton: フラグメントをレンダリングします。
• replace: 待機中はデフォルト言語のコンテンツをレンダリングします。
• default: 同じ言語のロケール（例：en-US と en-GB）の場合は replace と同様に動作します。異なる言語のロケール（例：en-US と fr）の場合は skeleton と同様に動作します。

タイムアウト

タイムアウトは、実行時翻訳、またはキャッシュされていないためにオンデマンドで実行する必要がある翻訳にのみ適用されます。

タイムアウトはデフォルトで8秒に設定されています。 この設計は、無料プランでサーバーレス関数のデフォルトタイムアウトが10秒である vercel ユーザーを考慮したものです。

例

レンダリング設定

この例では、翻訳の読み込みを待つ間にスケルトンをレンダリングするようにgt-nextを設定します。 翻訳に8秒以上かかる場合、メソッドはタイムアウトしてデフォルト言語のコンテンツをレンダリングします。

{
  "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,
  },
});

注意事項

• withGTConfig() は GT の翻訳機能を Next.js アプリに統合し、ルートの設定ファイルで使用する必要があります。
• apiKey や projectId などのパラメータは、設定内で直接指定するか、環境変数として設定できます。
• renderSettings や _batchInterval などの高度なパラメータを使うことで、翻訳の動作やパフォーマンスを細かく制御できます。

次のステップ

• 翻訳をCDプロセスに追加する。