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.

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

Prevent dark mode flash on page refresh #182

Merged
merged 2 commits into from
Jan 2, 2025
Merged

Prevent dark mode flash on page refresh #182

merged 2 commits into from
Jan 2, 2025

Conversation

chacha912
Copy link
Contributor

@chacha912 chacha912 commented Jan 2, 2025

What this PR does / why we need it?

This PR fixes the white flash that appears when refreshing the page in dark mode.
To solve this, we now apply dark mode styles earlier in the page load process (before First Paint), so users won't see any unwanted white flashes when refreshing.

before after
homepage-fouc hoempage-fix

Any background context you want to provide?

What are the relevant tickets?

Fixes #

Checklist

  • Added relevant tests or not required
  • Didn't break anything

Summary by CodeRabbit

  • New Features

    • Enhanced theme handling with improved theme application logic
    • Added immediate theme detection on page load based on user preferences
  • Style Changes

    • Set default HTML background color to a light gray
  • Refactor

    • Centralized theme application logic in a new applyTheme function
    • Improved theme switching mechanism across the application

@chacha912 chacha912 requested a review from hackerwins January 2, 2025 07:47
Copy link

coderabbitai bot commented Jan 2, 2025

Warning

Rate limit exceeded

@chacha912 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 4 minutes and 28 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 39472c8 and dc91a7c.

📒 Files selected for processing (1)
  • pages/_document.tsx (1 hunks)

Walkthrough

The pull request introduces improvements to theme handling across multiple files. A new applyTheme function is added to useTheme.ts to centralize theme application logic. The _app.tsx file now includes a script to set the theme preference on page load, ensuring immediate theme application based on user or system settings. Additionally, a background color is added to the HTML element in the common styles, providing a consistent base color for the application.

Changes

File Change Summary
hooks/useTheme.ts Added applyTheme function to centralize theme application logic
pages/_app.tsx Introduced script to set theme preference on page load
styles/base/_common.scss Added background-color: var(--gray-000); to html element

Sequence Diagram

sequenceDiagram
    participant User
    participant Browser
    participant LocalStorage
    participant Document
    
    User->>Browser: Load Page
    Browser->>LocalStorage: Check Theme Preference
    LocalStorage-->>Browser: Return Theme
    Browser->>Document: Apply Theme
    alt Dark Theme
        Document->Document: Add 'darkmode' class
        Document->Document: Set color scheme to dark
    else Light Theme
        Document->Document: Remove 'darkmode' class
        Document->Document: Set color scheme to light
    end
Loading

Poem

🌓 A Theme's Delight 🌓

In bytes of code, a rabbit's might,
Themes dance between dark and light,
With applyTheme, so clean and bright,
Our styles now leap with pure delight!

🐰✨ Code magic takes flight! 🌈


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Nitpick comments (1)
hooks/useTheme.ts (1)

4-12: Consider fallback checks for SSR environments.
In Next.js, window is only available on the client side; calling window.document.documentElement can cause issues if this code runs on the server. Though your usage might strictly be in effect after mounting, adding an optional fallback check can make the code more robust if future refactors introduce server-side rendering concerns.

 const applyTheme = (theme: 'light' | 'dark') => {
-  if (theme === 'light') {
-    window.document.documentElement.classList.remove('darkmode');
-    window.document.documentElement.style.colorScheme = 'light';
-  } else {
-    window.document.documentElement.classList.add('darkmode');
-    window.document.documentElement.style.colorScheme = 'dark';
-  }
+  if (typeof window !== 'undefined') {
+    if (theme === 'light') {
+      window.document.documentElement.classList.remove('darkmode');
+      window.document.documentElement.style.colorScheme = 'light';
+    } else {
+      window.document.documentElement.classList.add('darkmode');
+      window.document.documentElement.style.colorScheme = 'dark';
+    }
+  }
 };
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between fb5e41c and 39472c8.

📒 Files selected for processing (3)
  • hooks/useTheme.ts (1 hunks)
  • pages/_app.tsx (1 hunks)
  • styles/base/_common.scss (1 hunks)
🧰 Additional context used
🪛 Biome (1.9.4)
pages/_app.tsx

[error] 41-41: Avoid passing content using the dangerouslySetInnerHTML prop.

Setting content using code can expose users to cross-site scripting (XSS) attacks

(lint/security/noDangerouslySetInnerHtml)

🔇 Additional comments (3)
hooks/useTheme.ts (2)

19-19: Good use of the applyTheme function for system theme changes.
This centralized approach ensures consistent look and feel when system preferences change.


23-30: Centralized theme application is a clean approach.
Using applyTheme for all theme choices keeps your code DRY and maintainable, reducing the risk of divergence in how themes are applied.

styles/base/_common.scss (1)

132-134: Approved: Setting a default HTML background helps prevent white flashes.
This ensures users see a consistent background color before the theme styles fully load. Great job aligning this change with dark-mode enhancements in the codebase.

pages/_app.tsx Outdated Show resolved Hide resolved
Copy link
Member

@hackerwins hackerwins left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your contribution.

@hackerwins hackerwins merged commit 2aff9f6 into main Jan 2, 2025
2 checks passed
@hackerwins hackerwins deleted the darkmode branch January 2, 2025 08:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants