Skip to content

feat(useVirtualList): Add options behavior, block and inline to exposed scrollTo method #4905

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

feat(useVirtualList): Add options behavior, block and inline to exposed scrollTo method #4905

wants to merge 4 commits into from
+173 −22

Conversation

laurens94
Copy link

@laurens94 laurens94 commented Jul 23, 2025 •
edited
Loading

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 PR adds scroll options to the exposed scrollTo method of the useVirtualList function.
It allows smooth scrolling and aligning the target element, similar to scrollIntoViewOptions:

scrollTo(50, { behavior: 'smooth', block: 'center' })
Screen.Recording.2025-07-23.at.13.44.25.mov

Additional context

  • Fix demo jumping to index 0 not working
  • Fix demo form usability (pressing Enter in the input field)
  • Add smooth scroll option
  • Allow block and inline option to align the item in the viewport
  • Add tests for alignment feature

I believe the only potential minor 'breaking' change is that the horizontal virtual list scrollTo alignment now has inline: 'nearest' as default, while it used to align as inline: 'start'.
This new default is set because it conforms to the defaults of scrollIntoViewOptions.

@dosubot dosubot bot added size:L This PR changes 100-499 lines, ignoring generated files. enhancement New feature or request labels Jul 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
enhancement New feature or request size:L This PR changes 100-499 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@laurens94
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy