Reactで、propsのデフォルト値を決める方法

​​React​TypeScript,useEffect

React の関数コンポーネントでは、props の分割代入に size = 14 のように書くと、その props が省略されたときの値(デフォルト値)を決められます。ボタンやバッジの色・大きさのように、「指定がなければこの見た目」という部品を作るときの書き方です。ただし、注意することが3つあります。null を渡すと、既定値は使われません。React 19 では、関数コンポーネントの defaultProps が無視されます。配列やオブジェクトを既定値にするときは、コンポーネントの外で作っておく必要があります。

補足

検証環境は Ubuntu 24.04、Node.js 22.23.4 です。使ったのは react / react-dom 19.3.1、@types/react 19.3.0、TypeScript 7.0.2、esbuild 0.28.2 です。.tsx を tsc で型チェックしてから esbuild で開発用ビルドにし、表示の確認は react-dom/server の renderToStaticMarkup で HTML にして行いました。エフェクトの確認は、Playwright 1.63.0 で Chromium 153 を動かして行いました。本番用ビルド、React 18 以前、Firefox と Safari では試していません。

分割代入の「= 値」で、省略されたときの値を書く

公式ドキュメントの「props のデフォルト値を指定する」の節にあるとおり、分割代入の中で、props の名前の直後に = と値を書きます。TypeScript では、省略できる props に ? を付けておきます。

tsx
type BadgeProps = {
  label: string;
  color?: 'gray' | 'blue' | 'pink';
  size?: number;
};

// color と size は省略できる。省略したときの値を、分割代入の = のあとに書く
export function Badge({ label, color = 'gray', size = 14 }: BadgeProps) {
  return (
    <span data-color={color} style={{ fontSize: size }}>
      {label}
    </span>
  );
}

渡し方を変えて HTML にした結果です。

text
<Badge label="新着" />
  → <span data-color="gray" style="font-size:14px">新着</span>
<Badge label="新着" color="pink" size={20} />
  → <span data-color="pink" style="font-size:20px">新着</span>
<Badge label="新着" size={undefined} />
  → <span data-color="gray" style="font-size:14px">新着</span>
<Badge label="新着" size={0} />
  → <span data-color="gray" style="font-size:0">新着</span>

省略したときと、size={undefined} を渡したときは、どちらも 14 になりました。size={0} は 0 のままです。既定値が使われるのは、値が undefined のときだけです。

null を渡すと、既定値は使われない

同じ節には、size={null} や size={0} を渡したときは既定値が使われない、とも書かれています。API から受け取った値をそのまま props に渡す場合など、型に null が含まれるときは気をつけます。

tsx
type NullableBadgeProps = {
  label: string;
  // API から受け取った値をそのまま渡すと、null が来ることがある
  size?: number | null;
};

export function NullableBadge({ label, size = 14 }: NullableBadgeProps) {
  return <span data-size={String(size)}>{label}</span>;
}

<NullableBadge label="新着" size={null} /> を HTML にすると、<span data-size="null">新着</span> になりました。size は 14 ではなく null のままです。

null のときも既定値にしたいなら、分割代入ではなく、??(ヌル値合体演算子)で置き換えます。MDN の ?? の説明にあるとおり、?? は左側が null か undefined のときだけ右側の値を使います。

tsx
export function NullableBadgeFixed({ label, size }: NullableBadgeProps) {
  const fontSize = size ?? 14;
  return <span data-size={String(fontSize)}>{label}</span>;
}

size={null} を渡すと data-size="14"、size={0} を渡すと data-size="0" になりました。同じところを size || 14 と書くと、size={0} でも data-size="14" になりました。同じ MDN の説明にあるとおり、|| は 0 や空文字のような偽値(falsy な値)も置き換えてしまうので、0 に意味がある数値の props には ?? を使います。

TypeScript では、既定値を書いた props から undefined が消える

size?: number と書いた props は、コンポーネントの中では number | undefined 型です。分割代入で既定値を書くと、size は number 型として扱えます。型チェックを試すために、次の2つを書きました。

tsx
// 既定値を書いた変数の型は、undefined を含まない
export function SizeType({ size = 14 }: { size?: number }) {
  const n: number = size;
  return <span>{n}</span>;
}
export function SizeTypeNoDefault({ size }: { size?: number }) {
  const n: number = size;
  return <span>{n}</span>;
}

tsc では、既定値のない SizeTypeNoDefault の行だけがエラーになりました(出力は、この行のエラーだけを、ファイル名と行番号を省いて写しています)。

text
error TS2322: Type 'number | undefined' is not assignable to type 'number'.
  Type 'undefined' is not assignable to type 'number'.

呼び出す側では、size?: number の props に null を渡すと、Type 'null' is not assignable to type 'number | undefined'. のエラーになりました。型で null を許していなければ、前の節のように既定値が使われない値が渡ることを、型チェックで止められます。

React 19 の関数コンポーネントでは defaultProps が無視される

React 18 までは、関数コンポーネントに defaultProps を付けて既定値を決める書き方もありました。React 19 のアップグレードガイドでは、関数コンポーネントの defaultProps は削除され、代わりに ES6 のデフォルト引数(この記事の分割代入の書き方)を使うように書かれています。

