Files
upstream-shadcn-ui/apps/v4/content/docs/dark-mode/next.mdx
upstream-mirror 1416db152c
All checks were successful
Release / Create Version PR or Publish Stable Release (push) Has been skipped
Release / Publish Prerelease to NPM (push) Has been skipped
Monitor Registries / Monitor registry health (push) Has been skipped
snapshot of https://github.com/shadcn-ui/ui.git (main, 2026-09-15; blobs > 131072B omitted)
2026-09-15 22:44:43 +05:00

71 lines
1.4 KiB
Plaintext

---
title: Next.js
description: Adding dark mode to your Next.js app.
---
<Steps>
## Install next-themes
Start by installing `next-themes`:
```bash
npm install next-themes
```
## Create a theme provider
```tsx title="components/theme-provider.tsx" showLineNumbers
"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
Add the `ThemeProvider` to your root layout and add the `suppressHydrationWarning` prop to the `html` tag.
```tsx {1,6,9-14,16} title="app/layout.tsx" showLineNumbers
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
Place a mode toggle on your site to toggle between light and dark mode.
<ComponentPreview
styleName="new-york-v4"
name="mode-toggle"
className="[&_.preview]:items-start"
/>
</Steps>