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(useWindowScroll): allow rewriting back to scroll #3500

Merged
merged 4 commits into from Nov 9, 2023

Conversation

nothing-sy
Copy link
Contributor

@nothing-sy nothing-sy commented Oct 25, 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

Add x,y computed for scrolling

Additional context


🤖 Generated by Copilot at 2d15313

Added smooth scrolling feature to useWindowScroll function and demo. Users can now customize the scroll behavior and control the window scroll position by assigning to the reactive values returned by the function. Updated the documentation to reflect the new feature.

🤖 Generated by Copilot at 2d15313

  • Add and export UseWindowScrollOptions interface to allow specifying scroll behavior (link)
  • Update useWindowScroll function to accept UseWindowScrollOptions and use computed properties for x and y values (link, link)
  • Use scrollTo method in computed setters to perform scrolling with the given behavior (link)
  • Add buttons to demo.vue template to trigger scrolling on x and y axes by modifying reactive values (link)
  • Call useWindowScroll with smooth scroll behavior in demo.vue script (link)
  • Update usage section in index.md to show how to set scroll position programmatically (link)

@antfu antfu changed the title feat(useWindowScroll): Add computed for scrolling feat(useWindowScroll): allow rewriting back to scroll Nov 9, 2023
@antfu antfu enabled auto-merge November 9, 2023 15:03
@antfu antfu added this pull request to the merge queue Nov 9, 2023
Merged via the queue into vueuse:main with commit 931b279 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.

None yet

2 participants