@k8ordo/color-scheme

切り替えボタン

useColorScheme()の戻り値で、ライトとダークのトグルと「システム」を含む3択を作ります。ハイドレーションの前に表示が食い違わない書き方も扱います。

このページの内容

戻り値

tsx
const { scheme, preference, setPreference } = useColorScheme();

Client Componentで呼ぶと、ルートレイアウトのプロバイダが決めた値が3つ返ります。

  • scheme:画面に出ている配色で、'light'か'dark'です。訪問者の選択があればその値、無ければプロバイダの既定値です。既定値が'system'ならOSの設定に従います。
  • preference:訪問者が選んだ値で、'light'か'dark'か'system'です。何も選んでいないときは'system'です。
  • setPreference:選んだ値を保存する関数です。'system'を渡すと保存した値を消し、プロバイダの既定値に戻ります。

フックはプロバイダが決めた値を読むだけで、<html>のクラスにもlocalStorageにも触りません。ボタンがいくつあっても1つのプロバイダが決めるので、表示は食い違いません。

2択のトグル

scheme-toggle.tsx
'use client';

import { useColorScheme } from '@k8ordo/color-scheme';

export function SchemeToggle() {
  const { scheme, setPreference } = useColorScheme();
  const next = scheme === 'dark' ? 'light' : 'dark';
`scheme`の反対の値

  return (
    <button
      onClick={() => {
        setPreference(next);
      }}
      type="button"
    >
      Switch to {next}
    </button>
  );
}

ライトとダークを行き来するだけなら、schemeの反対の値を保存します。preferenceからは、次に切り替える先が分かりません。

一度押すと選択が保存され、それ以降はOSの設定を変えても配色は変わりません。OSの設定に戻せるようにするなら、次の3択にします。

このサイトのヘッダーにある切り替えボタンも、このトグルです。

「システム」を含む3択

scheme-select.tsx
'use client';

import { useColorScheme } from '@k8ordo/color-scheme';
import type { ColorSchemePreference } from '@k8ordo/color-scheme';

export function SchemeSelect() {
  const { scheme, preference, setPreference } = useColorScheme();

  return (
    <select
      onChange={(event) => {
        setPreference(
          event.currentTarget.value as ColorSchemePreference,
        );
      }}
      value={preference}
    >
      <option value="system">System ({scheme})</option>
      <option value="light">Light</option>
      <option value="dark">Dark</option>
    </select>
  );
}

OSの設定に従う状態も選べるようにするなら、preferenceをそのまま選択肢の値にします。

一度も選んでいない訪問者も、選んだあとで「システム」に戻した訪問者も、preferenceは'system'です。

「システム」の選択肢にschemeを添えると、OSの設定でいまどちらの配色になっているかが分かります。

既定値

layout.tsx
<head>
  <ColorSchemeScript defaultPreference="dark" />
</head>
<body>
  <ColorSchemeProvider defaultPreference="dark">
    {children}
  </ColorSchemeProvider>
</body>

何も選んでいない訪問者に出す配色は、defaultPreferenceで決めます。最初の描画の前はColorSchemeScriptが、ハイドレーションのあとはプロバイダが使うので、2つに同じ値を渡します。省略すると'system'で、OSの設定に従います。

既定値は保存されません。あとで既定値を変えると、まだ選んでいない訪問者には新しい既定値の配色が出ます。選んだことのある訪問者は自分の選択のままです。インラインスクリプトにも同じ既定値が入るので、最初の描画から新しい既定値で描かれます。

既定値が'system'でないときは、「システム」という選択肢の名前が合いません。preferenceの'system'は「何も選んでいない」という意味なので、選択肢の文言は「既定」などにします。

警告

落とし穴

CSPでインラインスクリプトをハッシュで許可しているなら、colorSchemeScriptHash()にも同じ既定値を渡します。既定値はスクリプトの文字列に入るので、変えるとハッシュも変わります。詳しくはCSPを見てください。

ハイドレーション前の表示

サーバーはlocalStorageを読めないので、プロバイダは既定値で描きます。既定値が'system'なら、サーバーが描くschemeは'light'です。schemeで選んだアイコンや文言は、ハイドレーションが終わるまでサーバーが描いたschemeのまま表示されます。

ページの色は、インラインスクリプトが付けたdarkクラスに従うので、最初の描画から正しく出ます。食い違うのは、Reactの描画で選んだマークアップだけです。直し方は2つあります。

CSSでの出し分け

scheme-toggle.tsx
export function SchemeToggle() {
  const { scheme, setPreference } = useColorScheme();

  return (
    <button
      onClick={() => {
        setPreference(scheme === 'dark' ? 'light' : 'dark');
      }}
      type="button"
    >
      <span className="dark:hidden">Switch to dark</span>
      <span className="hidden dark:inline">Switch to light</span>
    </button>
  );
}

CSSで出し分けられるものは、両方の状態を描いてdark:バリアントで片方を隠します。ハイドレーションを待たずに正しいほうが見えます。

情報

メモ

このdark:は、<html>のクラスを読むように宣言したバリアントです。@k8ordo/uiのtailwind.cssは宣言済みです。Tailwind CSSの既定のdark:はOSの設定を読むので、Tailwind CSSだけで使うときはdarkクラスのスタイルの「Tailwind CSSのみ」のとおりに宣言します。

ブラウザでの描画

scheme-toggle.tsx
'use client';

import { useColorScheme } from '@k8ordo/color-scheme';
import { Suspense, use } from 'react';
import { browser } from 'react-dom';

import { MoonIcon, SunIcon } from './icons';

function SchemeIcon() {
  use(browser('the stored preference is in localStorage'));
  const { scheme } = useColorScheme();
  return scheme === 'dark' ? <MoonIcon /> : <SunIcon />;
}

export function SchemeToggle() {
  const { scheme, setPreference } = useColorScheme();

  return (
    <button
      aria-label="Toggle color scheme"
      onClick={() => {
        setPreference(scheme === 'dark' ? 'light' : 'dark');
      }}
      type="button"
    >
      <Suspense fallback={<span className="size-5" />}>
        <SchemeIcon />
      </Suspense>
    </button>
  );
}

アイコンの差し替えのように、CSSでは出し分けにくいものもあります。そのマークアップを描くコンポーネントでuse(browser())を呼び、<Suspense>の中に置きます。browserはreact-domからimportします。

fallbackにアイコンと同じ大きさの空の要素を置くと、差し替わったときにボタンの大きさが変わりません。

警告

落とし穴

<Suspense>は省けません。無いとサーバーでの描画が失敗します。

Playground

トグルと3択のデモ

このサイトのプロバイダにつないだトグルと3択で、どちらを操作してもサイト全体の配色が変わります。

試してみる

  1. 3択で「システム」を選ぶと、preferenceはsystemになり、schemeにはOSの設定から決まった配色が入ります。
  2. 「ダークにする」か「ライトにする」を押すと、画面に出ていた配色の反対が保存され、3択も「ダーク」か「ライト」に移ります。
  3. 「システム」を選び直してからOSの外観の設定を切り替えると、schemeだけが変わり、preferenceはsystemのままです。
k8ordo

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