@k8ordo/color-scheme

darkクラスのスタイル

<html>に付くdarkクラスをスタイルシートで読み、ダークの色に切り替えます。Tailwind CSSでも素のCSSでも書けます。

このページの内容

クラスが付く場所

html
<html class="dark">

配色がダークに決まったときだけ、<html>にdarkクラスが付きます。ライトのときは何も付かず、lightというクラスはありません。クラスの名前も付ける要素も変えられません。

最初の描画の前にColorSchemeScriptがクラスを付けます。そのあとはColorSchemeProviderが付け外しします。スタイルシートはこのクラスを読むだけで、訪問者の選択に従います。

@k8ordo/uiのトークンと、tailwind.cssのdark:とlight:のバリアントはこのクラスを読みます。詳しくは@k8ordo/uiのテーマの「ダークモード」を見てください。

Tailwind CSSのみ

globals.css
@import 'tailwindcss';

@custom-variant dark (&:where(.dark, .dark *));
`dark:`がクラスを読むように宣言し直す

Tailwind CSS 4のdark:は、既定ではprefers-color-schemeを読みます。そのままではOSの設定に従い、訪問者の選択を無視します。

素のCSS

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

:root.dark {
`:root`より詳細度が高い
  color-scheme: dark;
  --page-bg: #1f1f1f;
  --page-fg: #f5f5f5;
}

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

色をカスタムプロパティに置き、:root.darkで値を切り替えます。.darkだけだと:rootと詳細度が同じで、後に書いたほうが優先されます。:root.darkなら、ライトの値を後に書いてもダークの値が優先されます。

color-schemeプロパティ

globals.css
:root {
  color-scheme: light dark;
  color-scheme: light;
}

.dark {
  color-scheme: dark;
}

color-schemeプロパティは、スクロールバーやフォーム部品など、ブラウザが自分で描くものの配色を決めます。このパッケージは設定しません。@k8ordo/uiを使わないなら、色と一緒に自分で宣言します。

light darkと書くと、ブラウザがprefers-color-schemeで配色を選びます。OSがダークで訪問者がライトを選んでいると、スクロールバーやフォーム部品がダークで描かれ、選んだ配色とずれます。そのため、色と同じクラスで切り替えます。

color-schemeがクラスに従っていれば、light-dark()関数もクラスに従います。color: light-dark(#1f1f1f, #f5f5f5)のように、1つの宣言にライトとダークの値を書けます。

ブラウザのUIの色

src/routes/layout.tsx
<head>
  <ColorSchemeScript
    themeColor={{ light: '#ffffff', dark: '#1f1f1f' }}
  />
</head>

アドレスバーやステータスバーの色は、<meta name="theme-color">で決まります。mediaでprefers-color-schemeを指定したmetaはOSの設定に従い、訪問者の選択とずれます。

ColorSchemeScriptのthemeColorにライトとダークの色を渡すと、スクリプトがクラスと同時にtheme-colorのmetaを書きます。ハイドレーションのあとは、ColorSchemeProviderが選択に合わせて書き換えます。

訪問者が配色を選んでいるか、既定値が'light'か'dark'なら、OSの設定にかかわらずその配色の色になります。既定値が'system'で何も選んでいない間は、配色ごとのmetaがOSの設定に従います。

色はスクリプトの文字列に入ります。ハッシュで許可するときに渡す値はCSPを見てください。

警告

落とし穴

ページではtheme-colorのmetaを書かないでください。Reactは<meta>をスタイルシートの後ろに書くので、スクリプトが書いたmetaより後ろになり、使われません。

OSのコントラストの設定

globals.css
@media (prefers-contrast: more) {
  :root {
    --page-fg: #000000;
  }

  :root.dark {
    --page-fg: #ffffff;
  }
}

prefers-contrast: moreとforced-colors: activeはOSの設定で、このパッケージは保存も切り替えもしません。自分のCSSで対応するときは、ライトとダークの両方に値を用意します。

@k8ordo/uiのスタイルシートは、:rootと.darkの両方にハイコントラストの値を持っているので、どちらを選んでいても効きます。詳しくは@k8ordo/uiのテーマの「ハイコントラスト」を見てください。

k8ordo

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