ReactのrequestFormResetで送信後に入力欄を空にする方法

​​React​TypeScript,useTransition,フォーム

React 19 の requestFormReset を使うと、onSubmit で送信を扱うフォームでも、送信が終わったところで入力欄を空にできます。<form action={関数}> なら React が自動で空にしますが、onSubmit で e.preventDefault() を呼んで自分で送る書き方では、入力欄はそのまま残ります。コメント欄やチャットの送信フォームで「送信が終わったら入力欄を空にしたい、失敗したときは残したい」という場面に使えます。

私は検証環境で、onSubmit と startTransition で送るフォームを作り、requestFormReset を呼ぶ場所を変えて、送信の直後と返事のあとの入力欄を記録しました。

補足

検証環境は Ubuntu 24.04、Node.js 22.23.4 です。使ったのは react / react-dom 19.3.1、@types/react / @types/react-dom 19.3.0、typescript 7.0.2、esbuild 0.28.2、jsdom 31.0.0 です。.tsx を tsc で型チェックしてから esbuild で変換し、jsdom の上で動かしました。GIF は、同じコンポーネントを Playwright 1.63.0 の Chromium で動かして撮ったものです。サーバーは検証用に作った偽物で、こちらが合図するまで返事をせず、成功か失敗かもこちらで決めます。Server Functions や、フォームのライブラリと組み合わせる書き方は試していません。

onSubmit で送ると、入力欄は残ったままになる

<form> のリファレンスの、action で送信を扱う説明にあるとおり、action に渡した関数が成功で終わると、React はフォームの中の制御されていない入力欄(value を渡していない入力欄)をリセットします。一方、同じリファレンスの、リセットを自分で決める方法の説明には、onSubmit で e.preventDefault() を呼び、startTransition の中で送信すれば、action が動かないので React はリセットしない、とあります。

まず、リセットのことを何も書かずに、onSubmit と startTransition で送るフォームを作りました。saveMessage は、偽のサーバーに送る関数です。成功すると true、失敗すると false を返します。

tsx
import { useTransition, type FormEvent } from 'react';
import { saveMessage } from './server';

export function NoReset() {
  const [isPending, startTransition] = useTransition();

  function handleSubmit(e: FormEvent<HTMLFormElement>) {
    e.preventDefault();
    const formData = new FormData(e.currentTarget);
    startTransition(async () => {
      await saveMessage(String(formData.get('message')));
    });
  }

  return (
    <form onSubmit={handleSubmit}>
      <input name="message" />
      <button type="submit" disabled={isPending}>{isPending ? '送信中…' : '送信'}</button>
    </form>
  );
}

入力欄に「こんにちは」と入れて「送信」を押し、サーバーの返事の前とあとで、入力欄とボタンの状態を記録しました。

text
$ node run.mjs NoReset
  送信前: message="こんにちは" ボタン=["送信"] | サーバー=[]
  送信を押した直後: message="こんにちは" ボタン=["送信中…"(押せない)] | サーバー=[受付:こんにちは]
  成功の返事のあと: message="こんにちは" ボタン=["送信"] | サーバー=[受付:こんにちは → 保存:こんにちは]

サーバーが保存したあとも、入力欄には「こんにちは」が残りました。

startTransition の中で requestFormReset を呼ぶ

requestFormReset は react-dom から読み込み、<form> の DOM 要素を渡して呼びます。@types/react-dom 19.3.0 の型は requestFormReset(form: HTMLFormElement): void です。

requestFormReset を追加した React の Pull Requestの説明によると、この関数は、いまの Transition が終わったときにフォームのリセットが起きるよう予約します。中身は、<form> の action で送ったときに React が自動で呼んでいるものと同じで、リセットされるのは制御されていない入力欄だけです。

次のコードでは、startTransition の中の最初に requestFormReset(form) を呼びました。比べるために、value と onChange を渡した入力欄(制御された入力欄)name も置いています。

tsx
import { useState, useTransition, type FormEvent } from 'react';
import { requestFormReset } from 'react-dom';
import { saveMessage } from './server';

