Files
shadcn-ui/apps/www/content/docs/dark-mode/next.mdx
Abderrahim Guerfi b838ffe8cc docs(www): add missing prop to ThemeProvider (#1447)
Co-authored-by: shadcn <m@shadcn.com>
2023-09-18 16:47:58 +04:00

67 lines
1.4 KiB
Plaintext

---
title: Next.js
description: Adding dark mode to your next app.
---
## Dark mode
<Steps>
### Install next-themes
Start by installing `next-themes`:
```bash
npm install next-themes
```
### Create a theme provider
```tsx title="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.
```tsx {1,9-11} title="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
Place a mode toggle on your site to toggle between light and dark mode.
<ComponentPreview name="mode-toggle" className="[&_.preview]:items-start" />
</Steps>