Astro

Dark mode

Create an inline theme script

src/pages/index.astro

---
import '../styles/globals.css'
---
 
<script is:inline>
	const getThemePreference = () => {
		if (typeof localStorage !== 'undefined' && localStorage.getItem('theme')) {
			return localStorage.getItem('theme');
		}
		return window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light';
	};
	const isDark = getThemePreference() === 'dark';
	document.documentElement.classList[isDark ? 'add' : 'remove']('dark');
 
	if (typeof localStorage !== 'undefined') {
		const observer = new MutationObserver(() => {
			const isDark = document.documentElement.classList.contains('dark');
			localStorage.setItem('theme', isDark ? 'dark' : 'light');
		});
		observer.observe(document.documentElement, { attributes: true, attributeFilter: ['class'] });
	}
</script>
 
<html lang="en">
	<body>
      <h1>Astro</h1>
	</body>
</html>
</script>

Add a mode toggle

src/components/ModeToggle.tsx

import * as React from "react"
import { Moon, Sun } from "lucide-react"
 
import { Button } from "~/components/ui/button"
import {
  DropdownMenu,
  DropdownMenuContent,
  DropdownMenuItem,
  DropdownMenuTrigger,
} from "~/components/ui/dropdown-menu"
 
export function ModeToggle() {
  const [theme, setThemeState] = React.useState<
    "theme-light" | "dark" | "system"
  >("theme-light")
 
  React.useEffect(() => {
    const isDarkMode = document.documentElement.classList.contains("dark")
    setThemeState(isDarkMode ? "dark" : "theme-light")
  }, [])
 
  React.useEffect(() => {
    const isDark =
      theme === "dark" ||
      (theme === "system" &&
        window.matchMedia("(prefers-color-scheme: dark)").matches)
    document.documentElement.classList[isDark ? "add" : "remove"]("dark")
  }, [theme])
 
  return (
    <DropdownMenu>
      <DropdownMenuTrigger asChild>
        <Button variant="outline" size="icon">
          <Sun className="h-[1.2rem] w-[1.2rem] rotate-0 scale-100 transition-all dark:-rotate-90 dark:scale-0" />
          <Moon className="absolute h-[1.2rem] w-[1.2rem] rotate-90 scale-0 transition-all dark:rotate-0 dark:scale-100" />
          <span className="sr-only">Toggle theme</span>
        </Button>
      </DropdownMenuTrigger>
      <DropdownMenuContent align="end">
        <DropdownMenuItem onClick={() => setThemeState("theme-light")}>
          Light
        </DropdownMenuItem>
        <DropdownMenuItem onClick={() => setThemeState("dark")}>
          Dark
        </DropdownMenuItem>
        <DropdownMenuItem onClick={() => setThemeState("system")}>
          System
        </DropdownMenuItem>
      </DropdownMenuContent>
    </DropdownMenu>
  )
}

Example 1 using Dropdown Menu

in this example, we will use a Dropdown Menu component to toggle between light, dark mode.

src/components/ModeToggle.tsx

import * as React from "react"
import { Moon, Sun } from "lucide-react"
	@@ -98,6 +102,65 @@ export function ModeToggle() {
}

Example 2 using Toggle Group

in this example, we will use a Toggle Group component to toggle between light, dark mode. also, we can change scale of this for smaller view.

src/components/ModeToggle.tsx

import * as React from "react"
import { Sun, Moon, Laptop } from "lucide-react"
 
import { 
  ToggleGroup, 
  ToggleGroupItem 
} from "~/components/ui/toggle-group"
 
export function ModeToggle() {
  const [theme, setThemeState] = React.useState<
    "theme-light" | "dark" | "system"
  >("theme-light")
 
  React.useEffect(() => {
    const isDarkMode = document.documentElement.classList.contains("dark")
    setThemeState(isDarkMode ? "dark" : "theme-light")
  }, [])
 
  React.useEffect(() => {
    const isDark =
      theme === "dark" ||
      (theme === "system" &&
        window.matchMedia("(prefers-color-scheme: dark)").matches)
    document.documentElement.classList[isDark ? "add" : "remove"]("dark")
  }, [theme])
 
  return (
    <ToggleGroup type="single" className="border p-1 rounded-full">
      <ToggleGroupItem
        value="Light"
        className="rounded-full"
        onClick={() => setThemeState("theme-light")}
      >
        <Sun className="h-5 w-5" />
      </ToggleGroupItem>
      <ToggleGroupItem
        value="System"
        className="rounded-full"
        onClick={() => setThemeState("system")}
      >
        <Laptop className="h-5 w-5" />
      </ToggleGroupItem>
      <ToggleGroupItem
        value="Dark"
        className="rounded-full"
        onClick={() => setThemeState("dark")}
      >
        <Moon className="h-5 w-5" />
      </ToggleGroupItem>
    </ToggleGroup>
  )
}

Display the mode toggle

Place a mode toggle on your site to toggle between light and dark mode.

src/pages/index.astro

---
import '../styles/globals.css'
import { ModeToggle } from '~/components/ModeToggle';
---
 
<!-- Inline script -->
 
<html lang="en">
	<body>
      <h1>Astro</h1>
      <ModeToggle client:load />
	</body>
</html>