@k8ordo/state

URLやlocalStorage、Cookieの値をuseStateのように読み書きするReactの状態管理

bash
npm install @k8ordo/state zod
src/state.ts
export const listState = definePageState('product-list', {
  url: z.object({
    q: z.string().default(''),
    page: z.coerce.number().int().min(1).default(1),
  }),
});
src/components/filters.tsx
const [{ q, page }, update] = useAppState(listState);

update({ page: page + 1 }, { history: 'push' });
URL
/products?q=lamp&page=2

置き場所で決まる保存期間と共有範囲

definePageStateはURLと履歴エントリに、defineLocalStateはlocalStorageに、defineCookieStateはCookieに状態を置きます。

再読み込みで残るか、ほかのタブやサーバーから読めるかは置き場所で決まります。どこに置いた状態も、同じuseAppStateで読み書きします。

src/state.ts
export const listState = definePageState('product-list', {
  url: z.object({
    q: z.string().default(''),
    page: z.coerce.number().int().min(1).default(1),
  }),
  entry: z.object({
    expanded: z.array(z.string()).default([]),
  }),
});

export const prefs = defineLocalState(
  'prefs',
  z.object({
    view: z.enum(['grid', 'table']).default('grid'),
  }),
);

export const density = defineCookieState(
  'density',
  z.object({
    density: z.enum(['cozy', 'compact']).default('cozy'),
  }),
);

zodのスキーマで型付けした値

URLやストレージから読み戻した値はスキーマを通ります。合わないフィールドだけが既定値に戻り、ほかのフィールドはそのまま残ります。

update()で書く値も同じスキーマで検証されます。TypeScriptの型もスキーマから作られるので、型を別に書くことはありません。

Playground

URLの値のデモ

このページのURLを実際に書き換えるdefinePageStateです。

tab
page
1
URL
クエリなし(すべて既定値)
state
{ tab: 'overview', page: 1 }

試してみる

  1. アドレスバーでpageを0に書き換えて開き直すと、pageだけが1に戻り、tabはそのまま残ります。
  2. pageの+を何度か押してから、ブラウザの戻るを押してください。pageが1つずつ戻ります。
  3. tabを切り替えても、戻るの履歴は増えません。いまの履歴エントリを書き換えるだけです。