如何修复 NextJS 中的暗模式背景颜色闪烁？

Question

所以我的问题是 Next.js 在客户端无法访问 localStorage，因此将发布默认情况下有或没有 [=11] 的 HTML =].

这意味着当用户重新加载页面时，<html> 暂时没有 class="dark"，导致背景颜色闪烁，然后 javascript 执行和 [=11] =] 被添加到 <html>。如果我将 HTML 与 class="dark" 一起发布，则会出现相同的问题，但相反：然后在 class="dark" 从 <html> 中删除之前，浅色模式用户将体验到暗背景颜色的闪烁.

有没有办法在页面呈现之前执行一些javascript？然后我就可以根据用户的 localStorage.

添加或不添加 class="dark" 到 <html>

Answer 1

当然，将一个 noflash.js 文件添加到您的 public 目录，其中包含以下内容

(function () {
    // Change these if you use something different in your hook.
    var storageKey = 'darkMode';
    var classNameDark = 'dark-mode';
    var classNameLight = 'light-mode';

    function setClassOnDocumentBody(darkMode) {
        document.body.classList.add(darkMode ? classNameDark : classNameLight);
        document.body.classList.remove(darkMode ? classNameLight : classNameDark);
    }

    var preferDarkQuery = '(prefers-color-scheme: dark)';
    var mql = window.matchMedia(preferDarkQuery);
    var supportsColorSchemeQuery = mql.media === preferDarkQuery;
    var localStorageTheme = null;
    try {
        localStorageTheme = localStorage.getItem(storageKey);
    } catch (err) {}
    var localStorageExists = localStorageTheme !== null;
    if (localStorageExists) {
        localStorageTheme = JSON.parse(localStorageTheme);
    }

    // Determine the source of truth
    if (localStorageExists) {
        // source of truth from localStorage
        setClassOnDocumentBody(localStorageTheme);
    } else if (supportsColorSchemeQuery) {
        // source of truth from system
        setClassOnDocumentBody(mql.matches);
        localStorage.setItem(storageKey, mql.matches);
    } else {
        // source of truth from document.body
        var isDarkMode = document.body.classList.contains(classNameDark);
        localStorage.setItem(storageKey, JSON.stringify(isDarkMode));
    }
})();

// https://github.com/donavon/use-dark-mode/blob/develop/noflash.js.txt

然后，将以下 script src 标记添加到包含在 pages/_document 文件

的 Head class 中的返回内容中

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

class MyDocument extends Document {
    static async getInitialProps(ctx: DocumentContext) {
        const initialProps = await Document.getInitialProps(ctx);
        return { ...initialProps };
    }
    render() {
        return (
            <Html lang='en-US'>
                <Head>
                    <meta charSet='utf-8' />
                    <script type="text/javascript" src='/noflash.js' />
                </Head>
                <body className='loading'>
                    <Main />
                    <NextScript />
                </body>
            </Html>
        );
    }
}

export default MyDocument;

上述方法有效，但以下方法与 Nextv10+ 完美配合。它只需要将以下配置添加到您的根 next.config.js 文件。

next.config.js

module.exports = {
  env: {
    noflash: fs.readFileSync('/noflash.js').toString()
  }
}

然后，更改 pages/_document 文件中的以下脚本标记，如下所示

before

//
        <Head>
            <meta charSet='utf-8' />
            <script type="text/javascript" src='/noflash.js' />
        </Head>
//

after

//
        <Head>
            <meta charSet='utf-8' />
            <script type="text/javascript" dangerouslySetInnerHTML={{ __html: process.env.noflash}} />
        </Head>
//

Link to a repo where I use the first approach（从 2020 年秋季开始，在 tailwindcss 内置暗模式支持之前）

如何修复 NextJS 中的暗模式背景颜色闪烁？

How to fix dark mode background color flicker in NextJS?

javascript

themes

user-experience

reactjs

next.js