@k8ordo/form

サーバーへの問い合わせ

ユーザー名がすでに使われているかどうかのように、サーバーにしか分からない検証を1つの入力欄に付けます。結果はほかのエラーと同じ場所に表示されます。

このページの内容

問い合わせの付け方

actions.ts
'use server';

export async function checkHandle(handle: string) {
  return (await handleExists(handle))
    ? 'This username is already taken'
    : undefined;
}
signup-form.tsx
const handle = form.field('handle');
const taken = useAsyncCheck(checkHandle, form.revalidate);

<input {...handle.input} {...taken.props} />
{handle.error !== undefined && <p>{handle.error}</p>}
<button disabled={taken.isChecking} type="submit">
  Sign up
</button>

useAsyncCheckには、値を受け取って文言を返す関数を渡します。問題が無ければundefinedを返します。Server Actionをそのまま渡せます。

2つ目の引数には、useFormが返すrevalidateを渡します。返ってきたpropsは、inputと並べて入力欄に展開します。

結果の表示

useAsyncCheckは、サーバーの結果をsetCustomValidityで入力欄に設定し、revalidateで文言を表示します。組み込みの検証と同じように扱われ、文言はfield()のerrorから読めます。

結果を待っている間はisCheckingがtrueになります。送信ボタンのdisabledに渡すと、結果が返るまで送信できません。

問い合わせるタイミング

問い合わせるのは入力欄から離れたときだけで、キーを押すたびには問い合わせません。

ほかにも、次の決まりがあります。

  • 最後に結果を受け取った値のまま入力欄を離れても、問い合わせ直しません。
  • 結果の順序が入れ替わっても、最後に問い合わせた値の結果だけを使います。
  • 入力欄を空にして離れると、前の結果は消えます。
  • 問い合わせが失敗したときは、使えるとも使えないとも判定しません。失敗したときのエラーはreportErrorでブラウザに報告します。
情報

メモ

問い合わせの結果は、入力中の目安です。送信までの間にほかの人が同じ名前を取ることがあるので、Server Actionの中でも確かめてください。

Playground

使われている名前のデモ

adminとk8oとordoを使用済みとして、サーバーへの問い合わせをブラウザ内の関数で代用したデモです。

試してみる

  1. adminと入力して入力欄から離れると、少し待ってから「このユーザー名はすでに使われています」と表示されます。
  2. 結果を待っている間は「確認しています」と表示され、「登録」ボタンは押せません。
  3. 別の名前に変えて入力欄から離れると、エラーが消えます。
k8ordo

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