Components

Plural

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

概要

文の数に応じた言い回しを処理するために <Plural> コンポーネントを使用します。 次の文の違いを考えてみてください: "You have one item." と "You have two items."

英語では、アイテムの数に応じて2種類の文を用意する必要があります。 言語によっては、最大で6種類まで用意する必要があります。

const count = 1;
<Plural n={count}
  singular={アイテムが1つあります。}
  plural={アイテムがあります。}
/>

リファレンス

Props

Prop

Type

[key]: string の構文は、複数形ルールの分岐を表す任意のキーを示します。 たとえば、singularplural といった分岐をパラメータとして追加できます。

説明

Prop 名称説明
n複数形を判定するための数値。複数形ルールに必須です。
children一致する複数形の分岐がない場合に表示するフォールバックコンテンツ。
localesフォーマットに用いるロケールを指定するための任意の対応ロケール。指定しない場合はユーザーのデフォルトロケールが使用されます。対応ロケールの指定方法についてはこちらを参照してください。
[key]: string複数形の分岐を表します。利用可能な分岐はロケールによって異なります。

戻り値

JSX.Elementn の値に対応する複数形の内容、またはフォールバックの内容を含みます。

例外

n が指定されていない、または有効な数値でない場合は Error をスローします。


どのフォームを追加すればよいですか?

対象言語に応じた複数形のフォームのみを使用してください。

使用できるフォームは次のとおりです: "singular", "plural", "dual", "zero", "one", "two", "few", "many", "other"

  • "en-US" を使用する開発者は、"singular""plural" の2種類のみを使用してください。
  • "zh-CN" を使用する開発者は、"other" のみを使用してください。

各フォームの詳細はこちらをご覧ください。


基本的な使い方

複数形ルールを扱うには <Plural> コンポーネントを使用します。

BasicExample.jsx
import { Plural } from 'gt-react';

export default function ItemCount({ count }) {
  return (
    <Plural n={count} 
      singular={アイテムが1個あります。}
      plural={アイテムが複数あります。}
    />
  );
}

フォールバック

n に渡した value がどの分岐にも一致しない場合に備えて、フォールバックを指定できます。

FallbackExample.jsx
import { Plural } from 'gt-react';

export default function ItemCount({ count }) {
  return (
    <Plural n={count}
      singular={アイテムが1個あります。}
    >
      アイテムが複数あります。 // [!code highlight]
    </Plural>
  );
}

複数形の翻訳

翻訳するには、<T> コンポーネントを追加するだけです。

PluralExample.jsx
import { T, Plural } from 'gt-react';

export default function ItemCount({ count }) {
  return (
  <T id="itemCount">
    <Plural n={count}
      singular={アイテムが1つあります。} 
      plural={アイテムがあります。} 
    />
  );
}

variables の追加

複数形の文に variables を追加したい場合はどうすればよいですか?

PluralExample.jsx
import { T, Plural, Num } from 'gt-react';

export default function ItemCount({ count }) {
  return (
    <Plural n={count}
      singular={<Num>{count}</Num>個のアイテムがあります。} 
      plural={<Num>{count}</Num>個のアイテムがあります。} 
    />
  );
}

<T> コンポーネント内では、すべての動的コンテンツを <Currency><DateTime><Num>、または <Var> で包んでください。

<T id="itemCount">
  <Plural n={count}
    singular={<Num>{count}</Num>個のアイテムがあります。} 
    plural={<Num>{count}</Num>個のアイテムがあります。} 
  />
</T>

注意事項

  • <Plural> コンポーネントは複数形ルールの処理に使用します。
  • 利用可能な複数形の分岐(例: one、other、few、many)は locale によって異なり、Unicode CLDR の複数形ルールに従います。

次のステップ

  • さらに多くの例は、ブランチコンポーネントのリファレンスドキュメントをこちらでご確認ください。
  • より高度な使い方として、<Plural><Currency><DateTime><Num><Var> といった変数コンポーネントと組み合わせて使用してください。変数コンポーネントの詳細はこちらをご覧ください。

このガイドはどうでしたか?

Plural