Components

Branch

<Branch> コンポーネントの APIリファレンス

概要

<Branch> コンポーネントを使うと、翻訳に条件分岐のロジックを追加できます。

const status = 'active';
<Branch branch={status}
    active={<p>ユーザーは有効です。</p>}
    inactive={<p>ユーザーは無効です。</p>}
/>

branch パラメータに value を渡すと、指定したキーに基づいて対応する出力の value が選ばれます。

リファレンス

Props

Prop

Type

[key]: string という構文は、想定されるブランチを表す任意のキーを示します。 たとえば、activeinactive といったブランチをパラメータとして追加できます。

PropDescription
branchレンダリングするブランチの名称。
children一致するブランチが見つからない場合にレンダリングするフォールバックコンテンツ。
[key]: string指定されたブランチの value に対する候補コンテンツを表すブランチ。各キーはブランチに対応し、その値がレンダリングするコンテンツです。

返り値

指定されたブランチに対応するコンテンツ、またはフォールバックコンテンツを含む JSX.Element

スロー

branch プロップが指定されていない、または無効な場合は Error がスローされます。

基本的な使い方

<Branch> は、branch プロップの取り得る各値ごとに異なる出力を用意する必要があります。

この例では、user.hairColor の値を使って出力を決定します。 user.hairColor の可能な値に対応するように、blackbrownblonde というプロップを定義しています。

BranchExample.jsx
import { Branch } from 'gt-next';

export default function HairColor({ user }) {
  return (
    <Branch branch={user.hairColor}
      black={<p>髪は濃い色です。</p>}
      brown="髪は中間的な色です。" // (必要なら文字列を渡せます)
      blonde={<p>髪は明るい色です。</p>}
    />
  );
}

フォールバックコンテンツ

branch に渡された value と一致する prop がない場合、children は常にフォールバックとして使用されます。

BranchExample.jsx
import { Branch } from 'gt-next';

export default function HairColor({ user }) {
  return (
    <Branch branch={user.hairColor}
      black={<p>髪の色は濃いです。</p>}
      brown={<p>髪の色は中間的です。</p>}
      blonde={<p>髪の色は明るいです。</p>}
    >
      <p>髪の色は不明です。</p> // [!code highlight]
    </Branch>
  );
}

<Branch> の翻訳

コンテンツを翻訳するには、<T> コンポーネントで包むだけです。

BranchExample.jsx
import { T, Branch } from 'gt-next';

export default function HairColor({ user }) {
  return (
    <T id="example">
      <Branch branch={user.hairColor}
        black={<p>髪の色は黒です。</p>}
        brown={<p>髪の色は茶色です。</p>}
        blonde={<p>髪の色は金髪です。</p>}
      >
        <p>髪の色は不明です。</p> 
      </Branch>
    </T> 
  );
}

variables の追加

ブランチで動的な value をレンダリングする場合は、必ずそれらを <Currency><DateTime><Num><Var> の各コンポーネントで囲んでください。

BranchExample.jsx
import { Branch, T, Var } from 'gt-next';

export default function HairColor({ user }) {
  return (
    <T id="example">
      <Branch branch={user.hairColor}
        black={<p>髪は濃い色です。</p>}
        brown={<p>髪は中間的な色です。</p>}
        blonde={<p>髪は淡い色です。</p>}
      >
        <p>未対応の髪色: <Var>{user.hairColor}</Var></p>
      </Branch>
    </T>
  );
}

注意事項

  • ブランチのキーには、branch プロップに一致する任意の文字列を使用できます。この柔軟性により、<Branch> を幅広いユースケースに適用しやすくなります。
  • <Branch> を、翻訳用の <T> や動的コンテンツ向けのvariable components など他のコンポーネントと組み合わせて、リッチでローカライズされたインターフェースを構築しましょう。

次のステップ

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