ハイドレーション前
テーマのクラスのように、最初の描画より前に<html>へ反映したい値を、インラインスクリプトで読めるようになります。useAppStateはハイドレーションのあとに動くので、それでは間に合いません。
このページの内容
storageKeyとinlineRead()
src/state.tsimport { defineLocalState } from '@k8ordo/state';
import * as z from 'zod';
export const themeState = defineLocalState(
'theme',
z.object({ mode: z.enum(['light', 'dark']).optional() }),
);themeState.storageKey;
// 'k8ordo-state:theme'
themeState.inlineRead();
// '(()=>{try{const v=JSON.parse(localStorage.getItem("k8ordo-state:theme"));…})()'1行目のstorageKeyは、ストアがlocalStorageやsessionStorageに書き込むキーです。4行目のinlineRead()は、インラインの<script>に埋め込むJavaScriptの式を返します。この式をブラウザで評価すると、その置き場所に保存されたオブジェクトになります。
キーとJSONの形をスクリプトに直接書くと、どちらかを変えた時点で定義と食い違います。inlineRead()の式は定義から作られるので、変更に追従します。
inlineRead()があるのは、localStorageとsessionStorageの定義だけです。Cookieの状態は、@k8ordo/frameworkのserverモードならサーバーがparseCookiesで読み、最初の描画から保存した値を表示できます。書き方はリクエストとCookieを見てください。
<script>への埋め込み
src/routes/layout.tsximport type { ReactNode } from 'react';
import { themeState } from '../state';
const applyTheme = `(() => {
const s = ${themeState.inlineRead()};
if (s && s.mode === 'dark') {
document.documentElement.classList.add('dark');
}
})();`;
export default function RootLayout({
children,
}: {
children: ReactNode;
}) {
return (
<html lang="en" suppressHydrationWarning>
<head>
<script>{applyTheme}</script>
</head>
<body>{children}</body>
</html>
);
}6行目で、式を値として埋め込みます。式は即時実行の関数です。代入の右辺にも関数の引数にも三項演算子の中にも書けます。キーは<も含めてエスケープされるので、どんなキーでも埋め込めます。
スクリプトはReactより先に<html>のクラスを変えるので、18行目で<html>にsuppressHydrationWarningを付けます。ハイドレーションのあとは、ストアの値を正として扱います。
nullになるとき
式がエラーになることはありません。次のときはnullになります。
- 何も保存されていない
- 保存されたJSONが壊れている
- 値がオブジェクトではない(数や文字列、配列、
null) - ストレージが読めない
versionを持つlocalStorageの状態で、ほかのバージョンが書いた値が保存されている
スキーマを通る前の値
スクリプトが動く時点では、まだモジュールが読み込まれていません。スキーマもmigrateも走らず、保存された値がそのまま返ってきます。useAppStateが返す、スキーマに合わないフィールドだけを既定値に戻した値とは違います。
中身を信頼せず、必要なフィールドだけをそれぞれ確かめて読みます。「<script>への埋め込み」の例では、s && s.mode === 'dark'で確かめています。
メモ
@k8ordo/color-schemeは、inlineRead()で最初の描画の前に<html>へクラスを付けています。カラースキームの切り替えなら、このパッケージを使ってください。