@k8ordo/form

入れ子と繰り返し行

スキーマの中のオブジェクトをfield()のパスで、オブジェクトの配列をarray()の行として扱えるようになります。どちらも、パスがそのまま送信されるnameです。

このページの内容

入れ子のオブジェクト

schema.ts
z.object({
  user: z.object({
    email: z.email(),
  }),
});
profile-form.tsx
const email = form.field('user.email');

<input {...email.input} />

field()には、ドットでつないだパスを渡します。送信されるnameも、state.errorsのキーも同じパスです。

.optional()や.default()の付いたオブジェクトでも、中の入力欄は同じように使えます。

警告

落とし穴

オブジェクトを省ける場合でも、中の入力欄は必ず描画してください。nameがFormDataに無いと、parseFormはスキーマにあるフィールドが送信されていませんというエラーになります。

繰り返し行

schema.ts
z.object({
  items: z
    .array(
      z.object({
        name: z.string().min(1),
        quantity: z.coerce.number().int().min(1),
      }),
    )
    .min(1)
    .max(3),
});
order-form.tsx
const items = form.array('items');

{items.rows.map((row) => (
  <fieldset key={row.key}>
行を見分ける`key`
    <input {...row.field('name').input} />
    <input {...row.field('quantity').input} />
    {items.canRemove && (
      <button onClick={row.remove} type="button">
        Remove
      </button>
    )}
  </fieldset>
))}
{items.canAdd && (
  <button onClick={items.add} type="button">
    Add a row
  </button>
)}

オブジェクトの配列はarray()で扱います。行ごとの入力欄はrow.field()で取り出し、row.keyをkeyに渡します。

行数がスキーマの.max()に達するとcanAddが、.min()に達するとcanRemoveがfalseになります。ボタンは、サーバーが受け付ける行数の範囲でだけ出ます。

行についてReactのstateが持つのはkeyだけです。行を追加や削除しても、入力した値はstateに入りません。

Playground

注文の行のデモ

1行から3行まで入力できる注文フォームで、送信したnameと値を一覧にします。

1行目

試してみる

  1. 「行を足す」を2回押すと、3行目でボタンが消えます。スキーマの.max(3)が効いています。
  2. 2行目を空のまま「送信」を押すと、送信が止まり、その入力欄にフォーカスが移ります。
  3. 1行目を消してから残りを埋めて送ると、添字が詰まり、items[0].nameから並びます。

行数のエラー

order-form.tsx
<form {...form.props} action={formAction}>
  {items.error !== undefined && (
    <p {...items.errorProps}>{items.error}</p>
  )}
  {items.rows.map((row) => (
    <fieldset key={row.key}>{/* fields */}</fieldset>
  ))}
</form>

行数が.min()や.max()に合わないときのエラーは、どの行にも表示されません。items.errorに入ります。

表示する要素にはitems.errorPropsを展開します。展開しないと、行数のエラーだけで送信が止まったときにフォーカスがどこにも移りません。スクリーンリーダーも何も読み上げません。

エラーは行より上に表示します。行にもエラーがあるときは、まずここにフォーカスが移り、Tabキーで行へ進めます。

送信されるname

ts
row.field('name').input.name;
// 'items[0].name'

state.errors;
// { 'items[1].quantity': 'Order at least one' }

行の中の入力欄のnameは、items[0].nameのように添字を含みます。state.errorsのキーも同じ形です。

行を削除すると、後ろの行の添字は1つずつ詰まります。ブラウザの検証で出たエラーも、行と一緒に移ります。

警告

落とし穴

サーバーが返したエラーの添字は振り直されません。上の行を削除すると、まだ直していないエラーはその添字になった別の行に表示されます。

最初の行数

最初はスキーマの.min()の行数を描画します。.min()が無ければ0行です。

送信のあとは、parseFormが返すstate.rowsの行数で描画します。JavaScriptが無い状態で送り直しても、行数は変わりません。

行数は送信された添字から数えます。ただし.max()より多くは数えません。大きな添字を偽って送られても、サーバーが大きな配列を作ることはありません。

文字列の配列

tags-form.tsx
const tags = form.array('tags');

{tags.rows.map((row) => (
  <input key={row.key} {...row.field().input} />
))}

z.array(z.string())のような値の配列では、行の中にフィールド名がありません。row.field()を引数なしで呼ぶと、nameはtags[0]になります。

情報

メモ

選択肢の配列(z.array(z.enum([…])))は繰り返し行にはなりません。チェックボックスの集まりを1つのフィールドとして扱います。詳しくは入力欄の種類を見てください。

扱えない形

行の中にさらに行を入れる形は、型チェックを通ります。実行時にformFieldsとparseFormが繰り返しの中の繰り返しは name の添字が一意に決まらないため表現できませんというエラーになります。

sameAsなどのルールは、行の中の入力欄には宣言できません。行の入力欄の検証はスキーマの中に書きます。

k8ordo

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