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(useElementSize): stop function #3367

Merged
merged 4 commits into from Nov 9, 2023
Merged

Conversation

chaii3
Copy link
Contributor

@chaii3 chaii3 commented Sep 1, 2023

fixes #3313

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

Additional context


🤖 Generated by Copilot at aba8a5d

Added a way to stop useElementSize hook. The hook now returns a stop function that can be called to stop observing the element size changes.

🤖 Generated by Copilot at aba8a5d

  • Add stop function to useElementSize to allow users to stop observing the element size (link)
  • Destructure stop function from useResizeObserver return value and assign it to a constant (link)

@Alfred-Skyblue
Copy link
Member

We also need to stop watch.

@bosquig
Copy link

bosquig commented Oct 30, 2023

We also need to stop watch.

Why @Alfred-Skyblue ? the stop function from useResizeObserver internally calls cleanup and stopWatch already

@Alfred-Skyblue
Copy link
Member

@bosquig

watch(
() => unrefElement(target),
(ele) => {
width.value = ele ? initialSize.width : 0
height.value = ele ? initialSize.height : 0
},
)

@antfu antfu enabled auto-merge November 9, 2023 16:40
@antfu antfu added this pull request to the merge queue Nov 9, 2023
Merged via the queue into vueuse:main with commit 5f545be Nov 9, 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.

Be able to stop resizeObserver when using useElementSize
4 participants