Reactでkeyをスプレッドで渡したときの警告の直し方

​​React​oxlint,TypeScript,Vite,トラブルシュート

React で一覧を描くとき、key を含む props をオブジェクトにまとめて <ItemRow {...props} /> のように渡すと、ブラウザーのコンソールに A props object containing a "key" prop is being spread into JSX と出ます。key だけはオブジェクトに入れず、<ItemRow key={item.id} {...props} /> のように JSX に直接書くと、このメッセージは消えます。

私は検証環境でこのメッセージをわざと出し、コンソールに出た文をそのまま写しました。直したあとに消えること、key を入れたオブジェクトを関数から受け取る場合の直し方、key をスプレッドのあとに書いた場合の扱いも確かめています。

補足

検証環境は Ubuntu 24.04、Node.js 22.23.4 です。npm create vite@latest の react-ts テンプレートで作ったプロジェクト(react / react-dom 19.3.1、Vite 8.3.8、TypeScript 7.0.2、oxlint 1.93.0)で、コンポーネントを StrictMode で囲んで試しました。ページは Chromium 153 を Playwright 1.63.0 で操作して開き、DevTools の画面は、画面ありの Chromium を仮想ディスプレイ(Xvfb)で動かして撮りました。Next.js などのフレームワークや、Chromium 以外のブラウザーでの表示は試していません。

コンソールに出たメッセージ

一覧の1行を ItemRow というコンポーネントにし、map の中で props をオブジェクト(rowProps)にまとめてから渡しました。key もそのオブジェクトに入れています。

ts
export type Item = { id: string; name: string };

export const items: Item[] = [
  { id: 'apple', name: 'りんご' },
  { id: 'banana', name: 'バナナ' },
  { id: 'cherry', name: 'さくらんぼ' },
];
tsx
export type ItemRowProps = { name: string };

export default function ItemRow({ name }: ItemRowProps) {
  return <li>{name}</li>;
}
tsx
import { items } from './items';
import ItemRow from './ItemRow';

// まちがい:key を入れたオブジェクトをスプレッドで渡している
export default function BadSpread() {
  return (
    <ul>
      {items.map((item) => {
        const rowProps = { key: item.id, name: item.name };
        return <ItemRow {...rowProps} />;
      })}
    </ul>
  );
}

開発サーバー(npm run dev と同じ vite)でこのページを開くと、一覧はふつうに表示されました。コンソールには、React DevTools の案内のほかに、次のメッセージが1件だけ赤い行(console.error)で出ました。

text
A props object containing a "key" prop is being spread into JSX:
  let props = {key: someKey, name: ...};
  <ItemRow {...props} />
React keys must be passed directly to JSX without using spread:
  let props = {name: ...};
  <ItemRow key={someKey} {...props} />
DevTools のコンソールに、赤い行で「A props object containing a "key" prop is being spread into JSX:」から始まるメッセージが出ている。上のページには、りんご・バナナ・さくらんぼの一覧が表示されている
key を入れたオブジェクトをスプレッドで渡したページ。一覧は表示され、コンソールに赤い行が1件出た

メッセージの前半は今の書き方、後半は直した書き方の見本です。let props = ... の中には、スプレッドしたオブジェクトのプロパティ名(ここでは name)が、値を ... に置き換えて入ります。<ItemRow ...> の部分には、スプレッドを受け取ったコンポーネントの名前が入ります。map で3件描いていますが、メッセージは1件だけでした。React の JSX ランタイム(react/jsx-dev-runtime)のコードを読むと、同じコンポーネント名と同じプロパティの組み合わせでは、2回目から出さないようになっています。

key をオブジェクトから出して、JSX に直接書く

メッセージの後半のとおり、key はオブジェクトに入れず、JSX に直接書きます。

tsx
import { items } from './items';
import ItemRow from './ItemRow';

// 直したもの:key はオブジェクトに入れず、JSX に直接書く
export default function GoodDirectKey() {
  return (
    <ul>
      {items.map((item) => {
        const rowProps = { name: item.name };
        return <ItemRow key={item.id} {...rowProps} />;
      })}
    </ul>
  );
}

このページを同じ開発サーバーで開くと、コンソールに出たのは React DevTools の案内だけでした。一覧の表示は、直す前と変わりません。

直したページ。上には同じ一覧が表示され、下の DevTools のコンソールには React DevTools の案内だけが出ている
key を JSX に直接書いたページ。赤い行は出ていない

受け取ったオブジェクトに key が入っているときは、分割代入で取り出す

props のオブジェクトを自分で作らず、関数の戻り値として受け取ることもあります。オブジェクトに key が入っていて、その関数には手を入れたくないときは、分割代入で key と残りに分け、key だけを JSX に直接書きます。

tsx
import { items } from './items';
import ItemRow from './ItemRow';

// 受け取ったオブジェクトに key が入っているときは、取り出してから渡す
function toRowProps(item: { id: string; name: string }) {
  return { key: item.id, name: item.name };
}

export default function GoodDestructure() {
  return (
    <ul>
      {items.map((item) => {
        const { key, ...rest } = toRowProps(item);
        return <ItemRow key={key} {...rest} />;
      })}
    </ul>
  );
}

この形でも、メッセージは出ませんでした。rest には key が入っていないので、スプレッドで渡しても警告の対象になりません。

なぜ JSX に直接書く必要があるのか

開発サーバーが変換したあとのコードを見ると、違いが分かります。key をオブジェクトに入れた BadSpread と、JSX に直接書いた GoodDirectKey は、それぞれ次のように変換されていました(どちらも開発用の変換結果から、1行の一部を抜き出したものです)。

