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

Jump to bottom

Dark mode flashes in Next.js even with noflash.js #83

Open
markdost opened this issue Jul 1, 2021 · 9 comments
Open

Dark mode flashes in Next.js even with noflash.js #83

markdost opened this issue Jul 1, 2021 · 9 comments

Comments

@markdost
Copy link

markdost commented Jul 1, 2021

The dark mode on my Next.js app still flashes even with adding noflash.js. I have made a dark mode component like so:

import useDarkMode from "use-dark-mode";

import { FiMoon } from "react-icons/fi";

const DarkModeToggle = () => {
  const darkMode = useDarkMode(false);

  return (
    <div className="custom-control custom-switch">
      <input
        type="checkbox"
        className="custom-control-input"
        id="darkmodeSwitch"
        onChange={darkMode.toggle}
        checked={darkMode.value}
        onClick={darkMode.disable}
      />
      <label className="custom-control-label" htmlFor="darkmodeSwitch">
        <FiMoon />
      </label>
    </div>
  );
};

export default DarkModeToggle;

Added noflash.js to the public folder.
Then on _document.js

import Document, { Html, Head, Main, NextScript } from "next/document";

class MyDocument extends Document {
  static async getInitialProps(ctx) {
    const initialProps = await Document.getInitialProps(ctx);
    return { ...initialProps };
  }

  render() {
    return (
      <Html lang="en">
        <Head />
        <body>
          <script src="noflash.js" />
          <Main />
          <NextScript />
        </body>
      </Html>
    );
  }
}

export default MyDocument;

In my SCSS folder I created a simple _dark-mode.scss and added styles for dark mode in there e.g.:

body.light-mode {
  transition: background-color 0.3s ease;
}
body.dark-mode {
  background-color: #121212;
  color: #f5f5f5;
  transition: background-color 0.3s ease;
  img {
    opacity: 0.8;
  }
}

dark_mode_flash
As you can see it flashes and there's also the toggle/switch that is not persistent.
@markdost markdost changed the title Dark mode flash in Next.js even with noflash.js Dark mode flashes in Next.js even with noflash.js Jul 1, 2021
@djD-REK
Copy link

djD-REK commented Jul 1, 2021 via email

@markdost
Copy link
Author

markdost commented Jul 1, 2021

Hey,
I've seen next-themes before and might give that a go, since I might be a nitpicker here but I do not like having the flash.

@markdost
Copy link
Author

markdost commented Jul 2, 2021

@djD-REK Thanks again for your recommendation, it works great with no flash! Do you have any idea how to apply a toggle to an input like:

<input
  type="checkbox"
  className="custom-control-input"
  id="darkmodeSwitch"
/>

The example of next-themes uses 2 buttons to do the switch.

@DoctorDerek
Copy link

Hey @markdost yeah I got the behavior you want using a useState and useEffect combination if you check out the demo I sent you. It's a little convoluted because of the animation involved, but it should be pretty clear. Let me know if it's not 😄

@markdost
Copy link
Author

markdost commented Jul 2, 2021

@DoctorDerek Yes I got it working now in the end by doing:

const DarkModeToggle = () => {
  const [mounted, setMounted] = useState(false);
  const { theme, setTheme } = useTheme();

  // When mounted on client, now we can show the UI
  useEffect(() => setMounted(true), []);

  if (!mounted) return null;

  return (
    <div className="custom-control custom-switch">
      <input
        type="checkbox"
        className="custom-control-input"
        id="darkmodeSwitch"
        onChange={() => setTheme(theme === "dark" ? "light" : "dark")}
        checked={theme === "dark"}
      />
      <label className="custom-control-label" htmlFor="darkmodeSwitch">
        <FiMoon />
      </label>
    </div>
  );
};

@djD-REK
Copy link

djD-REK commented Jul 2, 2021 via email

@okalil
Copy link

okalil commented Jul 7, 2021

The problem with useEffect is that you lose SSR, causing SEO problems

@djD-REK
Copy link

djD-REK commented Jul 7, 2021 via email

@markdost
Copy link
Author

markdost commented Jul 7, 2021

@okalil I see, so it would cause problems when doing SSR. Keep in mind I switched from this library to next-themes, which might still cause the same problem if doing SSR. The example I gave at #83 (comment) is with next-themes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@DoctorDerek @markdost @djD-REK @okalil