Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add example for dark/light mode automatic color switching #2035

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add example for dark/light mode automatic color switching #2035

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
149 changes: 149 additions & 0 deletions src/docs/dark-mode.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,155 @@ To make this as easy as possible, Tailwind includes a `dark` variant that lets y

By default this uses the `prefers-color-scheme` CSS media feature, but you can also build sites that support [toggling dark mode manually](#toggling-dark-mode-manually) by overriding the dark variant.

## Adding Dark/Light Color Theme

If you want colors to change automatically based on the light or dark mode, you can utilize `color-scheme` to define a light and dark theme and define it in your `@theme`

**tailwind.css**

```css
@import 'tailwindcss';
@import "./colors.css" layer(base);

@custom-variant dark (&:where([data-theme="dark"], [data-theme="dark"] *, .dark, .dark *));

@theme {
--color-background: var(--color-background);
--color-background-foreground: var(--color-foreground);
--color-foreground: var(--color-foreground);
--color-foreground-primary: var(--color-primary-foreground);
--color-primary: var(--color-primary);
--color-primary-foreground: var(--color-primary-foreground);
--color-secondary: var(--color-secondary);
--color-secondary-foreground: var(--color-secondary-foreground);
--color-destructive: var(--color-destructive);
--color-destructive-foreground: var(--color-destructive-foreground);
--color-muted: var(--color-muted);
--color-muted-foreground: var(--color-muted-foreground);
--color-accent: var(--color-accent);
--color-accent-foreground: var(--color-accent-foreground);
--color-popover: var(--color-popover);
--color-popover-foreground: var(--color-popover-foreground);
--color-card: var(--color-card);
--color-card-foreground: var(--color-card-foreground);
--color-border: var(--color-border);
--color-input: var(--color-input);
--color-ring: var(--color-ring);
--color-chart-1: var(--color-chart-1);
--color-chart-2: var(--color-chart-2);
--color-chart-3: var(--color-chart-3);
--color-chart-4: var(--color-chart-4);
--color-chart-5: var(--color-chart-5);
--color-sidebar: var(--color-sidebar-background);
--color-sidebar-foreground: var(--color-sidebar-foreground);
--color-sidebar-primary: var(--color-sidebar-primary);
--color-sidebar-primary-foreground: var(--color-sidebar-primary-foreground);
--color-sidebar-accent: var(--color-sidebar-accent);
--color-sidebar-accent-foreground: var(--color-sidebar-accent-foreground);
--color-sidebar-border: var(--color-sidebar-border);
--color-sidebar-ring: var(--color-sidebar-ring);
}
```

**colors.css**

```css
html {
color-scheme: light dark;

&[data-theme="light"] {
--color-background: var(--color-white);
--color-foreground: var(--color-neutral-950);

--color-card: var(--color-white);
--color-card-foreground: var(--color-neutral-950);

--color-popover: var(--color-white);
--color-popover-foreground: var(--color-neutral-950);

--color-primary: var(--color-neutral-900);
--color-primary-foreground: var(--color-neutral-50);

--color-secondary: var(--color-neutral-100);
--color-secondary-foreground: var(--color-neutral-900);

--color-muted: var(--color-neutral-100);
--color-muted-foreground: var(--color-neutral-500);

--color-accent: var(--color-neutral-100);
--color-accent-foreground: var(--color-neutral-900);

--color-destructive: var(--color-red-500);
--color-destructive-foreground: var(--color-neutral-50);

--color-border: var(--color-neutral-200);
--color-input: var(--color-neutral-200);
--color-ring: var(--color-neutral-900);

--color-chart-1: var(--color-neutral-500);
--color-chart-2: var(--color-neutral-600);
--color-chart-3: var(--color-neutral-700);
--color-chart-4: var(--color-neutral-800);
--color-chart-5: var(--color-neutral-900);

--color-sidebar-background: var(--color-neutral-100);
--color-sidebar-foreground: var(--color-neutral-800);
--color-sidebar-primary: var(--color-neutral-700);
--color-sidebar-primary-foreground: var(--color-neutral-50);
--color-sidebar-accent: var(--color-neutral-300);
--color-sidebar-accent-foreground: var(--color-neutral-900);
--color-sidebar-border: var(--color-neutral-200);
--color-sidebar-ring: var(--color-neutral-600);
}


&[data-theme="dark"] {
--color-background: var(--color-neutral-900);
--color-foreground: var(--color-neutral-50);

--color-card: var(--color-neutral-950);
--color-card-foreground: var(--color-neutral-50);

--color-popover: var(--color-neutral-900);
--color-popover-foreground: var(--color-neutral-50);

--color-primary: var(--color-neutral-50);
--color-primary-foreground: var(--color-neutral-900);

--color-secondary: var(--color-neutral-800);
--color-secondary-foreground: var(--color-neutral-50);

--color-muted: var(--color-neutral-800);
--color-muted-foreground: var(--color-neutral-400);

--color-accent: var(--color-neutral-800);
--color-accent-foreground: var(--color-neutral-50);

--color-destructive: var(--color-red-900);
--color-destructive-foreground: var(--color-neutral-50);

--color-border: var(--color-neutral-800);
--color-input: var(--color-neutral-800);
--color-ring: var(--color-neutral-300);

--color-chart-1: var(--color-neutral-600);
--color-chart-2: var(--color-neutral-700);
--color-chart-3: var(--color-neutral-800);
--color-chart-4: var(--color-neutral-900);
--color-chart-5: var(--color-neutral-950);

--color-sidebar-background: var(--color-neutral-900);
--color-sidebar-foreground: var(--color-neutral-100);
--color-sidebar-primary: var(--color-neutral-800);
--color-sidebar-primary-foreground: var(--color-neutral-50);
--color-sidebar-accent: var(--color-neutral-700);
--color-sidebar-accent-foreground: var(--color-neutral-100);
--color-sidebar-border: var(--color-neutral-800);
--color-sidebar-ring: var(--color-neutral-600);
}
}
```

## Toggling dark mode manually

If you want your dark theme to be driven by a CSS selector instead of the `prefers-color-scheme` media query, override the `dark` variant to use your custom selector:
Expand Down