js
// BadSpread:key はオブジェクトの中にあり、3つ目の引数は空(void 0)
_jsxDEV(ItemRow, { ...rowProps }, void 0, false, {

// GoodDirectKey:key(item.id)が3つ目の引数として、props とは別に渡る
_jsxDEV(ItemRow, { ...rowProps }, item.id, false, {

JSX に直接書いた key は、props とは別の引数で React に渡ります。スプレッドで渡すと、key が props のオブジェクトにまぎれてしまい、React は要素を作るたびにオブジェクトの中を調べないと key があるか分かりません。React チームが出した createElement の変更についての RFC(提案文書)では、この調べる手間を問題として挙げ、スプレッドで key を渡す書き方を非推奨にすると提案しています。あわせて、当面は props から key を取り出して使い、警告を出すとしています。

検証環境の react 19.3.1 でも、その提案どおりに動いていました。JSX ランタイムのコードでは、スプレッドで渡したオブジェクトに key があれば警告を出したうえで、その値を要素の key として使っています。実際、BadSpread を開いたときには、key がないときに出る Each child in a list should have a unique "key" prop. は出ていません。今の React では一覧の動きは変わりません。ただし同じ RFC には、将来のメジャーバージョンで props から key を取り出すのをやめるとも書かれています。動いているうちに、このメッセージは出た時点で直しておくのが確実です。

なお、公式ドキュメントの key の説明にあるとおり、key は props としてコンポーネントに渡りません。子のコンポーネントの中で id を使いたいときは、公式ドキュメントの <Profile key={id} userId={id} /> の例のように、key とは別の名前の props でも渡します。

HTML の要素にスプレッドしても同じメッセージが出る

コンポーネントではなく <li> に直接スプレッドした場合も、同じメッセージが出ました。

tsx
import { items } from './items';

// HTML の要素にスプレッドした場合
export default function SpreadIntoDom() {
  return (
    <ul>
      {items.map((item) => {
        const liProps = { key: item.id, title: item.name };
        return <li {...liProps}>{item.name}</li>;
      })}
    </ul>
  );
}
text
A props object containing a "key" prop is being spread into JSX:
  let props = {key: someKey, title: ..., children: ...};
  <li {...props} />
React keys must be passed directly to JSX without using spread:
  let props = {title: ..., children: ...};
  <li key={someKey} {...props} />

<ItemRow> の部分が <li> になり、プロパティ名には、タグの間に書いた中身(children)も入りました。直し方は同じで、<li key={item.id} {...liProps}> のように key を JSX に直接書きます。

key はスプレッドより前に書く

<ItemRow {...rowProps} key={item.id} /> のように、key をスプレッドのあとに書いた場合は、メッセージは出ませんでした。ただし、変換後のコードを見ると、この書き方だけは _jsxDEV ではなく _createElement の呼び出しになっていました。

js
// KeyAfterSpread:key をスプレッドのあとに書くと、createElement の呼び出しになる
_createElement(ItemRow, {
  ...rowProps,

この並びでも一覧の表示とコンソールに違いはありませんでしたが、key はスプレッドより前(<ItemRow key={item.id} {...rowProps} />)に書いておくと、GoodDirectKey と同じ変換になります。

oxlint の警告は「key がない」という文になる

テンプレートに入っている lint ツールの oxlint を、設定を変えずに npx oxlint src で実行すると、BadSpread.tsx と SpreadIntoDom.tsx に次の警告が出ました(SpreadIntoDom.tsx の行は省いています)。

text
src/BadSpread.tsx:8:14: warning react(jsx-key): Missing "key" prop for element in iterator. help: Add a "key" prop to the element in the iterator (https://react.dev/learn/rendering-lists#keeping-list-items-in-order-with-key).

key はオブジェクトの中に書いてありますが、oxlint の jsx-key ルールは JSX に直接書いた key だけを見ていて、スプレッドの中までは見ないので、「key がない」という文になります。直し方は同じで、key を JSX に直接書けば、この警告も出なくなりました。TypeScript の型チェック(npx tsc -p tsconfig.app.json --noEmit)では、どのファイルもエラーになりません。

検証した oxlint 1.93.0 では、テンプレートの設定のままだと、key をスプレッドのあとに書いた KeyAfterSpread.tsx には何も出ませんでした。oxlint の jsx-key ルールのソースコードには、この並びを見つける checkKeyMustBeforeSpread というオプションがあります。私はテンプレートの .oxlintrc.json とは別に、次の設定だけを書いた .oxlintrc.key-before-spread.json を作り、-c で指定して実行しました。

json
{
  "$schema": "./node_modules/oxlint/configuration_schema.json",
  "plugins": ["react"],
  "rules": {
    "react/jsx-key": ["warn", { "checkKeyMustBeforeSpread": true }]
  }
}
bash
npx oxlint -c .oxlintrc.key-before-spread.json src

この設定で実行すると、上の2件に加えて、KeyAfterSpread.tsx に次の警告が出ました。

text
src/KeyAfterSpread.tsx:10:39: warning react(jsx-key): "key" prop must be placed before any `{...spread}` help: To avoid conflicting with React's new JSX transform: https://reactjs.org/blog/2020/09/22/introducing-the-new-jsx-transform.html

本番用のビルドでは出ない

npm run build でビルドし、npx vite preview で BadSpread と SpreadIntoDom を開くと、コンソールには何も出ませんでした。一覧はどちらも表示されています。react 19.3.1 のファイルを調べると、このメッセージの文は開発用の react-jsx-dev-runtime.development.js と react-jsx-runtime.development.js には入っていて、本番用の react-jsx-runtime.production.js には入っていません。このメッセージは、開発サーバーでページを開いたときのコンソールで確かめます。

​Posted by 86