Next.js

Docs

Next.js

Adding dark mode to your next app.

Dark mode

Install next-themes

Start by installing next-themes:

npm install next-themes

Create a theme provider

components/theme-provider.tsx

"use client"
 
import * as React from "react"
import { ThemeProvider as NextThemesProvider } from "next-themes"
import { type ThemeProviderProps } from "next-themes/dist/types"
 
export function ThemeProvider({ children, ...props }: ThemeProviderProps) {
  return <NextThemesProvider {...props}>{children}</NextThemesProvider>
}

Wrap your root layout

Add the ThemeProvider to your root layout.

app/layout.tsx

import { ThemeProvider } from "~/components/theme-provider"
 
export default function RootLayout({ children }: RootLayoutProps) {
  return (
    <>
      <html lang="en" suppressHydrationWarning>
        <head />
        <body>
          <ThemeProvider
            attribute="class"
            defaultTheme="system"
            enableSystem
            disableTransitionOnChange
          >
            {children}
          </ThemeProvider>
        </body>
      </html>
    </>
  )
}

Add a mode toggle

Example 1 using Dropdown Menu

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

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.

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

Contribute