Inline Translations

msg

msg() 文字列関数のAPIリファレンス

概要

msg 関数は、翻訳対象として文字列をマーキングし、エンコードするための関数です。

const encodedString = msg('こんにちは、世界!');

エンコードされた文字列は、翻訳を取得するために useMessages フックまたは getMessages 関数へ渡してください。

エンコード: msg は入力文字列をエンコードするため、JSX などで直接利用することはできません。 元の文字列に戻すには、decodeMsg でデコードしてください。

デコード

元の文字列に戻すには、decodeMsg でデコードします。

import { msg, decodeMsg } from 'gt-next';
const encodedString = msg('Hello, world!');
const decodedString = decodeMsg(encodedString);
console.log(decodedString); // "Hello, world!"

リファレンス

パラメーター

名称説明
contentstringエンコード対象の文字列。
options?InlineTranslationOptionsmsg の動作をカスタマイズするための翻訳 options。

戻り値

エンコードされた文字列。挿入された variables(ある場合)は、その値に置き換えられます。


動作

本番運用

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

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

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

開発

開発中は、msg 関数が必要に応じてコンテンツを翻訳します。 これは、アプリが各言語でどのように表示されるかを試作するのに役立ちます。 この動作を有効にするには、環境に Dev API key を追加することを忘れないでください。

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


基本的な使い方

翻訳対象の文字列をマークするには、msg を使用します。

import { msg, useMessages } from 'gt-next';

const encodedString = msg('こんにちは、世界!');

export default function TranslateGreeting() {
  const m = useMessages();
  return (
    <p>
      {m(encodedString)}
    </p>
  );
}

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

variables を使う

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

import { msg, useMessages } from 'gt-next';

const encodedString = msg('こんにちは、{name}さん!', { name: 'Alice' });

export default function TranslateGreeting() {
  const m = useMessages();

  return (
    <p>
      {m(encodedString)}
    </p>
  );
}

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

ICU メッセージ形式の使用

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

import { msg, useMessages } from 'gt-next';

const encodedString = msg('カート内の{count, plural, =0 {商品はありません} =1 {商品は1件です} other {商品は{count}件です}}', { count: 10 });

export default function TranslateGreeting() {
  const m = useMessages();
  return (
    <p>
      {m(encodedString)}
    </p>
  );
}

ICU message format は、variables をフォーマットするための強力な手法です。 くわしくは、ICU message format のドキュメントをご覧ください。


注意事項

  • msg 関数は、翻訳対象として文字列をマークする関数です。
  • msg でマークされた文字列の翻訳は、(開発時を除き)実行時ではなくビルド時に行われます。

次のステップ

  • 文字列の翻訳には useMessages を参照してください。
  • 非同期サーバーサイドコンポーネントで文字列を翻訳するには getMessages を参照してください。

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