export function WithRequestReset() {
  const [isPending, startTransition] = useTransition();
  const [name, setName] = useState('');

  function handleSubmit(e: FormEvent<HTMLFormElement>) {
    e.preventDefault();
    const form = e.currentTarget;
    const formData = new FormData(form);
    startTransition(async () => {
      requestFormReset(form);
      await saveMessage(String(formData.get('message')));
    });
  }

  return (
    <form onSubmit={handleSubmit}>
      <input name="message" />
      <input name="name" value={name} onChange={(e) => setName(e.target.value)} />
      <button type="submit" disabled={isPending}>{isPending ? '送信中…' : '送信'}</button>
    </form>
  );
}
text
$ node run.mjs WithRequestReset
  送信前: message="こんにちは" name="ねこ" ボタン=["送信"] | サーバー=[]
  送信を押した直後: message="こんにちは" name="ねこ" ボタン=["送信中…"(押せない)] | サーバー=[受付:こんにちは]
  成功の返事のあと: message="" name="ねこ" ボタン=["送信"] | サーバー=[受付:こんにちは → 保存:こんにちは]

requestFormReset は送信の直後に呼んでいますが、返事を待っている間、入力欄は「こんにちは」のままでした。返事が来て Transition が終わったところで、message が空になりました。制御された name は「ねこ」のまま残っています。値を state が持っているためです。

form.reset() との違いは、空にするタイミング

DOM の form.reset() でも入力欄は空になります。<form> のリファレンスの、リセットを自分で決める方法の説明では、reset() はその場ですぐにリセットし、Action や Transition の一部としてリセットを予約したいときは requestFormReset を使う、と書き分けています。

onSubmit の中で、送信の前に form.reset() を呼んだ場合の結果です(コードは、上の NoReset の startTransition の前に form.reset() を足しただけです)。

text
$ node run.mjs ImmediateReset
  送信前: message="こんにちは" ボタン=["送信"] | サーバー=[]
  送信を押した直後: message="" ボタン=["送信中…"(押せない)] | サーバー=[受付:こんにちは]
  成功の返事のあと: message="" ボタン=["送信"] | サーバー=[受付:こんにちは → 保存:こんにちは]

押した直後、サーバーの返事を待つ前に入力欄が空になりました。この書き方では、送信が失敗しても、入力した文はもう消えています。

成功したときだけ空にするには、await のあとをもう一度 startTransition で包む

失敗したときは入力欄を残したいなら、返事を待ってから requestFormReset を呼びます。最初は、await のあとでそのまま呼んでみました。

tsx
startTransition(async () => {
  const ok = await saveMessage(String(formData.get('message')));
  // await のあとで、成功したときだけリセットを頼む
  if (ok) requestFormReset(form);
});
text
$ node run.mjs AfterAwait
  送信前: message="こんにちは" ボタン=["送信"] | サーバー=[]
  送信を押した直後: message="こんにちは" ボタン=["送信中…"(押せない)] | サーバー=[受付:こんにちは]
  [console.error] requestFormReset was called outside a transition or action. To fix, move to an action, or wrap with startTransition.
  成功の返事のあと: message="" ボタン=["送信"] | サーバー=[受付:こんにちは → 保存:こんにちは]

入力欄は空になりましたが、検証環境の React が「requestFormReset が Transition や Action の外で呼ばれた。Action の中に移すか、startTransition で包む」という内容のエラーをコンソールに出しました。startTransition の中に書いたのに、外と判定されています。

useTransition のリファレンスの、startTransition の注意事項には、await のあとの state の更新は、もう一度 startTransition で包まないと Transition として扱われない、とあります。いまの React の既知の制限です。そこで、await のあとの部分をもう一度 startTransition で包み、その中で requestFormReset を呼んでみました。エラーの表示も、そこで更新しています。

tsx
import { useState, useTransition, type FormEvent } from 'react';
import { requestFormReset } from 'react-dom';
import { saveMessage } from './server';

export function SuccessOnly() {
  const [isPending, startTransition] = useTransition();
  const [error, setError] = useState('');

  function handleSubmit(e: FormEvent<HTMLFormElement>) {
    e.preventDefault();
    const form = e.currentTarget;
    const formData = new FormData(form);
    startTransition(async () => {
      const ok = await saveMessage(String(formData.get('message')));
      startTransition(() => {
        if (ok) {
          setError('');
          requestFormReset(form);
        } else {
          setError('送信できませんでした');
        }
      });
    });
  }

  return (
    <form onSubmit={handleSubmit}>
      <input name="message" />
      <button type="submit" disabled={isPending}>{isPending ? '送信中…' : '送信'}</button>
      {error && <p role="alert">{error}</p>}
    </form>
  );
}

1回目はサーバーに失敗を返させ、2回目は成功を返させました。

