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

feat: use useEventListener where it was not being used #4479

Merged
merged 2 commits into from
Jan 15, 2025

Conversation

ferferga
Copy link
Member

@ferferga ferferga commented Jan 10, 2025

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

useEventListener was not being used in all the contexts. With this PR, we're sure the events are correctly disposed always.

Additional context

  • Some composables have been refactored a little, given useEventListener simplifies the cleanup logic
  • All references to àddEventListener in docs have been updated as well to give the best practices rightaway to users.
  • Only 1 usage of addEventListener has been left untouched because it's been removed in refactor(useDevicePixelRatio): use useMediaQuery #4481

Sorry, something went wrong.

@dosubot dosubot bot added the size:L This PR changes 100-499 lines, ignoring generated files. label Jan 10, 2025
This suggests rightaway the best possible practice to users
@OrbisK OrbisK requested a review from ilyaliao January 14, 2025 15:56
@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Jan 15, 2025
Copy link
Member

@antfu antfu left a comment

Choose a reason for hiding this comment

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

I consider this a feature that worth noting in the release note. I am not 100% if this is complete side-effect free when we use this inside a callback. I updated the title.

@antfu antfu changed the title refactor: use useEventListener where it was not being used feat: use useEventListener where it was not being used Jan 15, 2025
@antfu antfu added this pull request to the merge queue Jan 15, 2025
Merged via the queue into vueuse:main with commit c6c6ede Jan 15, 2025
8 checks passed
@ferferga
Copy link
Member Author

@antfu Yes it is (in my app I do use watchers inside Promise.all and other "strange" places and they're garbaged correctly).

This is the only case I found where effectScope is not disabled properly: vuejs/core#12681
In fact, I was thinking at opening a PR at a later time with a new util like tryDispose that checks if there's an effect scope, if not then an appScope, so we toggle between onScopeDispose and onUnmount depending on the situation. But honestly, I prefer to have this fixed in Vue core.

@ferferga ferferga deleted the useEventListener branch January 15, 2025 05:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
lgtm This PR has been approved by a maintainer size:L This PR changes 100-499 lines, ignoring generated files.
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

None yet

4 participants