getTranslations()

概要

getTranslations()は、サーバーサイドコンポーネント用の翻訳辞書から文字列翻訳を取得するために使用されます。

const d = await getTranslations(); // 翻訳関数を取得
d('greeting.hello'); // IDを渡して翻訳を取得

getTranslations()は以下をサポートします：

文字列とjsxコンテンツの翻訳。
翻訳内での変数挿入と条件ロジック。
オプションのIDプレフィックス。

クライアントサイドの翻訳については、useTranslations()を参照してください。

getTranslations()とuseTranslations()は、翻訳用のすべてのコンテンツを保存するために辞書を使用します。これは翻訳に<T>コンポーネントを使用するのとは異なります。翻訳に<T>コンポーネントのみを使用することに興味がある場合、このドキュメントは関連しません。

リファレンス

Props

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

説明

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

戻り値

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

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

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

例

基本的な使用方法

辞書内のすべてのエントリが翻訳されます。

dictionary.jsx

const dictionary = {
  greeting: <>Hello, Alice!</>, 
};
export default dictionary;

これらのエントリにアクセスしたい場合（サーバーサイドで）、getTranslations()を呼び出します。これは辞書から翻訳のキーを受け取る関数を返します。

TranslateGreeting.jsx

import { getTranslations } from 'gt-next/server';

export default async function TranslateGreeting() {
  
  const d = await getTranslations(); 

  return (
    <p>
      {d('greeting')} // Hello, Alice // [!code highlight]
    </p>
  );
}

変数の使用

値を渡すためには、(1) 識別子を割り当て、(2) d()関数を呼び出すときにその識別子を参照する必要があります。

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

dictionary.jsx

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

TranslateGreeting.jsx

import { getTranslations } from 'gt-next/server';

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

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

プレフィックスの使用

プレフィックスを使用して、辞書のサブセットのみを取得できます。

dictionary.jsx

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

getTranslationsメソッドに値'prefix1.prefix2'を追加したため、すべてのキーにprefix1.prefix2がプレフィックスとして付きます：

UserDetails.jsx

import { getTranslations } from 'gt-next/server';

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

Notes

getTranslations()関数を使用すると、サーバーサイドで辞書の翻訳にアクセスできます。

次のステップ

getTranslations()のクライアントサイド版であるuseTranslations()を参照してください。
辞書リファレンスで辞書の使用について詳しく学んでください。

getTranslations()

このページについて