@k8ordo/form

既存データの編集

登録済みのデータを、今の値を入れた入力欄で編集するフォームを作ります。isDirtyで変更の有無を読み、リセットで元の値に戻します。

このページの内容

今の値の渡し方

edit-talk-form.tsx
const title = form.field('title');
const isPublic = form.field('public');

<input defaultValue={talk.title} {...title.input} />
<input defaultChecked={talk.public} {...isPublic.input} />

今の値はdefaultValueで渡します。チェックボックスはdefaultCheckedです。入力欄は非制御なので、valueとonChangeで値を持つ必要はありません。

defaultValueは、inputを展開する前に書きます。送信に失敗したあとは、inputが送信した値をdefaultValueとして持ち、前に書いた今の値を上書きします。それ以外のときはinputにdefaultValueが無いので、今の値が入力欄に入ります。

警告

落とし穴

inputのあとにdefaultValueを書くと、送信に失敗したときも今の値で上書きされ、入力した内容が消えます。

変更の検知

edit-talk-form.tsx
useEffect(() => {
  if (!form.isDirty) return;
  const confirm = (event: BeforeUnloadEvent) => {
    event.preventDefault();
  };
  addEventListener('beforeunload', confirm);
  return () => {
    removeEventListener('beforeunload', confirm);
  };
}, [form.isDirty]);

上のコードは、変更を保存せずにページを離れようとしたときに確認を出します。

form.isDirtyは、どれかの入力欄の値が描画したときから変わっていればtrueになります。行の追加や削除も変更として数えます。

useFormは各入力欄の今の値を、描画したときの既定値(defaultValueやdefaultChecked)とDOM上で比べます。キーを押すたびに再描画されることはなく、isDirtyが切り替わるときだけ再描画されます。

警告

落とし穴

送信ボタンをdisabled={!form.isDirty}で止めるのはおすすめしません。サーバーで描画したHTMLではisDirtyがfalseなので、JavaScriptが読み込まれるまで押せません。送信に失敗したあともisDirtyはfalseに戻るので、何も直さずに送り直すこともできません。

リセット

tsx
<button type="reset">Revert</button>

type="reset"のボタンを押すと、ブラウザがすべての入力欄をdefaultValueに戻します。useFormはこのリセットを検知します。表示していたエラーを消し、isDirtyをfalseに戻します。

Server Actionが終わったあとは、Reactがフォームを同じようにリセットします。送信に失敗したときは、defaultValueをinputより前に書いていれば、リセットされても入力は消えません。

Playground

編集フォームのデモ

登録済みの登壇情報を編集するフォームで、今の値をdefaultValueで渡しています。

状態変更なし

試してみる

  1. タイトルを書き換えると、「変更あり」の表示に変わります。
  2. 書き換えた文字を消して元のタイトルに戻すと、「変更なし」に戻ります。
  3. 公開のチェックを外してから「元に戻す」を押すと、値も表示も元に戻ります。
k8ordo

Baselineに入った機能を、制限なく使うReactのライブラリ群。