@k8ordo/form

zodのスキーマからHTMLの制約属性とサーバーの検証を作るReactのフォームライブラリ

bash
npm install @k8ordo/form zod
schema.ts
export const talkSchema = z.object({
  title: z.string().min(1).max(120),
});
talk-form.tsx
const title = form.field('title');

<input {...title.input} />
HTML
<input name="title" type="text" required
  minlength="1" maxlength="120">

スキーマに1度だけ書く制約

formFieldsはスキーマから、requiredやmaxlengthといった入力欄の属性とzodのエラー文言を作ります。

parseFormは、送信されたFormDataを同じスキーマで検証します。JSXとサーバーに制約を書き写すことはありません。

page.tsx
const fields = formFields(talkSchema);

fields.fields.title.input;
// { name: 'title', type: 'text', required: true,
//   minLength: 1, maxLength: 120 }

fields.fields.title.messages.tooLong;
// 'Too big: expected string to have <=120 characters'

JavaScriptの読み込み前に動く検証

制約は、サーバーが返すHTMLに属性として入っています。ページの読み込みが終わる前から、ブラウザが入力を確かめます。

読み込みが終わると、入力欄から離れたときと送信のときに、同じスキーマで検証してzodのエラー文言を表示します。入力した値はReactのstateに保存しないので、キー入力のたびに再描画されることはありません。

Playground

絞り込みフォームのデモ

スキーマから作ったGETのフォームで、送信するとこのページのURLが書き換わります。

URL
クエリなし(すべて既定値)
state
{ q: '', min: 0, inStock: false }

試してみる

  1. 「最小値」に-1と入力して入力欄から離れると、zodのエラー文言が表示されます。
  2. そのまま「絞り込む」を押すと、送信が止まり、フォーカスがその入力欄に戻ります。
  3. 正しい値にして送ると、URLとその下のstateに同じ値が表示されます。

入力欄ごとに出るサーバーのエラー

parseFormは、検証に失敗した理由を入力欄ごとのエラーとして返します。送信された値も一緒に返します。

useFormはエラーを該当する入力欄に表示し、最初に失敗した入力欄へフォーカスを移します。入力した値は残るので、直してすぐに送り直せます。

actions.ts
export async function createTalk(
  _prev: FormState,
  formData: FormData,
) {
  const parsed = parseForm(talkSchema, formData);
  if (!parsed.success) return parsed.state;

  await insertTalk(parsed.data);
  redirect(href('/talks'));
}