概要

useGT 関数は、ビルド時に文字列を翻訳するためのフックです。

const t = useGT();

<p>{  t('このテキストは翻訳されます')  }</p>;

リファレンス

パラメータ

なし

戻り値

指定したコンテンツを翻訳するコールバック関数 t。

(content: string, options?: InlineTranslationOptions) => string

動作

本番運用

CDプロセス（継続的デリバリー／継続的デプロイ）の間、t 関数内のコンテンツは、アプリケーションのデプロイ前に翻訳されます。 これにより、すべての対応ロケールで高速な読み込みが可能になりますが、翻訳できるのはビルド時点で判明しているコンテンツに限られます。

生成された翻訳は、設定に応じて (1) CDN（コンテンツ配信ネットワーク）に保存するか、(2) アプリのビルド出力に保存します。 その後、翻訳済みコンテンツがユーザーに配信されます。 翻訳が見つからない場合は、元のコンテンツがフォールバックとして使用されます。

こちらのデプロイガイドに従ってください。

開発

開発中は、t 関数が必要に応じてコンテンツを翻訳します。 これにより、アプリがさまざまな言語でどのように表示されるかを試作できます。 この挙動を有効にするには、環境に Dev APIキー を追加してください。

開発環境でのオンデマンド翻訳では遅延が発生することがあります。 これは、本番ビルドではコンテンツを明示的にオンデマンド翻訳していない限り発生しません。 つまり、tx や <Tx> を使用している場合です。

例

基本的な使い方

useGT を使って文字列を翻訳できます。

import { useGT } from 'gt-next';

export default function TranslateGreeting() {
  const t = useGT();

  return (
    <p>
      {t('こんにちは、アリス！')}
    </p>
  );
}

注: 「Alice」はユーザーの優先言語に翻訳されます。

変数の使用

dictionary の翻訳に variables を渡せます。

import { useGT } from 'gt-next';

export default function TranslateGreeting() {
  const t = useGT();

  return (
    <p>
      {t('こんにちは、{name}さん！', { name: 'Alice'  })}
    </p>
  );
}

Note: 「Alice」は Variable であるため、ユーザーの希望する言語には翻訳されません。

ICU メッセージ形式の使用

gt-next は ICU メッセージ形式をサポートしており、variables のフォーマットも行えます。

import { useGT } from 'gt-next';

export default function TranslateGreeting() {
  const t = useGT();
  return (
    <p>
      {t('カートに{count, plural, =0 {商品はありません} =1 {商品が1点あります} other {{count}点の商品があります}}', { count: 10 })}
    </p>
  );
}

gt-next/client からのインポート

"use client" ディレクティブを使用している場合は、gt-next ではなく gt-next/client からインポートしてください。

"use client";
import { useGT } from 'gt-next/client';

export default function TranslateGreeting() {
  const t = useGT();

  return (
    <p>
      {t('こんにちは、アリス！')}
    </p>
  );
}

注意事項

• useGT 関数は、文字列を翻訳するためのフックです。
• useGT による翻訳は、実行時より前のビルド時に行われます（開発環境を除く）。

次のステップ

• ビルド時に非同期で文字列を翻訳するには、getGT を参照してください。
• 実行時の翻訳については、tx と <Tx> を参照してください。