tsx
type GreetingProps = { text?: string };

// React 18 までの書き方:関数コンポーネントに defaultProps を付ける
export function Greeting({ text }: GreetingProps) {
  return <h1>{String(text)}</h1>;
}
Greeting.defaultProps = { text: 'こんにちは' };

React 19.3.1 で <Greeting /> を HTML にすると、<h1>undefined</h1> になりました。defaultProps の値は使われていません。サーバー用の描画関数で HTML にしたときは、開発用ビルドでも警告は出ず、tsc の型チェックでもエラーになりませんでした。

注意

React 19 に上げるときは、関数コンポーネントに付けた defaultProps を探して、分割代入の既定値に書き換えます。

クラスコンポーネントの static defaultProps は、同じガイドにあるとおり React 19 でも使えます。Component の公式リファレンスにある static defaultProps の説明でも、undefined と省略された props に使われ、null には使われないと書かれています。

tsx
import { Component } from 'react';

export class ClassGreeting extends Component<GreetingProps> {
  static defaultProps = { text: 'こんにちは' };
  render() {
    return <h1>{String(this.props.text)}</h1>;
  }
}

<ClassGreeting /> と <ClassGreeting text={undefined} /> は、どちらも <h1>こんにちは</h1> になりました。

配列やオブジェクトの既定値は、コンポーネントの外で作る

tags = [] のように配列やオブジェクトを既定値に書くと、その配列は描画のたびに新しく作られます。値が同じ空の配列でも、前の描画のものとは別の配列です。useEffect の公式リファレンスにあるとおり、React は依存配列の値を Object.is で前の値と比べるので、新しい配列は「変わった」と判定されます。そのため、これを依存配列に入れると、描画のたびにエフェクトが動きます。

tags が変わったら検索し直す、という想定で、エフェクトが動いた回数を数える部品を2つ作りました。1つは既定値に [] をそのまま書き、もう1つは、コンポーネントの外で1回だけ作った NO_TAGS を既定値にしています。

tsx
import { useEffect, useRef } from 'react';
import { log } from './log';

type TagSearchProps = { tags?: string[] };

// tags が変わったら検索し直す、という想定のエフェクト。
// 実行回数は、検証用に画面の文字へ直接書き込む(state は使わない)
function useSearchEffect(name: string, tags: string[]) {
  const runs = useRef(0);
  const out = useRef<HTMLParagraphElement>(null);
  useEffect(() => {
    runs.current += 1;
    log(`${name} のエフェクトが動いた(${runs.current}回目)`);
    if (out.current) out.current.textContent = `エフェクトの実行回数:${runs.current}`;
  }, [tags]);
  return out;
}

export function TagSearchInline({ tags = [] }: TagSearchProps) {
  const out = useSearchEffect('TagSearchInline', tags);
  return <p ref={out} />;
}

const NO_TAGS: string[] = [];

export function TagSearchConst({ tags = NO_TAGS }: TagSearchProps) {
  const out = useSearchEffect('TagSearchConst', tags);
  return <p ref={out} />;
}

log は、記録を配列にためる検証用の関数です。どちらにも tags を渡さずに置き、親コンポーネントの state を更新するボタンを3回押しました。

text
--- App の描画 count=0
  TagSearchInline のエフェクトが動いた(1回目)
  TagSearchConst のエフェクトが動いた(1回目)
--- App の描画 count=1
  TagSearchInline のエフェクトが動いた(2回目)
--- App の描画 count=2
  TagSearchInline のエフェクトが動いた(3回目)
--- App の描画 count=3
  TagSearchInline のエフェクトが動いた(4回目)

tags は一度も変わっていないのに、[] を書いたほうは、親が再レンダーするたびにエフェクトが動きました。NO_TAGS のほうは、最初の1回だけです。

親を再レンダーするボタンを3回押す。押すたびに、上の tags = [] の欄の実行回数が 2、3、4 と増えてピンクになり、下の tags = NO_TAGS の欄は 1 のまま変わらない
親を3回再レンダーしたときの、エフェクトの実行回数(上が [] を既定値に書いた場合、下がコンポーネントの外の定数を使う場合)

エフェクトの中で state を更新していると、もっと困ったことになります。エフェクトで setRuns((n) => n + 1) として実行回数を state に入れる書き方に変えると、[] を書いたほうは、state の更新で再レンダーするたびに新しい [] ができ、そのたびにエフェクトがまた動きました。この検証では、ページを開いて1秒後に、エフェクトが 16178 回動いていました。回数は実行のたびに変わります。コンソールには次のエラーが出ていました(先頭の1行だけを写しています)。

text
Maximum update depth exceeded. This can happen when a component calls setState inside useEffect, but useEffect either doesn't have a dependency array, or one of the dependencies changes on every render.

NO_TAGS を使ったほうは、同じ書き方でもエフェクトは1回だけでした。配列やオブジェクトを既定値にするときは、上の NO_TAGS のように、コンポーネントの外で作った定数を使います。

​Posted by 86