複数の入力欄の検証
パスワードの確認や「2つ以上選ぶ」のように、複数の入力欄にまたがる検証をルールとして宣言します。ルールはブラウザとサーバーで同じ判定になります。
このページの内容
ルールの宣言
export const signup = defineForm(
z.object({
password: z.string().min(8),
confirm: z.string(),
}),
[sameAs('confirm', 'password', 'The passwords do not match')],
スキーマの横にルールを並べる
);
const signupFields = formFields(signup);
スキーマの代わりに定義を渡す
const parsed = parseForm(signup, formData);defineFormに、スキーマとルールの配列を渡します。できた定義は、スキーマの代わりにformFieldsとparseFormへ渡します。
ルールはデータなので、入力欄の情報と一緒にブラウザへ送られます。
ルールに書くフィールド名は、スキーマの型で確かめられます。無い名前を書くと型エラーになります。
用意されているルール
defineForm(schema, [
sameAs('confirm', 'password', 'The passwords do not match'),
minChecked('topics', 2, 'Pick at least two'),
requiredWhen('reason', 'status', 'rejected', 'Give a reason'),
]);sameAs(field, other, message):fieldの値がotherの値と同じであることを求めます。パスワードの確認に使います。minChecked(field, min, message):同じ名前のチェックボックスのうち、min個以上にチェックが入っていることを求めます。requiredWhen(field, when, equals, message):whenの値がequalsのときだけ、fieldを必須にします。
審査フォームのデモ
「却下」のときだけ理由が必須になり、観点を2つ以上選ぶ必要がある審査フォームです。
試してみる
- 観点を2つ選び、判定で「却下」を選びます。理由を空のまま「送信」を押すと、理由の入力欄にエラーが出ます。
- 判定を「承認」に戻すと、理由のエラーは消えます。
- 観点を1つだけにして送信すると、2つ以上選ぶよう求めるエラーが出ます。
ブラウザとサーバーの判定
ブラウザは入力中のフォームを、サーバーは送信された値を同じ処理で確かめます。
ブラウザでは、ルールを満たさない入力欄にsetCustomValidityでエラーを付けます。組み込みの検証と同じ扱いなので、:user-invalidに一致します。文言はほかのエラーと同じく入力欄のerrorで受け取ります。
1つの入力欄が複数のルールを満たさないときは、先に宣言したルールの文言を表示します。
文言の翻訳
src/lib/signup-form.tsimport { mismatch, pickAtLeast } from '../messages/signup';
export const signup = defineForm(schema, [
sameAs('confirm', 'password', mismatch),
minChecked('topics', 2, () => pickAtLeast(2)),
]);ルールの文言には、文字列の代わりに関数も渡せます。ブラウザで出す文言は、formFieldsを呼んだときのロケールで決まります。
zodの文言と同じ仕組みなので、formFieldsを呼ぶ場所はエラーの表示を見てください。
ルールで書けない検証
z.object({
start: z.iso.date(),
end: z.iso.date(),
}).refine((value) => value.start <= value.end, {
message: 'The end comes before the start',
});3つのルールで書けない検証は、.refine()で書きます。.refine()はサーバーでしか動きません。
スキーマ全体に付けた.refine()は、ブラウザで確かめない検証としてdroppedに載ります。pathを指定しなければ、エラーはform.formErrorに入ります。
落とし穴
1つのフィールドや入れ子のオブジェクト、配列の行に付けた.refine()は、まだdroppedに載りません。ブラウザでは何も表示されず、送信したあとにサーバーでエラーになります。