設定の保存先
訪問者が選んだ配色は、@k8ordo/stateのローカル状態としてlocalStorageに保存されます。保存される値の形と、プロバイダを通さずに読む方法が分かります。
このページの内容
colorSchemeStateの定義
scheme.tsimport { defineLocalState } from '@k8ordo/state';
import * as z from 'zod/mini';
export const colorSchemeState = defineLocalState(
'color-scheme',
状態の名前。localStorageのキーは`k8ordo-state:color-scheme`
z.object({ preference: z.optional(z.enum(['light', 'dark'])) }),
省略できる。無いときは「何も選んでいない」
);@k8ordo/color-schemeは保存先の定義をcolorSchemeStateとしてexportしています。定義はこれですべてです。defineLocalStateの仕組みは@k8ordo/stateのストレージとメモリを見てください。
キーはcolorSchemeState.storageKeyで読めるので、文字列で書く必要はありません。
初めて訪れたときのOSの設定が、選択として保存されることはありません。
保存される値
localStorageに書き込むのは、setPreferenceを呼んだときだけです。呼び方ごとに、保存される値は次のようになります。
- 一度も選んでいない:何も保存されていません。
localStorage.getItemはnullを返します。 setPreference('dark'):{"preference":"dark"}が保存されます。setPreference('light'):{"preference":"light"}が保存されます。setPreference('system'):{}が保存されます。
preferenceの無い{}は、読む側には何も保存されていないのと同じです。どちらも「何も選んでいない」として読まれ、プロバイダの既定値が使われます。
既定値は保存されません。defaultPreferenceを変えたときの動作は切り替えボタンを見てください。
サイトのデータの保存を止めたブラウザでは、選択を保存できません。プロバイダはdefaultPreferenceで描画します。setPreferenceで選んだ配色は、次に読み込むまでメモリに残ります。
プロバイダを通さない読み取り
stored-preference.tsx'use client';
import { colorSchemeState } from '@k8ordo/color-scheme';
import { useAppState } from '@k8ordo/state';
export function StoredPreference() {
const [{ preference }] = useAppState(colorSchemeState);
return <output>{preference ?? 'nothing chosen'}</output>;
}どのClient Componentでも、useAppState(colorSchemeState)でプロバイダと同じ値を読めます。返るのは保存したpreferenceで、'light'か'dark'かundefinedです。サーバーの描画とハイドレーションの描画ではundefinedです。
画面に適用中の配色を読むときは、useColorScheme()のschemeを使います。
最初の描画の前に動く自前のインラインスクリプトでは、colorSchemeState.inlineRead()を使います。返るのは、保存した値かnullになるJavaScriptの式です。スキーマは通らないので、使うフィールドは自分で確かめます。詳しくは@k8ordo/stateのハイドレーション前を見てください。
ほかのタブとの同期
別のタブで選び直した配色は、storageイベントでこのタブのプロバイダにも反映されます。<html>のクラスもその場で変わります。別のタブでlocalStorageを消した場合も同じです。
落とし穴
storageイベントは、書き込んだタブ自身では発火しません。同じタブでlocalStorage.setItemを直接呼んでも、再読み込みするまでプロバイダには反映されません。選択を変えるときはsetPreferenceを使います。
ほかの設定
ほかの表示の設定は、別の名前で定義した自前のdefineLocalStateに保存します。書き方は@k8ordo/stateのストレージとメモリを見てください。
落とし穴
アプリの中でdefineLocalState('color-scheme', …)をもう1つ定義しないでください。ストアは名前で共有されるので、2つの定義が同じlocalStorageのキーを読み書きします。