@k8ordo/color-scheme

はじめる

@k8ordo/color-schemeで、ライトとダークを切り替えるボタンを1つ作ります。

このページの内容

インストール

bash
npm install @k8ordo/color-scheme @k8ordo/state zod

次の環境で動きます。

  • React 19.3以上
  • TypeScriptで書くなら、TypeScript 7以上

エージェント向けのガイドはnode_modules/@k8ordo/color-scheme/docs/GUIDE.mdに入っています。AGENTS.mdなどからこのパスを参照させてください。

情報

メモ

プロバイダは、選んだ配色を@k8ordo/stateのローカル状態としてlocalStorageに保存します。@k8ordo/stateとzodはそのために必要です。保存の形は設定の保存先を見てください。

レイアウトへの配置

src/routes/layout.tsx
import {
  ColorSchemeProvider,
  ColorSchemeScript,
} from '@k8ordo/color-scheme';
import type { ReactNode } from 'react';

export default function RootLayout({
  children,
}: {
  children: ReactNode;
}) {
  return (
    <html lang="en" suppressHydrationWarning>
スクリプトが付けるクラスについての警告を止める
      <head>
        <ColorSchemeScript />
最初の描画の前にクラスを付ける
      </head>
      <body>
        <ColorSchemeProvider>{children}</ColorSchemeProvider>
ページ全体を包む
      </body>
    </html>
  );
}

ルートレイアウトの<head>に<ColorSchemeScript />を置きます。<body>の中には<ColorSchemeProvider>を置き、ページ全体を包みます。プロバイダはClient Componentですが、ルートレイアウトはServer Componentのままで構いません。

ColorSchemeScriptは、インラインの<script>を出力します。このスクリプトは保存した選択を読みます。選択が無ければOSの設定に従い、ダークなら最初の描画の前に<html>へdarkクラスを付けます。

このクラスはサーバーのHTMLにはありません。<html>にsuppressHydrationWarningを付けないと、開発時のReactがハイドレーションの食い違いとして報告します。

情報

メモ

スクリプトは、どのスタイルシートよりも前にある必要があります。後ろにあると、スタイルシートの読み込みを待つ間にライトの画面が描かれることがあります。@k8ordo/frameworkは、<head>に書いたインラインスクリプトをスタイルシートより前に移します。

darkクラスの色

globals.css
:root {
  color-scheme: light;
  --page-bg: #ffffff;
  --page-fg: #1f1f1f;
}

:root.dark {
`dark`クラスが付いたときの色
  color-scheme: dark;
  --page-bg: #1f1f1f;
  --page-fg: #f5f5f5;
}

body {
  background: var(--page-bg);
  color: var(--page-fg);
}

このパッケージが変えるのは、<html>のdarkクラスだけです。何色にするかは、スタイルシートで決めます。

color-schemeも一緒に切り替えると、スクロールバーやフォーム部品のようにブラウザが描く部品も、選んだ配色になります。

情報

メモ

@k8ordo/uiのスタイルシートを読み込んでいれば、トークンもcolor-schemeもすでにこのクラスで切り替わります。Tailwind CSSのdark:と合わせる書き方はdarkクラスのスタイルを見てください。

フックでの切り替え

scheme-toggle.tsx
'use client';

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

export function SchemeToggle() {
  const { scheme, setPreference } = useColorScheme();
`scheme`は表示中の配色
  const next = scheme === 'dark' ? 'light' : 'dark';

  return (
    <button
      onClick={() => {
        setPreference(next);
選んだ配色を保存する
      }}
      type="button"
    >
      Switch to {next}
    </button>
  );
}

Client ComponentでuseColorScheme()を呼び、返る値のうちschemeとsetPreferenceを使います。setPreferenceに渡した配色はlocalStorageに保存され、プロバイダが<html>のクラスを付け替えます。

情報

メモ

ボタンの文言はschemeから決めています。ハイドレーションが終わるまでは、サーバーで描画した既定の配色に合わせた文言になります。これを避ける方法は切り替えボタンを見てください。

Playground

切り替えのデモ

ここまでで作ったボタンを、このサイトのプロバイダにつないでいます。

試してみる

  1. ボタンを押すと、このサイト全体の配色が切り替わります。ボタンの文言も反対の配色に変わります。
  2. ヘッダーの配色の切り替えボタンを押すと、こちらのボタンの文言も一緒に変わります。どちらのボタンも同じプロバイダを読んでいます。
  3. ダークにした状態でページを再読み込みすると、白い画面を挟まずに最初からダークで表示されます。
k8ordo

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