Menu

Dark Mode Support

Here’s a complete setup for Dark Mode Support in your Next.js + Tailwind CSS + Docsta project, following best practices for toggling themes using tailwindcss’s dark mode and persisting the user’s preference.

✅ 1. Enable Dark Mode in tailwind.config.js

// tailwind.config.js
module.exports = {
darkMode: 'class', // Use 'class' strategy
content: [
'./app/**/*.{js,ts,jsx,tsx}',
'./pages/**/*.{js,ts,jsx,tsx}',
'./components/**/*.{js,ts,jsx,tsx}',
],
theme: {
extend: {},
},
plugins: [],
}

✅ 2. Create a Theme Provider (theme-provider.tsx)

'use client'

import { createContext, useEffect, useState, useContext } from 'react'

const ThemeContext = createContext({
theme: 'light',
toggleTheme: () => {},
})

export const useTheme = () => useContext(ThemeContext)

export const ThemeProvider = ({ children }: { children: React.ReactNode }) => {
const [theme, setTheme] = useState('light')

useEffect(() => {
const storedTheme = localStorage.getItem('theme') || 'light'
setTheme(storedTheme)
document.documentElement.classList.toggle('dark', storedTheme === 'dark')
}, [])

const toggleTheme = () => {
const newTheme = theme === 'light' ? 'dark' : 'light'
setTheme(newTheme)
localStorage.setItem('theme', newTheme)
document.documentElement.classList.toggle('dark', newTheme === 'dark')
}

return (
<ThemeContext.Provider value={{ theme, toggleTheme }}>
{children}
</ThemeContext.Provider>
)
}

✅ 3. Wrap your app in ThemeProvider

App Router: app/layout.tsx

import { ThemeProvider } from '@/components/theme-provider'

export default function RootLayout({ children }: { children: React.ReactNode }) {
return (
<html lang="en">
<body>
<ThemeProvider>{children}</ThemeProvider>
</body>
</html>
)
}

Pages Router: pages/_app.tsx

import { ThemeProvider } from '@/components/theme-provider'

function MyApp({ Component, pageProps }) {
return (
<ThemeProvider>
<Component {...pageProps} />
</ThemeProvider>
)
}
export default MyApp

✅ 4. Add a Toggle Button

'use client'

import { useTheme } from '@/components/theme-provider'
import { Moon, Sun } from 'lucide-react' // Optional icon library

export default function ThemeToggle() {
const { theme, toggleTheme } = useTheme()

return (
<button
onClick={toggleTheme}
className="p-2 rounded-md hover:bg-gray-100 dark:hover:bg-gray-800"
aria-label="Toggle Dark Mode"
>
{theme === 'dark' ? <Sun size={20} /> : <Moon size={20} />}
</button>
)
}

✅ 5. Add Dark Mode Classes in Your Styles

<div className="bg-white text-black dark:bg-zinc-900 dark:text-white min-h-screen">
{/* Page content */}
</div>

Use dark: prefix for any class where you want a dark-mode variant.

Result:

  • ✅ Dark mode toggles on click
  • ✅ User preference is saved in localStorage
  • ✅ Tailwind handles all dark styles via dark: classes

What did you think of this content?

like-icon

It was helpful

dislike-icon

It was not helpful

feedback-icon

I have a feedback