複数ステップのフォーム
入力欄の多いフォームを、いくつかのステップに分けて作ります。すべてのステップを描画したまま、いまのステップ以外を隠します。
このページの内容
ステップの隠し方
entry-form.tsxconst subscribe = () => () => {};
const hydrated = useSyncExternalStore(subscribe, () => true, () => false);
ハイドレーションが終わると`true`になる
<fieldset hidden={hydrated && step !== 0} ref={stepOne}>
いまのステップ以外に`hidden`を付ける
{/* step 1 */}
</fieldset>
<fieldset hidden={hydrated && step !== 1}>
{/* step 2 */}
</fieldset>ステップごとに<fieldset>で囲み、いまのステップ以外にhiddenを付けます。隠れた入力欄もDOMに残るので、ステップを行き来しても値は消えません。送信は最後に1回です。
隠すのは、ハイドレーションが終わってからです。JavaScriptが無いときは1枚の長いフォームになり、1回のリクエストで送信されます。
ステップごとの検証
entry-form.tsxconst next = () => {
const controls = stepOne.current?.querySelectorAll('input') ?? [];
いまのステップの中の入力欄だけ
const invalid = [...controls].find((control) => !control.checkValidity());
if (invalid !== undefined) {
invalid.focus();
return;
}
setStep(1);
};「次へ」では、いまのステップの中の入力欄だけをcheckValidity()で確かめます。後のステップはまだ入力していないので、フォーム全体を確かめると必ず失敗します。
useFormは、入力欄を離れたときにエラーを表示します。最初に失敗した入力欄へフォーカスを移しておけば、そこを離れたときにエラーが出ます。
送信ボタン
entry-form.tsx{(!hydrated || step === 1) && <button type="submit">Submit</button>}ハイドレーションが終わったら、送信ボタンは最後のステップにだけ描画します。
落とし穴
テキストの入力欄でEnterキーを押すと、ブラウザはフォームの最初の送信ボタンを押します。隠れたステップにあるボタンでも押されるので、前のステップからフォーム全体が送られます。
送信後のエラー
entry-form.tsxconst STEP_OF: Record<string, number> = {
name: 0,
email: 0,
title: 1,
minutes: 1,
};
const [shownState, setShownState] = useState(state);
if (state !== shownState) {
新しい`state`を受け取った描画で、エラーのあるステップへ切り替える
setShownState(state);
const failed = Object.keys(state.errors ?? {}).map(
(key) => STEP_OF[key] ?? 0,
);
if (failed.length > 0) setStep(Math.min(...failed));
}送信に失敗すると、useFormはページで最初に失敗した入力欄にフォーカスを移します。隠れたステップの入力欄は、フォーカスを受け取れません。
state.errorsに入力欄があるステップのうち、最も前のステップへ描画の中で切り替えます。入力欄が先に表示されるので、フォーカスはその欄に移ります。
送信時の検証は、隠れたステップの入力欄も対象です。そこで失敗すると、エラーを表示できないまま送信が止まります。
2ステップのデモ
1ステップ目で連絡先を、2ステップ目で登壇の内容を入力する、1つの<form>です。
試してみる
- 名前を空のまま「次へ」を押すと、先へは進まず、名前の入力欄にフォーカスが移ります。
- 1ステップ目を埋めて進み、「戻る」を押すと、入力した値がそのまま残っています。
- 2ステップ目の長さに
90と入力して「申し込む」を押すと、送信が止まり、エラーが表示されます。