@k8ordo/form

検索フォーム

検索や絞り込みの条件をURLに残すGETのフォームを書けるようになります。フォームと@k8ordo/stateが1つのスキーマを共有します。

このページの内容

スキーマの共有

src/lib/list-state.ts
export const listState = definePageState('product-list', {
  url: z.object({
    q: z.string().default(''),
    inStock: z.stringbool().default(false),
  }),
});
src/routes/products/page.tsx
const filterFields = formFields(listState.url);

export default function ProductsPage() {
  return <Filters fields={filterFields} />;
}

URLに置く状態は、@k8ordo/stateのdefinePageStateにurlスキーマとして書きます。スキーマの書き方はURLを見てください。

そのスキーマをそのままformFieldsに渡します。

@k8ordo/frameworkのserverモードでは、同じスキーマをsearchとしてexportすると、ページが検証済みの条件を受け取ります。詳しくはパラメータを見てください。

GETのフォーム

src/components/filters.tsx
const form = useForm(fields);
const [current] = useAppState(listState);
const q = form.field('q');
const inStock = form.field('inStock');

<form {...form.props} method="get">
  <input {...q.input} defaultValue={current.q} type="search" />
  <input {...inStock.input} defaultChecked={current.inStock} />
  <button type="submit">Filter</button>
</form>

送信を受け取るServer Actionが無いので、useFormにはfieldsだけを渡します。第2引数(Server Actionが返すstate)が無くても、送信のときの検証は行われます。スキーマに合わない条件はURLに書かれません。

入力欄には、useAppStateで読んだ現在の値をdefaultValueとdefaultCheckedで渡します。

@k8ordo/routerを使うと、同じパスへのGETの送信は状態の更新として扱われます。仕組みは仕組みを見てください。

情報

メモ

defaultValueとdefaultCheckedは最初の描画でしか使われません。そのため、戻るボタンでURLが変わっても入力欄の値は変わりません。入力欄もURLに合わせるには、<form key={search}>のようにURLが変わるたびにフォームを作り直します。

Playground

絞り込みのデモ

このページのURLを実際に書き換えるGETのフォームです。

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

試してみる

  1. キーワードを入れて「絞り込む」を押すと、URLに?q=が付きます。ページは読み込み直されません。
  2. 「在庫ありのみ」にチェックして送信すると、URLにinStock=trueが付きます。
  3. ブラウザの戻るボタンを押すと、URLとstateの値が前の条件に戻ります。

文字列のチェックボックス

URLに置く真偽値はz.stringbool()で書きます。チェックボックスは、update()がtrueを書くときと同じ文字列を送ります。そのため、送信でできるURLとupdate()が書くURLは一致します。

@k8ordo/uiのCheckboxは、inputに含まれるvalueを<input>に渡しません。この欄は素の<input>で描画します。詳しくはフォームを見てください。

k8ordo

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