Dark mode
Create a theme provider
import { createContext, useContext, useEffect, useState } from "react"
type Theme = "dark" | "light" | "system"
type ThemeProviderProps = {
children: React.ReactNode
defaultTheme?: Theme
storageKey?: string
}
type ThemeProviderState = {
theme: Theme
setTheme: (theme: Theme) => void
}
const initialState: ThemeProviderState = {
theme: "system",
setTheme: () => null,
}
const ThemeProviderContext = createContext<ThemeProviderState>(initialState)
export function ThemeProvider({
children,
defaultTheme = "system",
storageKey = "vite-ui-theme",
...props
}: ThemeProviderProps) {
const [theme, setTheme] = useState<Theme>(
() => (localStorage.getItem(storageKey) as Theme) || defaultTheme
)
useEffect(() => {
const root = window.document.documentElement
root.classList.remove("light", "dark")
if (theme === "system") {
const systemTheme = window.matchMedia("(prefers-color-scheme: dark)")
.matches
? "dark"
: "light"
root.classList.add(systemTheme)
return
}
root.classList.add(theme)
}, [theme])
const value = {
theme,
setTheme: (theme: Theme) => {
localStorage.setItem(storageKey, theme)
setTheme(theme)
},
}
return (
<ThemeProviderContext.Provider {...props} value={value}>
{children}
</ThemeProviderContext.Provider>
)
}
export const useTheme = () => {
const context = useContext(ThemeProviderContext)
if (context === undefined)
throw new Error("useTheme must be used within a ThemeProvider")
return context
}
Wrap your root layout
Add the ThemeProvider
to your root layout.
import { ThemeProvider } from "~/components/theme-provider"
function App() {
return (
<ThemeProvider defaultTheme="dark" storageKey="vite-ui-theme">
{children}
</ThemeProvider>
)
}
export default App
Add a mode toggle
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.
import { Sun, Moon, Laptop } from "lucide-react"
import {
ToggleGroup,
ToggleGroupItem
} from "~/components/ui/toggle-group"
import { useTheme } from "~/components/theme-provider"
export function ModeToggle() {
const { setTheme } = useTheme()
return (
<ToggleGroup type="single" className="border p-1 rounded-full">
<ToggleGroupItem
value="Light"
className="rounded-full"
onClick={() => setTheme("light")}
>
<Sun className="h-5 w-5" />
</ToggleGroupItem>
<ToggleGroupItem
value="System"
className="rounded-full"
onClick={() => setTheme("system")}
>
<Laptop className="h-5 w-5" />
</ToggleGroupItem>
<ToggleGroupItem
value="Dark"
className="rounded-full"
onClick={() => setTheme("dark")}
>
<Moon className="h-5 w-5" />
</ToggleGroupItem>
</ToggleGroup>
)
}
Place a mode toggle on your site to toggle between light and dark mode.
import { Moon, Sun } from "lucide-react"
import { Button } from "~/components/ui/button"
import {
DropdownMenu,
DropdownMenuContent,
DropdownMenuItem,
DropdownMenuTrigger,
} from "~/components/ui/dropdown-menu"
import { useTheme } from "~/components/theme-provider"
export function ModeToggle() {
const { setTheme } = useTheme()
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={() => setTheme("light")}>
Light
</DropdownMenuItem>
<DropdownMenuItem onClick={() => setTheme("dark")}>
Dark
</DropdownMenuItem>
<DropdownMenuItem onClick={() => setTheme("system")}>
System
</DropdownMenuItem>
</DropdownMenuContent>
</DropdownMenu>
)
}