@k8ordo/color-scheme

クラスベースのReactのダークモード切り替え

bash
npm install @k8ordo/color-scheme @k8ordo/state zod
src/routes/layout.tsx
<html lang="ja" suppressHydrationWarning>
  <head>
    <ColorSchemeScript />
  </head>
  <body>
    <ColorSchemeProvider>{children}</ColorSchemeProvider>
  </body>
</html>
theme-toggle.tsx
const { scheme, setPreference } = useColorScheme();

setPreference(scheme === 'dark' ? 'light' : 'dark');

最初の表示から正しい配色

<ColorSchemeScript>は、<head>に置くインラインスクリプトです。保存した選択を読み、最初の描画の前に<html>へdarkクラスを付けます。

何も選んでいない訪問者には、OSの設定に合わせた配色が出ます。

Playground

配色の切り替えのデモ

ヘッダーの切り替えボタンと同じuseColorScheme()を使っています。

scheme
light
preference
system

試してみる

  1. 「ダーク」を押してからページを再読み込みすると、最初から暗いまま表示されます。
  2. 「システム」を押してからOSの外観の設定を切り替えると、ページの配色も変わります。
  3. このページを別のタブで開いて選び直すと、こちらのタブの配色も変わります。

CSPで許可できるスクリプト

インラインスクリプトは、ColorSchemeScriptに渡すnonceか、スクリプトのハッシュでCSPに許可させます。'unsafe-inline'は要りません。

colorSchemeScriptHash()は、インストールしたバージョンのスクリプトからハッシュを計算します。ポリシーを書く場所で毎回呼べば、更新しても古い値が残りません。

src/routes/layout.tsx
<head>
  <ColorSchemeScript nonce={nonce()} />
</head>
csp.ts
const scriptSrc = ["'self'", await colorSchemeScriptHash()];

選んだ配色の保存

訪問者の選択は@k8ordo/stateのdefineLocalStateでlocalStorageに保存します。訪問者が選ぶまでは何も保存しません。

あとからdefaultPreferenceを変えると、まだ選んでいない訪問者全員の表示が変わります。複数のタブを開いていても、選択は1つにそろいます。

preference.tsx
colorSchemeState.storageKey;
// 'k8ordo-state:color-scheme'

localStorage.getItem(colorSchemeState.storageKey);
// '{"preference":"dark"}'

const [{ preference }] = useAppState(colorSchemeState);