React Hook Formのサンプル集:動作確認済みで、その場で試せる

React Hook Formのサンプル集

React Hook Formサンプル集:Zod、配列フィールド、ウィザード、実動デモ | We.Inc

このページ上で試せる、実際に動くReact Hook Formのサンプル集です。Zodによる検証、非同期チェック、配列フィールド、複数ステップのウィザード、ファイルのアップロード、Controller、Next.jsのサーバーアクションを扱います。

React Hook Formは、非制御の入力欄でReactのフォームを扱います。useFormを呼び出し、各入力欄にregister("name")を展開し、送信用の関数をhandleSubmitで包みます。Zodのスキーマで検証するにはzodResolverを追加します。以下のフォームはこのページ上で動作します。組み込みルール、Zod、非同期チェック、配列フィールド、ウィザード、ファイルのアップロード、サーバーアクションを扱っています。

インストール

  • 用途
  • コマンド
  • ライブラリー本体
  • npm install react-hook-form
  • スキーマによる検証
  • npm install zod @hookform/resolvers

各デモに入力し、わざと間違えたまま送信してから、間違いを直してみてください。横に表示されたコードが、実際に動いているコードです。エラーはaria-describedbyで入力欄と結び付けられ、role="alert"で読み上げられるので、スクリーンリーダーでもフォームを使えます。

  • useFormを呼び出します。必要に応じてdefaultValuesとresolverを渡します。
  • 各入力欄にregister("field")を展開し、すべての入力欄に目に見えるラベルを付けます。
  • 送信用の関数を包みます:onSubmit={handleSubmit(save)}。
  • 各フィールドの横にformState.errors.field?.messageを表示します。
  • 保存処理の実行中は、isSubmittingでボタンを無効にします。
  • すべてのフィールドにdefaultValuesを設定しましょう。リセットの動きが予測しやすくなり、制御と非制御の切り替わりに関する警告も出なくなります。
  • 数値の入力欄にはvalueAsNumberかz.coerce.number()を使いましょう。そうしないと、入力欄は常に文字列を返します。
  • 会員登録フォームではモードにonTouchedを選びましょう。最初の項目を入力している途中で赤いエラーが出ることがありません。
  • JavaScriptで検証する場合は、フォームにnoValidateを付けましょう。ブラウザーの吹き出しと独自のメッセージが両方表示されるのを防げます。
  • Zodのスキーマは専用のファイルに分けておきましょう。サーバー側がReactを読み込まずにインポートできます。

よくある質問

React Hook FormはFormikより優れていますか?

React Hook Formは入力欄を非制御のまま保ち、refを通して値を読み取るため、再描画が少なく済みます。Formikはすべての値をReactの状態として保持します。大きなフォームでは、たいていReact Hook Formのほうが速く、必要なコードも少なくなります。

React Hook FormとZodを組み合わせるには?

zodと@hookform/resolversをインストールし、z.objectでスキーマを定義して、useFormにresolver: zodResolver(schema)を渡します。フォームの型にはz.infer<typeof schema>を使い、エラーメッセージはスキーマから取得されます。

送信後にフォームをリセットするには?

保存が成功した後、送信ハンドラーの中でreset()を呼ぶか、reset(values)で新しい値を渡します。isSubmitSuccessfulがtrueになったタイミングで、エフェクトの中からresetを呼ぶこともできます。

数値のフィールドが文字列になるのはなぜですか?

HTMLの入力欄はテキストを返すからです。本物の数値を得るには、valueAsNumber: trueを付けて登録するか、Zodのスキーマでz.coerce.number()を使います。

React Hook Formはshadcn/uiと一緒に使えますか?

はい。shadcn/uiには、React Hook FormのControllerを土台にしたFormコンポーネントが用意されています。当サイトのshadcnのフォームとテーブルのガイドで、動くサンプルとともに手順を解説しています。

アクセシブルなエラーメッセージ

  • すべての入力欄には、プレースホルダーだけでなく、htmlForで結び付けたラベルが必要です。フィールドの値が正しくない場合は、入力欄にaria-invalidを設定し、aria-describedbyでメッセージを指定しましょう。そうすれば、スクリーンリーダーがフィールドと一緒にエラーを読み上げます。
  • 送信時、React Hook Formは既定で最初の不正なフィールドにフォーカスを移します(shouldFocusError)。これは有効のままにしておきましょう。キーボードで操作する人が、どこが間違っていたかを見つける最も早い方法です。