text
$ node run.mjs SuccessOnly
  送信前: message="こんにちは" ボタン=["送信"] | サーバー=[]
  送信を押した直後: message="こんにちは" ボタン=["送信中…"(押せない)] | サーバー=[受付:こんにちは]
  失敗の返事のあと: message="こんにちは" ボタン=["送信"] | 送信できませんでした | サーバー=[受付:こんにちは → 失敗:こんにちは]
  もう一度送信を押した直後: message="こんにちは" ボタン=["送信中…"(押せない)] | 送信できませんでした | サーバー=[受付:こんにちは → 失敗:こんにちは → 受付:こんにちは]
  成功の返事のあと: message="" ボタン=["送信"] | サーバー=[受付:こんにちは → 失敗:こんにちは → 受付:こんにちは → 保存:こんにちは]

失敗したときは「こんにちは」が残り、そのままもう一度送れました。成功したときだけ入力欄が空になり、コンソールのエラーも出ていません。

次の GIF は、ここまでの書き方のうち3つを Chromium の画面に縦に並べた様子です。上から、リセットしない NoReset、送信の前に form.reset() を呼ぶ書き方、成功したときだけ requestFormReset を呼ぶ SuccessOnly です。入力欄に1文字ずつ入れてから、いちばん上の「3つとも送信する」ボタンで、3つのフォームの送信ボタンを押します。1回目は「こんにちは」を送ってサーバーが失敗を返し、2回目は「おはよう」を送ってサーバーが成功を返します。

画面の上部には「クリック 1回目/2回」のように何回目かが出て、その下の帯にはサーバーの状態が出ます。押した直後と、サーバーが返事をした直後は、値が変わった欄がピンクの枠と文字になります。②は、押した直後に入力欄が空になります。③は、1回目の失敗では文が残って「送信できませんでした」が出て、2回目の成功のあとで空になります。①は、2回とも文が残ります。

3つのフォームを縦に並べ、「3つとも送信する」ボタンで2回送信したときの、入力欄とボタンの変化
GIFアニメーション:3つのフォームで2回送信したときの動き。1回目はサーバーが失敗、2回目は成功を返す。②は押した直後に入力欄が空になり、③は成功の返事のあとでだけ空になる。①はどちらのあとも文が残る

Transition の外で呼ぶと、その場で空になる

startTransition を使わずに、onSubmit の中で直接 requestFormReset(form) を呼ぶとどうなるかも試しました。handleSubmit を async にして、requestFormReset(form) を呼んでから saveMessage を await しています。

text
$ node run.mjs OutsideTransition
  送信前: message="こんにちは" ボタン=["送信"] | サーバー=[]
  [console.error] requestFormReset was called outside a transition or action. To fix, move to an action, or wrap with startTransition.
  送信を押した直後: message="" ボタン=["送信"] | サーバー=[受付:こんにちは]
  成功の返事のあと: message="" ボタン=["送信"] | サーバー=[受付:こんにちは → 保存:こんにちは]

await のあとで呼んだときと同じエラーが出ました。入力欄が空になるタイミングは、form.reset() を呼んだときと同じでした。

また、requestFormReset に渡せるのは、React が描画した <form> だけです。document.createElement('form') で作ったフォームを渡すと、次のエラーが投げられました。

text
$ node run.mjs NotReactForm
  React の外で作った form を渡す: エラー: Invalid form element. requestFormReset must be passed a form that was rendered by React.
注意

送信の前に startTransition の外で requestFormReset を呼ぶと、入力欄は返事を待たずに空になります。送信が成功したかどうかが分かる前に、入力した文は消えています。このとき例外は投げられず、コンソールにエラーが出るだけで、送信の処理はそのまま続きました。

action に関数を渡すフォームなら、自分で呼ぶ必要はない

<form action={関数}> で送るフォームは、関数が成功で終わると React が自動でリセットするので、requestFormReset を呼ぶ必要はありません。React 19 の発表記事の、<form> Actions についての説明でも、requestFormReset は「フォームを手動でリセットしたいとき」に使う API として紹介されています。

requestFormReset を追加した Pull Requestには、この API を公開する理由として、UI ライブラリが Action を使う独自の API を作るときに、フォームのリセットの動きを保てるようにするため、と書かれています。

この記事の検証のように、action を使わずに onSubmit で送るフォームでも、requestFormReset を startTransition の中で呼べば、action のときと同じく送信が終わってから入力欄を空にできます。

​Posted by 86