Reactで、配列のstateに追加・削除・並べ替えをする方法

​​React​JavaScript,TypeScript,useState

React の配列の state に push() で項目を足し、同じ配列を setItems に渡しても、画面は変わりません。追加・削除・並べ替えのどれも、元の配列は書き換えずに、新しい配列を作って渡すと画面に反映されます。ToDo リストや買い物リスト、カートの商品一覧のように、一覧に項目を足したり消したり、順番を入れ替えたりする画面で使う書き方です。

補足

検証環境は Ubuntu 24.04、Node.js 22.23.4、React 19.3.1(開発用ビルド)、TypeScript 7.0.2、Playwright 1.63.0、Chromium 153 です。画面の操作は Playwright で Chromium を動かして行いました。本番用ビルド、Strict Mode を有効にした状態、Firefox と Safari では試していません。

上下2つの欄で「1件追加」を2回ずつ押す画面。上の「push してから同じ配列を渡す」欄は 2 件のまま変わらない。下の「新しい配列を渡す」欄は 3 件、4 件と増え、増えた数字と行がその瞬間だけピンクになる
上の欄と下の欄で「1件追加」を2回ずつ押す様子。上の欄は画面が変わらず、下の欄は1件ずつ増える

push や sort で書き換えても、画面は変わらない

次のコンポーネントは、元の配列を push() や sort() で書き換えてから、同じ配列を setItems に渡しています。

tsx
import { useState } from 'react';

type Item = { id: number; name: string };

export function MutateBad() {
  const [items, setItems] = useState<Item[]>([
    { id: 1, name: 'りんご' },
    { id: 2, name: 'みかん' },
    { id: 3, name: 'ぶどう' },
  ]);
  const [count, setCount] = useState(0);

  function addWithPush() {
    items.push({ id: items.length + 1, name: 'いちご' });
    setItems(items);
  }
  function sortInPlace() {
    items.sort((a, b) => a.name.localeCompare(b.name, 'ja'));
    setItems(items);
  }

  return (
    <section>
      <button onClick={addWithPush}>push で追加</button>
      <button onClick={sortInPlace}>sort で名前順</button>
      <button onClick={() => setCount((c) => c + 1)}>別の state を更新({count})</button>
      <ul>
        {items.map((item) => (
          <li key={item.id}>{item.name}</li>
        ))}
      </ul>
    </section>
  );
}

検証環境でボタンを順に押したときの、画面の一覧は次のとおりです。

押したボタン 画面の一覧
(最初の表示) りんご、みかん、ぶどう
「push で追加」を2回 りんご、みかん、ぶどう
「別の state を更新」 りんご、みかん、ぶどう、いちご、いちご
「sort で名前順」 りんご、みかん、ぶどう、いちご、いちご
「別の state を更新」 いちご、いちご、ぶどう、みかん、りんご

push で追加しても、sort で並べ替えても、その場では画面が変わりませんでした。関係のない count を更新して再レンダーが起きたときに、それまでの書き換えがまとめて画面に出ています。

useState の公式リファレンスによると、React は前後の state を Object.is で比べ、同じ値なら更新を無視します。push() や sort() は元の配列そのものを書き換えるので、setItems に渡すのは前と同じ配列です。そのため、中身が変わっていても更新されません。

公式の学習ページ「state 内の配列の更新」でも、state の配列は読み取り専用として扱い、push() や sort() のような書き換えるメソッドを使わず、新しい配列を作って渡すように書かれています。

操作ごとに、新しい配列を返す書き方を使う

配列のメソッドには、元の配列を書き換えるものと、書き換えずに新しい配列を返すものがあります。検証環境の Node.js で、['りんご', 'みかん', 'ぶどう'] に対して呼んだときに元の配列が変わったかどうかを確かめると、次のようになりました。

操作 元の配列を書き換える 新しい配列を返す
末尾・先頭に追加 push、unshift [...a, x]、[x, ...a]
途中に挿入・削除 splice toSpliced、filter
並べ替え sort toSorted、[...a].sort()
逆順 reverse toReversed
1か所を置き換え a[i] = x with

toSorted()、toReversed()、toSpliced()、with() は、それぞれ sort()、reverse()、splice()、添字での代入に対応する、新しい配列を返すメソッドです(MDN の Array のページにある「コピーメソッドと変更メソッド」の節)。公式の学習ページはスプレッド構文と slice()、filter() を使った例で説明していますが、これらのメソッドを使うと、同じことを短く書けます。

以下のコードは、検証に使ったコンポーネント ItemList の一部です。

tsx
import { useRef, useState } from 'react';

type Item = { id: number; name: string };

export function ItemList() {
  const [items, setItems] = useState<Item[]>([
    { id: 1, name: 'りんご' },
    { id: 2, name: 'みかん' },
    { id: 3, name: 'ぶどう' },
  ]);
  const nextId = useRef(4);

  function newItem(name: string): Item {
    return { id: nextId.current++, name };
  }
  // ここに、以下の節の関数を書く
}

追加する

末尾や先頭に足すときは、スプレッド構文で新しい配列を作ります。途中に入れるときは、toSpliced(位置, 0, 項目) を使います。2つ目の引数の 0 は「消す数が0個」という意味です。

