@k8ordo/state

ストレージとメモリ

ブラウザの中に状態を置く定義は3つあり、保存される期間と共有される範囲が違います。違いを元に、表示形式のような好みをどこに置くかを決められます。

このページの内容

localStorage

prefs.ts
import { defineLocalState } from '@k8ordo/state';
import * as z from 'zod';

export const prefs = defineLocalState(
  'prefs',
  z.object({
    view: z.enum(['grid', 'table']).default('grid'),
    pageSize: z.number().default(20),
  }),
);
view-switch.tsx
const [{ view }, update] = useAppState(prefs, ['view']);

update({ view: 'table' });

defineLocalStateは、状態をlocalStorageに置きます。useAppStateで読み、update()で書きます。値は消すまで残り、同じブラウザのすべてのタブで同じ値が見えます。保存先はk8ordo-state:prefsというキーで、定義のstorageKeyで読めます。入るのは{"view":"table","pageSize":20}のような、スキーマに書いたフィールドだけのJSONです。

フィールドはJSONで表せる型にします。z.date()の値は、書いた直後は表示されますが、次に読み込んだときに既定値に戻ります。スキーマは自分が書いた値も読む必要があるので、真偽値はz.boolean()で書きます。z.stringbool()は使えません。

サーバーにはlocalStorageが無いので、サーバーの描画とハイドレーションの描画は既定値で行われます。保存した値に切り替わるのは、そのあとです。サーバーの描画から保存した値を出すなら、Cookieを見てください。最初の描画より前に<html>へ反映するなら、ハイドレーション前を見てください。

ほかのタブとの同期

ほかのタブがこの状態の値を書き換えると、storageイベントが発火し、ストアが保存した値を読み直します。再描画されるのは、変わったキーを購読しているコンポーネントだけです。ほかのタブがpageSizeだけを変えたなら、['view']だけを購読しているコンポーネントは再描画されません。

sessionStorage

notices.ts
import { defineSessionState } from '@k8ordo/state';
import * as z from 'zod';

export const notices = defineSessionState(
  'notices',
  z.object({ dismissed: z.array(z.string()).default([]) }),
);

defineSessionStateはdefineLocalStateと同じ作りで、置き場所だけがsessionStorageになります。値は再読み込みでは残り、タブを閉じると消えます。ほかのタブとは共有しないので、storageイベントが発火するのは同じタブの中のほかのフレームだけです。

versionとmigrateは取りません。詳しくはマイグレーションを見てください。

同じ'prefs'を付けたdefineLocalStateとは別の状態で、保存した値も共有しません。キーの決まりは置き場所を見てください。

メモリ

palette.ts
import { defineMemoryState } from '@k8ordo/state';

export const palette = defineMemoryState('command-palette', {
  open: false,
  query: '',
});

type Panel = { tab: 'logs' | 'network' };

export const panel = defineMemoryState<Panel>('debug-panel', {
  tab: 'logs',
});

defineMemoryStateは、状態をJavaScriptの実行環境に置きます。離れたコンポーネントどうしで同じ値を読み書きでき、再読み込みで初期値に戻ります。スキーマは無く、型は初期値から推論されます。unionのように初期値から推論できない型は、型引数で書きます。

update()は呼ぶたびにその場で反映されます。ほかの置き場所のような書き込みのまとめは起きません。詳しくは更新を見てください。サーバーの描画は初期値で行われます。

警告

落とし穴

値はその場で書き換えず、update()で置き換えてください。変わったかどうかは、update()が受け取った値を前の値と比べて決めます。入れ子のオブジェクトをその場で書き換えても、どのコンポーネントも再描画されません。

Playground

再読み込み後に残る値

localStorageとsessionStorageとメモリに1つずつ数を置いた、置き場所だけが違う同じ形の定義です。

  • localStoragek8ordo-state:storage-demo-local
    0
  • sessionStoragek8ordo-state:storage-demo-session
    0
  • メモリ保存しない
    0

試してみる

  1. 3つの数をそれぞれ何度か増やしてから、ページを再読み込みします。localStorageとsessionStorageの数は残り、メモリの数は0に戻ります。
  2. アドレスバーのURLをコピーし、新しいタブに貼り付けて開きます。引き継がれるのはlocalStorageの数だけで、sessionStorageの数は0から始まります。
  3. 新しいタブでlocalStorageの数を増やしてから、元のタブに戻ります。元のタブの数も、同じ値に変わっています。
k8ordo

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