useTranslations()

概要

useTranslations() は、翻訳用ディクショナリから文字列の翻訳を取得するために使用します。

<GTProvider> でラップされたコンポーネント内で使用する必要があります。

const d = useTranslations(); // 翻訳関数を取得
d('greeting.hello'); // 翻訳を取得するために ID を渡す

非同期コンポーネントについては、getTranslations() を参照してください。

getTranslations() と useTranslations() は、翻訳対象のすべてのコンテンツを保存するためにディクショナリを使用します。これは、翻訳のために <T> コンポーネントを使用する方法とは異なります。翻訳に <T> コンポーネントのみを使用したい場合は、このドキュメントは対象外です。

リファレンス

パラメータ

Prop	Type	Default
`id??`	`string`	`undefined`

説明

プロパティ	説明
`id`	すべての翻訳キーの前に付けるオプションのプレフィックス。ネストされた辞書値を扱う際に便利です。

戻り値

idが与えられると、対応するエントリの翻訳版を返す翻訳関数 d()

(id: string, options?: DictionaryTranslationOptions) => React.ReactNode

名前	型	説明
`id`	`string`	翻訳されるエントリのid
`options?`	`DictionaryTranslationOptions`	`d()` の動作をカスタマイズする翻訳オプション。

例

辞書の基本的な使い方

辞書内のすべてのエントリは翻訳対象になります。

dictionary.jsx

const dictionary = {
  greeting: "Hello, Bob", 
};
export default dictionary;

これらのエントリに（クライアント側で）アクセスするには、useTranslations() を呼び出します。このフックは、辞書内の翻訳キーを受け取る関数を返します。

TranslateGreeting.jsx

import { useTranslations } from 'gt-next';

export default async function TranslateGreeting() {
  const d = useTranslations(); 
  return (
    <p>
      {d('greeting')} // Hello, Alice // [!code highlight]
    </p>
  );
}

変数の使用

値を渡すには、(1) 識別子を割り当て、(2) d() 関数を呼び出す際にその識別子を参照します。

この例では、{} を使って翻訳に変数を渡します。辞書では、識別子 {userName} を割り当てます。

dictionary.jsx

const dictionary = {
  greeting: "Hello, {userName}!", 
};
export default dictionary;

src/server/TranslateGreeting.jsx

import { useTranslations } from 'gt-next';

export default async function TranslateGreeting() {
  const d = useTranslations();
  
  // Hello Alice!
  const greetingAlice = d('greeting', { userName: "Alice" }); 

  return (
    <p>
      {greetingAlice}
    </p>
  );
}

プレフィックスの使用

辞書の特定の一部だけを翻訳するために、プレフィックスを使えます。

dictionary.jsx

const dictionary = {
  prefix1: { 
    prefix2: { 
      greeting: "Hello, Bob",
    }
  }
};
export default dictionary;

useTranslations フックに 'prefix1.prefix2' を渡すと、すべてのキーは prefix1.prefix2 を前置したものとして解決されます:

UserDetails.jsx

import { useTranslations } from 'gt-next';

export default function UserDetails() {
  const d = useTranslations('prefix1.prefix2'); 
  return (
    <div>
      <p>{d('greeting')}</p> // greeting => prefix1.prefix2.greeting // [!code highlight]
    </div>
  );
}

Notes

useTranslations()関数を使用すると、クライアントサイドで辞書の翻訳にアクセスできます。
useTranslations()フックは、<GTProvider>コンポーネントでラップされたコンポーネント内でのみ使用できます。

次のステップ

サーバーサイド翻訳については、getTranslations()を参照してください。
辞書の使用について詳しくは、辞書リファレンスをご覧ください。
翻訳オプションの詳細については、DictionaryTranslationOptionsを参照してください。

useTranslations()

このページについて