Dark Mode

Theme management is flexible and personal aspect of application design, so we don’t include a theme provider by default. We recommend using next-themes to easily add dark mode or custom theming to your Next.js app.

Install next-themes

To get started with dark mode, install the next-themes package:

npm install next-themes

Create a Theme Provider

Create a ThemeProvider component to manage the theme state.

components/theme-provider.tsx

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

Wrap your root layout

Wrap your root layout with the ThemeProvider to enable theme switching.

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

Add a Theme Toggle Button

Add a button to toggle between light and dark modes.

components/theme-toggler.tsx

"use client"
 
import { SVGProps, useEffect, useState } from "react"
import { Button, ButtonProps } from "@mijn-ui/react"
import { useTheme } from "next-themes"
 
/* -------------------------------------------------------------------------- */
 
const ThemeToggler = ({ ...props }: ButtonProps) => {
  const [mounted, setMounted] = useState(false)
  const { setTheme, resolvedTheme } = useTheme()
 
  useEffect(() => setMounted(true), [])
 
  if (!mounted) return
 
  if (resolvedTheme === "dark") {
    return (
      <Button onClick={() => setTheme("light")} {...props}>
        <SunIcon fontSize={16} />
      </Button>
    )
  }
  if (resolvedTheme === "light") {
    return (
      <Button onClick={() => setTheme("dark")} {...props}>
        <MoonIcon fontSize={14} />
      </Button>
    )
  }
}
 
export default ThemeToggler
 
/* -------------------------------------------------------------------------- */
 
function SunIcon(props: SVGProps<SVGSVGElement>) {
  return (
    <svg
      stroke="currentColor"
      fill="none"
      strokeWidth={2}
      viewBox="0 0 24 24"
      strokeLinecap="round"
      strokeLinejoin="round"
      height="1em"
      width="1em"
      xmlns="http://www.w3.org/2000/svg"
      {...props}
    >
      <circle cx={12} cy={12} r={5} />
      <path d="M12 1L12 3" />
      <path d="M12 21L12 23" />
      <path d="M4.22 4.22L5.64 5.64" />
      <path d="M18.36 18.36L19.78 19.78" />
      <path d="M1 12L3 12" />
      <path d="M21 12L23 12" />
      <path d="M4.22 19.78L5.64 18.36" />
      <path d="M18.36 5.64L19.78 4.22" />
    </svg>
  )
}
 
function MoonIcon(props: SVGProps<SVGSVGElement>) {
  return (
    <svg
      stroke="currentColor"
      fill="none"
      strokeWidth={2}
      viewBox="0 0 24 24"
      strokeLinecap="round"
      strokeLinejoin="round"
      height="1em"
      width="1em"
      xmlns="http://www.w3.org/2000/svg"
      {...props}
    >
      <path d="M21 12.79A9 9 0 1111.21 3 7 7 0 0021 12.79z" />
    </svg>
  )
}

Install next-themes

Create a Theme Provider

Wrap your root layout

Add a Theme Toggle Button

On this page