fix(dark-mode): avoid localStorage overwrite by system dark mode status #636
+85
−15
Conversation
This file contains 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
🦋 Changeset detectedLatest commit: bd1cd0c The changes in this PR will be included in the next version bump. This PR includes changesets to release 2 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Problem Description
While using
useDarkMode, I noticed that after refreshing the page, the value saved inlocalStoragedoes not take effect (observing thatlocalStorageis always overwritten by the current system's dark mode status), even though I set theinitializeWithValueoption to true (the documentation states, "If true (default), the hook will initialize by readinglocalStorage").Cause of the Issue
The value saved in
localStoragedoes not take effect on the next page load because the value retrieved byconst isDarkOS = useMediaQuery()immediately overwrites the result read fromuseLocalStorage()when theuseDarkModehook initializes (sinceuseIsomorphicLayoutEffectexecutes immediately). This behavior is unexpected, causing the functionality of saving the dark mode state tolocalStorageto fail.Fix
Add
const allowDarkOSChange = useIsMounted(). Before the page is mounted, prevent applying the dark mode result fromisDarkOS, rather than immediately executing and overwriting the value fromlocalStorage.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.
fixes #512