Types

ランタイム翻訳オプション

RuntimeTranslationOptions型のAPIリファレンス

概要

RuntimeTranslationOptions 型は、インライン翻訳に変数を渡し、そのレンダー動作を指定するために使用されます。 翻訳のために異なる言語を指定するためにロケールを追加することもできます。 これは tx() 関数と共に使用されます。

ランタイム翻訳: 変数をオンデマンドで翻訳するには、tx() に渡される文字列に直接含めてください。 options オブジェクトを介して tx() に渡された変数は翻訳されません。

リファレンス

パラメーター

PropTypeDefault
variablesOptions??
Record<string, Intl.NumberFormatOptions | Intl.DateTimeFormatOptions>
undefined
variables??
Record<string, any>
undefined
locale??
string
undefined

説明

Prop説明
locale翻訳に使用するオプションのロケール。アプリがサポートするブラウザの最も優先されるロケールがデフォルトになります。
variables各値が文字列内のどこにマッピングされるかを識別するキーを持つオブジェクト。
variablesOptions変数を識別するキーと変数の動作を定義する値を持つオブジェクト。詳細は Intl.NumberFormatOptions および Intl.DateTimeFormatOptions を参照してください。

変数を渡す

文字列に変数を追加するには、{variable-name} 構文を使用します。ここで、波括弧が変数名を囲みます。

Component.tsx
import { tx } from 'gt-next/server';

const Component = () => {
  return <div>
    {tx(`こんにちは、{username}さん!`,{ variables: { 'username' : 'Brian123' } })}
  </div>;
};

変数オプションを追加する

variablesOptions プロップを使用して、変数の表示方法をカスタマイズすることもできます。

Component.tsx
import { tx } from 'gt-next/server';

const Component = () => {
  return <div>
    { tx(
      'あなたの口座残高: {account-balance}!',
      {
        variables: { "account-balance" : 1000000 },
        variableOptions: { "account-balance": { style: 'currency', currency: 'USD' } }
      }
    ) }
  </div>;
};

変数を翻訳する

変数を翻訳するには、tx() に渡される文字列に直接含めます。

Component.tsx
import { tx } from 'gt-next/server';

const Component = ({ hairColor }: { hairColor: string }) => {
  return <div>{tx(
    `こんにちは、{username}さん!あなたの髪の色は${hairColor}です`,
    { variables: { 'username' : 'Brian123' } }
  )}</div>;
};

変数 hairColor は翻訳されますが、username は翻訳されません。

ロケールを指定する

翻訳に使用するロケールを指定できます。

Component.tsx
import { tx } from 'gt-next/server';

const Component = () => {
  return <div>{tx('こんにちは、世界!', { locale: 'fr' })}</div>;
};

これは常にフランス語に翻訳されます。


メモ

  • RuntimeTranslationOptions は、実行時の文字列翻訳に使用されます。
  • variables オブジェクトは、テキストに値を渡します。
  • variablesOptions オブジェクトは、変数の動作を定義します。

次のステップ

このガイドはいかがですか?