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(useMediaQuery): only add/remove event listeners on query change #3236

Merged
merged 6 commits into from Jul 30, 2023

Conversation

Ingramz
Copy link
Contributor

@Ingramz Ingramz commented Jul 16, 2023

Before submitting the PR, please make sure you do the following

  • Read the Contributing Guidelines.
  • Read the Pull Request Guidelines.
  • Check that there isn't already a PR that solves the problem the same way to avoid creating a duplicate.
  • Provide a description in this PR that addresses what the PR is solving, or reference the issue that it solves (e.g. fixes #123).
  • Ideally, include relevant tests that fail without this PR but pass with it.
⚠️ Slowing down new functions

Warning: Slowing down new functions

As the VueUse audience continues to grow, we have been inundated with an overwhelming number of feature requests and pull requests. As a result, maintaining the project has become increasingly challenging and has stretched our capacity to its limits. As such, in the near future, we may need to slow down our acceptance of new features and prioritize the stability and quality of existing functions. Please note that new features for VueUse may not be accepted at this time. If you have any new ideas, we suggest that you first incorporate them into your own codebase, iterate on them to suit your needs, and assess their generalizability. If you strongly believe that your ideas are beneficial to the community, you may submit a pull request along with your use cases, and we would be happy to review and discuss them. Thank you for your understanding.


Description

This pull request changes useMediaQuery to only register event listeners when it is first created or when the reactive value for the passed in query changes in order to avoid re-creating the event listeners on every change event. This will avoid any excess overhead in the event handler itself.

Fixes #3235

Additional context

In the process, toRef(query).value was changed toValue(query). I am not sure nor haven't tried yet whether this preserves the reactivity inside watchEffect. If this works as intended, it should be a slight improvement in bundled code size. Update: Reactivity seems to be working fine.


🤖 Generated by Copilot at 4cf721b

Enhance useMediaQuery to support getter functions and fix a bug. Refactor the code for better performance and readability.

🤖 Generated by Copilot at 4cf721b

  • Replace toRef with toValue to support MaybeRefOrGetter type for query argument of useMediaQuery (link, link)
  • Move and modify update and cleanup functions to improve performance, readability, and bug fix (link, link)
  • Move watchEffect call inside stopWatch variable and pass it to tryOnScopeDispose to avoid unnecessary effects and ensure proper cleanup (link)

if (!isSupported.value)
return

cleanup()

mediaQuery = window!.matchMedia(toRef(query).value)
mediaQuery = window!.matchMedia(toValue(query))
matches.value = !!mediaQuery?.matches

if (!mediaQuery)
return
Copy link
Contributor Author

@Ingramz Ingramz Jul 16, 2023

Choose a reason for hiding this comment

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

It should be possible to assert that if isSupported.value = true, then window.matchMedia always returns a MediaQueryList unless there exists a noncompliant implementation that this aims to handle.

This should allow us to simplify

    matches.value = !!mediaQuery?.matches

    if (!mediaQuery)
      return

to:

    matches.value = mediaQuery.matches

Falsy checks are a remnant from previous versions of the code before isSupported was introduced, where code path existed that skipped calling window.matchMedia.
antfu
antfu previously approved these changes Jul 30, 2023
@Ingramz
Copy link
Contributor Author

Ingramz commented Jul 30, 2023

I think there's a test failure right now caused by a window.matchMedia mock that returns undefined instead of a MediaQueryList. Can take a look at it a bit later if necessary.

@Ingramz Ingramz requested a review from antfu July 30, 2023 12:26
@antfu antfu enabled auto-merge July 30, 2023 13:10
@antfu antfu added this pull request to the merge queue Jul 30, 2023
Merged via the queue into vueuse:main with commit f39691f Jul 30, 2023
4 checks passed
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.

useMediaQuery event listeners are recreated every change event
2 participants