tsx
function addLast(name: string) {
  const item = newItem(name);
  setItems((prev) => [...prev, item]);
}
function addFirst(name: string) {
  const item = newItem(name);
  setItems((prev) => [item, ...prev]);
}
function insertAt(index: number, name: string) {
  const item = newItem(name);
  setItems((prev) => prev.toSpliced(index, 0, item));
}

検証環境で、りんご・みかん・ぶどうの一覧に「末尾に追加」「先頭に追加」「2番目に挿入」を順に押すと、一覧は「もも、なし、りんご、みかん、ぶどう、いちご」になりました。

削除する

削除は、消したい項目だけを除いた配列を filter() で作ります。添字ではなく id で比べると、並べ替えたあとでも狙った項目を消せます。

tsx
function remove(id: number) {
  setItems((prev) => prev.filter((item) => item.id !== id));
}

上の一覧で「みかん」の行の「削除」を押すと、「もも、なし、りんご、ぶどう、いちご」になりました。

並べ替える

名前順にするときは toSorted()、逆順にするときは toReversed() を使います。どちらも元の配列はそのままで、並べ替えた新しい配列を返します。

tsx
function sortByName() {
  setItems((prev) => prev.toSorted((a, b) => a.name.localeCompare(b.name, 'ja')));
}
function reverse() {
  setItems((prev) => prev.toReversed());
}

1行ずつ上下に動かすボタンは、with() で2か所を入れ替えて作れます。

tsx
function move(index: number, offset: -1 | 1) {
  setItems((prev) => {
    const to = index + offset;
    if (to < 0 || to >= prev.length) return prev;
    return prev.with(index, prev[to]).with(to, prev[index]);
  });
}

with() は、範囲の外の位置を指定すると RangeError を投げます(MDN の with() のページ)。検証環境でも ['a'].with(5, 'x') は RangeError になったので、先頭の行の「上へ」や最後の行の「下へ」では、何もせずに prev をそのまま返しています。

検証環境で、削除のあとの一覧に「名前順」を押すと「いちご、なし、ぶどう、もも、りんご」、続けて「逆順」を押すと「りんご、もも、ぶどう、なし、いちご」になりました。そこから「ぶどう」を上へ、「りんご」を下へ動かすと「ぶどう、りんご、もも、なし、いちご」になり、先頭の行で「上へ」を押しても順番は変わりませんでした。

1回の操作で続けて更新するときは、関数を渡す

ここまでのコードでは、setItems に配列ではなく、前の state を受け取る関数(更新用関数)を渡しています。1回のクリックで setItems を2回呼ぶと、配列を渡す書き方との違いが出ます。検証では、文字列の配列の state を2つ用意して比べました。

tsx
const [items, setItems] = useState<string[]>(['りんご']);
const [items2, setItems2] = useState<string[]>(['りんご']);

function addTwoWithValue() {
  setItems([...items, 'いちご']);
  setItems([...items, 'もも']);
}
function addTwoWithUpdater() {
  setItems2((prev) => [...prev, 'いちご']);
  setItems2((prev) => [...prev, 'もも']);
}

検証環境で、どちらも ['りんご'] から始めて押すと、配列を渡した addTwoWithValue は「りんご、もも」になり、「いちご」が入りませんでした。2回とも、クリックした時点の items をもとに配列を作ったためです。関数を渡した addTwoWithUpdater は「りんご、いちご、もも」になりました。公式リファレンスの、前の state に基づいて更新する例と同じ動きです。

ポイント

新しい id を作る nextId.current++ は、更新用関数の外に置いています。公式リファレンスによると、更新用関数は純粋でなければなりません。開発時に Strict Mode を有効にしていると、更新用関数は2回呼ばれます。

TypeScript で toSorted などが型エラーになるとき

toSorted()、toReversed()、toSpliced()、with() は ES2023 で入ったメソッドです。tsconfig.json の lib が ES2022 以前だと、型チェックで止まります。検証環境で target と lib を ES2022(lib は ["ES2022", "DOM"])にすると、次のようなエラーが出ました。6件のうち2件を抜き出しています。行番号は検証に使ったファイルでの位置で、記事に載せたコードの行とは一致しません。

text
src/ItemList.tsx(30,29): error TS2550: Property 'toSpliced' does not exist on type 'Item[]'. Do you need to change your target library? Try changing the 'lib' compiler option to 'es2023' or later.
src/ItemList.tsx(40,29): error TS2550: Property 'toSorted' does not exist on type 'Item[]'. Do you need to change your target library? Try changing the 'lib' compiler option to 'es2023' or later.

toReversed と with も同じ TS2550 のエラーになりました。残りの2件は、toSorted が型の上で存在しないため、比較関数の引数 a と b に型が付かず、暗黙の any になったという TS7006 のエラーです。target と lib を ES2023(lib は ["ES2023", "DOM"])にすると、エラーなく通りました。lib を変えられないときは、[...prev].sort() のように、スプレッド構文でコピーしてから書き換えるメソッドを使います。コピーした配列は state とは別の配列なので、sort() で並べ替えても state は変わりません。

​Posted by 86