Fix compatibility issue for useMediaQuery#1663
Open
lennondotw wants to merge 1 commit intoreact-hookz:masterfrom
Open
Fix compatibility issue for useMediaQuery#1663lennondotw wants to merge 1 commit intoreact-hookz:masterfrom
lennondotw wants to merge 1 commit intoreact-hookz:masterfrom
Conversation
There was a problem hiding this comment.
Pull request overview
This PR fixes a compatibility issue in the useMediaQuery hook where event listener subscription and unsubscription were handled asymmetrically, causing errors in Safari versions < 14 that only support the deprecated addListener/removeListener methods.
Changes:
- Restored the
addEventListener/addListenercompatibility check in thecreateQueryEntryfunction to match the existing compatibility logic inqueryUnsubscribe - Ensures symmetric handling of event listeners for both subscription and unsubscription operations
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+20
to
+24
| if (mql.addEventListener) { | ||
| mql.addEventListener('change', listener, {passive: true}); | ||
| } else { | ||
| mql.addListener(listener); | ||
| } |
There was a problem hiding this comment.
Consider adding test coverage for the legacy addListener/removeListener compatibility path. The current tests only mock addEventListener and removeEventListener. Adding a test that mocks a MediaQueryList without addEventListener would ensure this compatibility code path is tested.
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
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.
Summary
This PR fixes an asymmetric compatibility issue in
useMediaQuerywhere theaddEventListenercompatibility check was removed during subscription but still present during unsubscription, causing errors in older Safari versions.The recent commit 4880540 removed the
addEventListener/addListenerfallback logic increateQueryEntrybut kept it inqueryUnsubscribe, creating an inconsistency. This causes issues in Safari versions that don't supportaddEventListeneron MediaQueryList (Safari < 14).Changes
addEventListener/addListenercompatibility check increateQueryEntryto match the unsubscription logic inqueryUnsubscribeProblem
In older Safari versions,
MediaQueryListonly supports the deprecatedaddListener/removeListenermethods. The code was:addEventListenerunconditionally when subscribing (line 20)removeEventListener/removeListenerwhen unsubscribing (lines 52-56)This mismatch meant that in older Safari:
addEventListeneraddListenerremoveListeneron a listener that was never added