props(プロパティ)

コンポーネントを部品として使えるようにするには、外から値を渡せるようにする必要があります。この「外から渡す値」を Reactでは props(プロパティの略)と呼びます。書き方は以下のとおりです。

function コンポーネント名({ プロパティ名1, プロパティ名2 }: { プロパティ名1: 型; プロパティ名2: 型 }) {
  return (
    // props を使ったJSX
  );
}

コンポーネントの引数として、propsをオブジェクトで受け取ります。TypeScriptを使う場合は、そのオブジェクトの型も一緒に書きます。

1. propsによる値の受け渡し

次のコードは、name と age をpropsで受け取る UserProfile コンポーネントを作り、App から2回呼び出す例です。src/App.tsx を以下のコードに書き換えます。

function UserProfile({ name, age }: { name: string; age: number }) {
  return (
    <div>
      <h2>{name}</h2>
      <p>年齢: {age}歳</p>
    </div>
  );
}

export default function App() {
  return (
    <div>
      <UserProfile name="田中太郎" age={30} />
      <UserProfile name="鈴木花子" age={25} />
    </div>
  );
}

保存すると、ブラウザが自動的にリロードされ、以下の表示に切り替わります。

田中太郎
年齢: 30歳
鈴木花子
年齢: 25歳

2人分のプロフィールがそれぞれのpropsに応じて表示されれば、propsによる値の受け渡しが動作しています。

コードを解説します。

function UserProfile({ name, age }: { name: string; age: number }) {

UserProfile コンポーネントの引数として、name と age を持つオブジェクトを分割代入で受け取っています。型として { name: string; age: number } を指定することで、呼び出し側が違う型の値を渡そうとしたときにTypeScriptがコンパイル時にエラーを検出してくれます。

<UserProfile name="田中太郎" age={30} />
<UserProfile name="鈴木花子" age={25} />

UserProfile を呼び出すときに、name="田中太郎" のようにHTMLの属性と同じ形でpropsを渡します。文字列はダブルクォートで、数値や変数はJSX式({})で囲んで渡す点に注意します。

2. interfaceによるprops型の切り出し

propsが増えてくると、引数の型部分が長くなって読みづらくなります。前章のTypeScriptで扱った interface を使って、propsの型を別途宣言しておくのが一般的です。書き方は以下のとおりです。

interface コンポーネント名Props {
  プロパティ名: 型;
  // ...
}

function コンポーネント名({ プロパティ名 }: コンポーネント名Props) {
  // 処理
}

次のコードは、先ほどの UserProfile を interfaceで型付けし直した例です。src/App.tsx を以下のコードに書き換えます。

interface UserProfileProps {
  name: string;
  age: number;
  email?: string;
}

function UserProfile({ name, age, email }: UserProfileProps) {
  return (
    <div>
      <h2>{name}</h2>
      <p>年齢: {age}歳</p>
      {email && <p>メール: {email}</p>}
    </div>
  );
}

export default function App() {
  return (
    <div>
      <UserProfile name="田中太郎" age={30} email="tanaka@example.com" />
      <UserProfile name="鈴木花子" age={25} />
    </div>
  );
}

保存すると、ブラウザが自動的にリロードされ、以下の表示に切り替わります。

田中太郎
年齢: 30歳
メール: tanaka@example.com
鈴木花子
年齢: 25歳

email が指定された1人目にはメール行が表示され、email を渡していない2人目には表示されなければ、オプショナルなpropsが動作しています。

コードを解説します。

interface UserProfileProps {
  name: string;
  age: number;
  email?: string;
}

propsの型を UserProfileProps として切り出しています。email?: string の ? はオプショナルプロパティで、渡さなくてもよいpropsを表します。コンポーネント名に Props を付けた命名がReactでの慣例です。

{email && <p>メール: {email}</p>}

JSX内では条件付き描画も {} の中の式で書けます。email && <p>...</p> は「email が空でなければ <p> を描画する」というJavaScriptの短絡評価をそのまま利用した書き方です。

3. childrenによる子要素の受け取り

親コンポーネントから渡される「タグの間に挟まれた子要素」は、children という特別なpropsで受け取れます。共通の枠(カード・モーダルなど)を作って、中身を呼び出し側から差し込みたい場面で使います。書き方は以下のとおりです。

function コンポーネント名({ children }: { children: React.ReactNode }) {
  return (
    // 外枠のJSX。{children} を差し込みたい位置に置く
  );
}

次のコードは、共通の枠を持つ Card コンポーネントを作り、その中に別の内容を差し込む例です。src/App.tsx を以下のコードに書き換えます。

function Card({ children }: { children: React.ReactNode }) {
  return (
    <div style={{ border: "1px solid #ddd", padding: "1rem", margin: "0.5rem 0" }}>
      {children}
    </div>
  );
}

export default function App() {
  return (
    <div>
      <Card>
        <h2>お知らせ</h2>
        <p>本日のメンテナンス予定はありません。</p>
      </Card>
      <Card>
        <h2>更新履歴</h2>
        <p>v1.2.0 をリリースしました。</p>
      </Card>
    </div>
  );
}

保存すると、ブラウザが自動的にリロードされ、以下のように枠付きのカードが2つ表示されます。

(枠付きカード内に「お知らせ」の見出しと本文)
(枠付きカード内に「更新履歴」の見出しと本文)

灰色の枠と余白を持つカードが2つ並び、それぞれ違う中身が表示されていれば、children による子要素の受け取りが動作しています。

コードを解説します。

function Card({ children }: { children: React.ReactNode }) {

children は特別な名前のpropsで、呼び出し側で <Card>...</Card> のタグに挟まれた要素がすべてここに渡されます。型は React.ReactNode で、JSX要素・文字列・数値・配列などJSXとして描画できるあらゆる値を受け入れます。

<Card>
  <h2>お知らせ</h2>
  <p>本日のメンテナンス予定はありません。</p>
</Card>

<Card>...</Card> のタグの間に書いた要素が、そのまま Card コンポーネントの children として渡されます。この仕組みにより、「外枠」と「中身」を別々のコンポーネントに切り出して組み合わせられます。