Components

Branch

<Branch> 组件的 API 参考

概览

<Branch> 组件可在翻译中加入条件逻辑。

const status = 'active';
<Branch branch={status}
    active={<p>该用户为活跃状态。</p>}
    inactive={<p>该用户为非活跃状态。</p>}
/>

将一个值传递给 branch 参数,它会根据你提供的键匹配相应的输出值。

参考资料

Props

Prop

Type

[key]: string 语法表示用于各个可能分支的任意键。 例如,可以将 activeinactive 等分支作为参数添加。

PropDescription
branch要渲染的分支名称。
children当未找到匹配分支时渲染的回退内容。
[key]: string表示针对给定分支值的可选内容分支。每个键对应一个分支,其值为要渲染的内容。

返回值

JSX.Element,包含与指定分支对应的内容,或备用内容。

抛出

如果未提供 branch 属性或其值无效,则抛出 Error

示例

基本用法

<Branch> 需要针对 branch prop 的每个可能取值生成不同的输出。

在本示例中,使用 user.hairColor 的值来决定输出。 我们定义了 blackbrownblonde 这几个 prop,以匹配 user.hairColor 的可能取值。

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

export default function HairColor({ user }) {
  return (
    <Branch branch={user.hairColor} 
      black={<p>他们的头发很深。</p>}
      brown="他们的发色属中间色调。" // (如果你愿意,也可以传入字符串)
      blonde={<p>他们的头发很浅。</p>}
    />
  );
}

备用内容

如果没有任何 prop 与传递给 branch 的值匹配,children 将始终作为备用内容使用。

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

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-react';

export default function HairColor({ user }) {
  return (
    <T id="example"> // [!code highlight]
      <Branch branch={user.hairColor}
        black={<p>他们的头发是深色。</p>}
        brown={<p>他们的头发是棕色。</p>}
        blonde={<p>他们的头发是浅色。</p>}
      >
        <p>他们的发色未知。</p>
      </Branch>
    </T> 
  );
}

添加变量

如果需要在分支中渲染动态值,请务必将它们包裹在 <Currency><DateTime><Num><Var> 组件中。

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

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> // [!code highlight]
      </Branch>
    </T>
  );
}

注意事项

  • 分支的键可以是任意与 branch 属性匹配的字符串值。这种灵活性使 <Branch> 易于适配各种用例。
  • <Branch> 与其他组件搭配使用,例如用于翻译的 <T>,以及用于动态内容的变量组件,以构建丰富且本地化的界面。

后续步骤

这份指南怎么样?

Branch