ph

ph は、メッセージのプレースホルダーに明示的な名前を付けます。 プロパティアクセス、関数呼び出し、その他の複雑な式が {0} のような数値プレースホルダーになるのを避けたい場合に使います。

キーは翻訳者にとって意味のあるプレースホルダー名になり、値はランタイムで評価される元の式として保持されます。

フレームワークに依存しない Lingui の意味論については、 公式の ph リファレンスを参照してください。

ソース

Demo.svelteカタログ

<p>{$t`Hello ${ph({ username: user.profile.displayName })}`}</p>
<p><Trans>Welcome {ph({ username: user.profile.displayName })}!</Trans></p>

#: src/demos/macros/ph/Demo.svelte
msgid "Hello {username}"
msgstr "Hello {username}"

#: src/demos/macros/ph/Demo.svelte
msgid "Welcome {username}!"
msgstr "Welcome {username}!"

結果

プレビュー変換されたSvelteコンパイルされたカタログ

Hello Lingui

Welcome Lingui!

<p>{$__l4s_translate(
/** i18n */
{
  id: "MsjnH4",
  values: {
    username: user.profile.displayName
  }
})}</p>
<p><L4sRuntimeTrans {.../** i18n */
{
  id: "pNCIOi",
  values: {
    username: user.profile.displayName
  }
}} /></p>

/*eslint-disable*/
import type { Messages } from "@lingui/core";
export const messages = JSON.parse(
  "{\"MsjnH4\":[\"Hello \",[\"username\"]],\"pNCIOi\":[\"Welcome \",[\"username\"],\"!\"]}",
) as Messages;

ロケール

ENJA

名前

使い方

Svelte

<script lang="ts">
  import { ph, t, Trans } from "lingui-for-svelte/macro";

  let user = $state({ name: "Ada" });
</script>

<p>{$t`Hello ${ph({ username: user.name })}`}</p>
<Trans>Welcome {ph({ username: user.name })}!</Trans>

ph はリアクティブな $t 式またはコンポーネントマクロ内で使います。 意図的に非リアクティブなスクリプトのスナップショットが必要な場合は、t.eager 内でも同じプレースホルダー構文を使えます。

Astro

---
import { ph, t, Trans } from "lingui-for-astro/macro";

const user = { name: "Ada" };
const greeting = t`Hello ${ph({ username: user.name })}`;
---

<p>{greeting}</p>
<Trans>Welcome {ph({ username: user.name })}!</Trans>

Official Lingui

import { ph, t } from "@lingui/core/macro";

const greeting = t`Hello ${ph({ username: getUser().name })}`;

抽出されるメッセージとランタイム値

次のソースを記述した場合:

t`Hello ${ph({ username: user.name })}`;

カタログには意味のある ICU プレースホルダーが抽出されます。

Hello {username}

変換後も、元の式はランタイムの値マッピングに保持されます。

{
  message: "Hello {username}",
  values: {
    username: user.name,
  },
}

ヒント

単純な変数はその名前が自動的に保持されます。 式が複雑な場合や、翻訳者に別の名前を示したほうが分かりやすい場合を除き、t`Hello ${name}` と記述してください。

構文ルール

• ph にはプロパティを1つだけ持つオブジェクトを渡します。
• プロパティのキーが ICU プレースホルダー名になります。
• プロパティの値はランタイムで評価され、その名前で values に格納されます。
• username、startDate、itemCount のように、安定した説明的な名前を使います。

ph が向いている場面

• プロパティアクセスや関数呼び出しがそのままでは {0} になる
• プレースホルダーが表す内容を翻訳者に伝えたい
• 安定したプレースホルダー名によってカタログの変更やレビューを追いやすくしたい