Astroチュートリアルメモ その6-2【アイランドアーキテクチャを使わずにダークモード】

2022/11/10に公開約4,300字

チュートリアルの最後は、前回はアイランドアーキテクチャを使ったけど、そんなの使わなくても色々できるよ、という話。

ネイティブなJavaScriptでダークモードを実装する。

https://docs.astro.build/en/tutorial/6-islands/2/

ヘッダーにクリックで切り替わるアイコン(よくある太陽と月のやつ)をつくり、アイコンをクリックすることでダークモードと切り替わる。

JavaScriptのクリックイベントと、toggleclassListを切り替えるという仕組み。

ユーザー指定のテーマを確認し、テーマの状態をブラウザのローカルストレージに保存する形になっている。

アイコンのコンポーネントを追加

src/components/ThemeIcon.astro
---
---
<div id="themeToggle">
  <svg width="30px" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
    <path class="sun" fill-rule="evenodd" d="M12 17.5a5.5 5.5 0 1 0 0-11 5.5 5.5 0 0 0 0 11zm0 1.5a7 7 0 1 0 0-14 7 7 0 0 0 0 14zm12-7a.8.8 0 0 1-.8.8h-2.4a.8.8 0 0 1 0-1.6h2.4a.8.8 0 0 1 .8.8zM4 12a.8.8 0 0 1-.8.8H.8a.8.8 0 0 1 0-1.6h2.5a.8.8 0 0 1 .8.8zm16.5-8.5a.8.8 0 0 1 0 1l-1.8 1.8a.8.8 0 0 1-1-1l1.7-1.8a.8.8 0 0 1 1 0zM6.3 17.7a.8.8 0 0 1 0 1l-1.7 1.8a.8.8 0 1 1-1-1l1.7-1.8a.8.8 0 0 1 1 0zM12 0a.8.8 0 0 1 .8.8v2.5a.8.8 0 0 1-1.6 0V.8A.8.8 0 0 1 12 0zm0 20a.8.8 0 0 1 .8.8v2.4a.8.8 0 0 1-1.6 0v-2.4a.8.8 0 0 1 .8-.8zM3.5 3.5a.8.8 0 0 1 1 0l1.8 1.8a.8.8 0 1 1-1 1L3.5 4.6a.8.8 0 0 1 0-1zm14.2 14.2a.8.8 0 0 1 1 0l1.8 1.7a.8.8 0 0 1-1 1l-1.8-1.7a.8.8 0 0 1 0-1z"/>
    <path class="moon" fill-rule="evenodd" d="M16.5 6A10.5 10.5 0 0 1 4.7 16.4 8.5 8.5 0 1 0 16.4 4.7l.1 1.3zm-1.7-2a9 9 0 0 1 .2 2 9 9 0 0 1-11 8.8 9.4 9.4 0 0 1-.8-.3c-.4 0-.8.3-.7.7a10 10 0 0 0 .3.8 10 10 0 0 0 9.2 6 10 10 0 0 0 4-19.2 9.7 9.7 0 0 0-.9-.3c-.3-.1-.7.3-.6.7a9 9 0 0 1 .3.8z"/>
  </svg>
</div>

<style>
  .sun { fill: black; }
  .moon { fill: transparent; }
  

  :global(.dark) .sun { fill: transparent; }
  :global(.dark) .moon { fill: white; }
</style>

アイコンはsvgをそのまま載せている。ソースとしては見づらくなるけど、こうやってそのまま張り付けると色とか変えやすくて便利なので、自分もsvgはこんな感じで使いたくなる。でも見づらい。

cssでアイコンの初期色を決めて、.darkがついた時に切り替わる記述になっているっぽいけど、:globalはcssモジュールらしくて、Astroの内部的にcssなどを出力する際に、よきに計らってくれてるらしい。けど仕組みはよくわからない。

Astroで吐き出されたファイルを見ると以下のようになってた。buildしたのも同じだった。

.sun:where(.astro-V5OVAHDL) {
  fill: #000;
}
.moon:where(.astro-V5OVAHDL) {
  fill: transparent;
}
.dark .sun:where(.astro-V5OVAHDL) {
  fill: transparent;
}
.dark .moon:where(.astro-V5OVAHDL) {
  fill: #fff;
}

スクリプトを追加

スタイルの下にjsを追加する。

src/components/ThemeIcon.astro
<script>
  const theme = (() => {
    if (typeof localStorage !== 'undefined' && localStorage.getItem('theme')) {
      return localStorage.getItem('theme');
    }
    if (window.matchMedia('(prefers-color-scheme: dark)').matches) {
      return 'dark';
    }
      return 'light';
  })();
      
  if (theme === 'light') {
    document.documentElement.classList.remove('dark');
  } else {
    document.documentElement.classList.add('dark');
  }

  window.localStorage.setItem('theme', theme);

  const handleToggleClick = () => {
    const element = document.documentElement;
    element.classList.toggle("dark");
    
    const isDark = element.classList.contains("dark");
    localStorage.setItem("theme", isDark ? "dark" : "light");
  }

  document.getElementById("themeToggle").addEventListener("click", handleToggleClick);
</script>

やっていることは単純でブラウザのローカルストレージにライトかダークかを保存していて、アイコンがクリックされると、それが切り替わり、DOMのクラスリストを操作してるというだけ。

最初に変数themeの初期値を判定していて、ローカルストレージにデータがあればそのデータを入れて、無い場合はMedia Queryのprefers-color-schemeをチェックしてダークならdark、そうでないならlightを入れている。

その内容をもとに、ページのHTMLタグのclassListにて、darkを削除するか加えるかを決めている。

setItemでローカルストレージにテーマのデータを保存している。

handleToggleClickは以下はクリックされたときの挙動が書かれていて、クリックするたびにクラス名のdarkが付いたり外れたりする。それに伴って、ローカルストレージもdarklightが切り替わる。

最後はアイコン部分のIDthemeToggleをクリックしたらhandleToggleClickを呼ぶよと書いてある。

最初なんで初期値を判定したり、データをブラウザのローカルストレージに保存したりなんてことしてるのか良くわからなかったのだけど、そういや結構前にほとんどの主要ブラウザでユーザーの指定しているテーマが取得できるようになってたな…と思いだしてちょっと調べて、やっと理解できた。

ダークモードのスタイルシート

src/styles/global.css
.dark body {
  background-color: #0d0950;
  color: #fff;
}

.dark .nav-links a {
  color: #fff;
}

ダークモード用のスタイルシートを設定する。

ヘッダーにインポート

src/components/Header.astro
---
import Hamburger from './Hamburger.astro';
import Navigation from './Navigation.astro';
import ThemeIcon from './ThemeIcon.astro';
---
<header>
 <nav>
   <Hamburger />
   <ThemeIcon />
   <Navigation />
 </nav>
<header>

ヘッダーには先ほどのコンポーネントを追加するだけ。

これでダークモードが実装できる。

アイランドを使わなくてもできますよと、アイランドのチュートリアル項目の最後にわざわざこれが入っているというのが、Astroの設計思想を表す大きなメッセージなのかなという印象。

チュートリアルの最後、about.astrofinishedを更新して終わり。

次回はAstroチュートリアルをやってみて感じたことやAstroの印象などを書く予定。

Discussion

ログインするとコメントできます