Tips2022.10.06

React Hook Form + zodで数値型のselectの空文字対応

React Hook Form + zodで実装しているselectで数値型を指定すると、未選択時の空文字でエラーが出てしまうので対処法。

たとえば、zodで数値を指定して、optionのvalueに数値が入っている場合はvalueAsNumberを指定することで文字列型を数値に変換してくれて問題なく動作します。

1
item: z.number()

1
2
3
4
<select ref={register('item', { valueAsNumber: true })}>
  <option value="1">項目1</option>
  <option value="2">項目2</option>
</selet>

目次

selectの先頭に未選択時の項目を入れる
参考

selectの先頭に未選択時の項目を入れる

これまではすべてのoptionにvalueが入っていたところに下記のような未選択状態のoptionを入れるとします。

1
2
3
4
5
<select ref={register('item', { valueAsNumber: true })}>
  <option value="">選択してください</option>
  <option value="1">項目1</option>
  <option value="2">項目2</option>
</selet>

空文字のvalueのoptionが追加されたことにより、未選択状態だとzodで指定しているnumber型のエラーが出るようになってしまいます。
`z.number().optional()`でいけるかと思ったのですが、空文字はあくまでもstring型のためエラーに・・。

そこでvalueAsNumberの指定を外してsetValueAsで値を改変するようにします。
setValueAsはvalueAsNumberが指定されていると動作しないため注意。

1
2
3
const selectRef = register('item', {
  setValueAs: (v) => (v === '' ? undefined : parseInt(v, 10)),
})

1
2
3
4
<select ref={selectRef}>
  <option value="1">項目1</option>
  <option value="2">項目2</option>
</selet>

参考

今回は下記を参考にしました。
リンク先ではinputに対してsetValueAsを使用していますが、selectでも同様の対応が可能です。

https://github.com/react-hook-form/react-hook-form/discussions/6980