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

fix(dark-mode): avoid localStorage overwrite by system dark mode status #636

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

Conversation

qwqcode
Copy link

@qwqcode qwqcode commented Sep 17, 2024

Problem Description

While using useDarkMode, I noticed that after refreshing the page, the value saved in localStorage does not take effect (observing that localStorage is always overwritten by the current system's dark mode status), even though I set the initializeWithValue option to true (the documentation states, "If true (default), the hook will initialize by reading localStorage").

Cause of the Issue

The value saved in localStorage does not take effect on the next page load because the value retrieved by const isDarkOS = useMediaQuery() immediately overwrites the result read from useLocalStorage() when the useDarkMode hook initializes (since useIsomorphicLayoutEffect executes immediately). This behavior is unexpected, causing the functionality of saving the dark mode state to localStorage to fail.

Fix

Add const allowDarkOSChange = useIsMounted(). Before the page is mounted, prevent applying the dark mode result from isDarkOS, rather than immediately executing and overwriting the value from localStorage.

Test cases have been added to verify the existence of this issue, and the problem was confirmed. The code modification has passed the tests successfully.

Copy link

changeset-bot bot commented Sep 17, 2024

⚠️ No Changeset found

Latest commit: 8084242

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

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.

1 participant