よくある間違い

  • 配列フィールドでインデックスをキーに使うこと。行を削除した後に行の中身が入れ替わってしまいます。
  • 大きなフォームの最上位でwatch()を呼ぶこと。キーを押すたびにフォーム全体が再描画されます。代わりに、小さな子コンポーネントの中でuseWatchを使いましょう。
  • ブラウザーでの検証だけを信用すること。サーバーに送られるものは、すべてサーバー側でもう一度チェックする必要があります。

APIの早見表

よく使うAPI

  • API
  • 用途
  • register(name, rules)
  • ネイティブの入力欄、セレクト、テキストエリア、チェックボックス
  • handleSubmit(onValid, onInvalid?)
  • 検証したうえで、値を渡して関数を呼び出す
  • formState.errors / isSubmitting / isDirty
  • エラーメッセージとボタンの状態
  • mode: onSubmit | onBlur | onTouched | onChange | all
  • 検証を実行するタイミング(既定はonSubmit)
  • resolver: zodResolver(schema)
  • Zod(またはYup、Valibot)のスキーマで検証する
  • useFieldArray
  • 繰り返しの行:追加、削除、移動
  • Controller / useController
  • refを持たない独自の入力欄
  • trigger(names)
  • ウィザードの各ステップのように、一部のフィールドを今すぐ検証する
  • setError / clearErrors
  • サーバーから返ってきたエラー
  • reset(values)
  • 保存済みのデータを読み込む、または送信後にクリアする
  • watch / useWatch
  • 変化する値を読み取る(useWatchのほうが再描画が少ない)

検証:組み込みルール、Zod、非同期チェック

組み込みルールを使った基本のフォーム

registerは名前で入力欄を結び付け、HTMLと同じ形式のルールを受け取ります。送信に失敗すると、errorsにフィールドごとのメッセージが入ります。

zodResolverとZodのスキーマ

1つのスキーマから、検証ルール、エラーメッセージ、TypeScriptの型が得られます。refineは2つのフィールドをまとめてチェックし、pathはどのフィールドにエラーを表示するかを指定します。

非同期の検証(そのユーザー名は空いている?)

validate関数はPromiseを返してもかまいません。値に問題がなければtrueを、エラーとして表示したい場合は文字列を返します。キーを押すたびに実行されないよう、モードonBlurと組み合わせましょう。

配列フィールド、ウィザード、ファイル、独自の入力欄

配列フィールド(行の追加と削除)

useFieldArrayはフォーム内のリストを管理します。キーにはインデックスではなく必ずfield.idを使いましょう。そうすれば、Reactは各入力欄を正しい行に結び付けたまま保ちます。

複数ステップのウィザード

すべてのステップで1つのフォームを使い、次へ進む前に現在のステップのフィールドを指定してtriggerを呼びます。前のステップの値はフォームに残るので、最後の送信ですべての値がそろいます。

サイズと形式をチェックするファイルのアップロード

ファイルの入力欄もほかと同じように登録でき、値はFileListになります。validateでサイズと形式をチェックし、FormDataでファイルを送信します。

Controllerを使った制御コンポーネント

多くの日付ピッカーや独自のセレクトのように、refを公開していない入力欄はControllerを通して接続します。Controllerは、valueとonChangeをコンポーネントに渡します。

サーバーへの送信

Next.jsのサーバーアクションで二重に検証する

すばやいフィードバックのためにブラウザーで検証し、ブラウザーの検証は回避できてしまうのでサーバーでもう一度検証します。1つのZodスキーマを共有すれば両者の内容がそろい、setErrorでサーバー側の問題を正しいフィールドに表示できます。

普通のHTMLフォームがよければ、こちらをご覧ください:

お問い合わせフォームの追加方法

送信内容:

名前

メールアドレス

名前を入力してください

メールアドレスを入力してください

メールアドレスが正しくないようです

送信中...

送信

有効なメールアドレスを入力してください

8文字以上

パスワードが一致しません

パスワード

パスワード(確認)

アカウントを作成

このデモでは、少し待つことでサーバーを模擬しています。使用済み:admin, studio, hello。

ユーザー名

ユーザー名を選んでください

そのユーザー名は使われています

確認中...

取得

ロゴデザイン

項目 {n} の名前

項目 {n} の数量

項目

削除

項目を追加

保存

必須

ステップ {n} / {total}

会社名

チームの人数

プラン

選択してください

スターター

チーム

強調表示された項目を入力してください。

戻る

次へ

完了

ロゴ(PNGまたはJPG、2 MBまで。ファイルはブラウザー内にとどまります)

ファイルを選択

最大2 MB

PNGまたはJPGのみ

アップロード

10以上

予算:

無料で始める · クレジットカード不要

関連: ガイド|Webマーケティングと集客を学ぶ

製品

ご利用いただける方

機能

リソース

会社情報

サイトマップを見る