perf: prevent theme flash with blocking script in _document and layout#223
Open
AbuJulaybeeb wants to merge 1 commit into
Open
Conversation
|
@AbuJulaybeeb Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Created src/pages/_document.tsx with a blocking script in that reads the stored theme from localStorage (defaulting to "dark") and applies the theme class to document.documentElement before page load.
Modified src/app/layout.tsx to inject the same blocking <script> element inside the to prevent the white background flash on initial load and route transitions in the Next.js App Router.
Why it was done
Without this blocking script, the document element is rendered before next-themes hydrates, causing the background to default to white (from the :root styles) and create a visible white flash before the dark theme stylesheet is parsed and applied.
How it was verified
Verified syntax, file paths, and staging.
Ran npm install and npm run build (Note: The build output identified unrelated syntax/semantic errors on upstream main in FloatingSidebar.tsx and logs/page.tsx).
Closes #109