useGT()

概要

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

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

リファレンス

パラメーター

なし

戻り値

提供されたコンテンツを翻訳するコールバック関数、t()。

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

振る舞い

本番環境

CDプロセス中に、t() 関数内のコンテンツは、アプリケーションがデプロイされる前に翻訳されます。 これにより、すべてのロケールでの読み込み時間が速くなりますが、ビルド時に既知のコンテンツのみを翻訳できます。

生成された翻訳は、設定に応じて (1) CDNに保存されるか、(2) アプリのビルド出力に保存されます。 そこから、翻訳されたコンテンツがユーザーに提供されます。 翻訳が見つからない場合は、元のコンテンツにフォールバックします。

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

開発環境

開発中は、t() 関数が要求に応じてコンテンツを翻訳します。 これは、アプリが異なる言語でどのように見えるかをプロトタイプするのに役立ちます。 この動作を有効にするには、環境にDev APIキーを追加することを忘れないでください。

開発中のオンデマンド翻訳では遅延が発生します。 これは本番ビルドでは発生しません。

例

基本的な使い方

useGT() を使用して文字列を翻訳できます。

import { useGT } from 'gt-react';
 
export default function TranslateGreeting() {
  const t = useGT();
 
  return (
    <p>
      {t('Hello, Alice!')}
    </p>
  );
}

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

変数の使用

辞書翻訳に変数を渡すことができます。

import { useGT } from 'gt-react';
 
export default function TranslateGreeting() {
  const t = useGT();
 
  return (
    <p>
      {t('Hello, {name}!', { variables: { name: 'Alice' } })}
    </p>
  );
}

注意: "Alice" は変数であるため、ユーザーの優先言語に翻訳されません。

メモ

• useGT() 関数は文字列を翻訳するためのフックです。
• useGT() フックは、<GTProvider> コンポーネントでラップされたコンポーネント内でのみ使用できます。
• useGT() を使用した翻訳文字列は、実行時の前、ビルドプロセス中に行われます（開発中を除く）。

次のステップ

• 辞書を使用して文字列を翻訳するには、useDict() を参照してください。
• 翻訳をカスタマイズする方法については、InlineTranslationOptions を参照してください。