docs(virtual-core): clarify shouldAdjustScrollPositionOnItemSizeChange usage by xianjianlf2 · Pull Request #1234 · TanStack/virtual · GitHub
Skip to content

docs(virtual-core): clarify shouldAdjustScrollPositionOnItemSizeChange usage - #1234

Merged
piecyk merged 1 commit into
TanStack:mainfrom
xianjianlf2:codex/docs-clarify-should-adjust-scroll-position
Jul 22, 2026
Merged

piecyk merged 1 commit into
TanStack:mainfrom
xianjianlf2:codex/docs-clarify-should-adjust-scroll-position

Conversation

@xianjianlf2

@xianjianlf2 xianjianlf2 commented Jul 20, 2026 •

Copy link
Copy Markdown
Contributor

Clarifies that shouldAdjustScrollPositionOnItemSizeChange is a Virtualizer instance property, not a VirtualizerOptions option.

The existing docs already list it under Virtualizer Instance, but the prose and changelog wording could still be read as passing the predicate through options. This updates both places to show the intended imperative assignment form.

References #1227 and follows up on the maintainer feedback in #1232.

Validation:

  • ./node_modules/.bin/prettier --check docs/api/virtualizer.md packages/virtual-core/CHANGELOG.md

Summary by CodeRabbit

  • Documentation
    • Clarified that shouldAdjustScrollPositionOnItemSizeChange is configured directly on the virtualizer instance.
    • Added an example demonstrating how to assign the callback after creating a virtualizer.
    • Updated the changelog to accurately describe the instance-level override behavior.

@coderabbitai

coderabbitai Bot commented Jul 20, 2026 •

Copy link
Copy Markdown

@nx-cloud

nx-cloud Bot commented Jul 20, 2026 •

Copy link
Copy Markdown

View your CI Pipeline Execution ↗ for commit dff54b7

Command Status Duration Result
nx affected --targets=test:sherif,test:knip,tes... ✅ Succeeded 3m View ↗
nx run-many --target=build --exclude=examples/** ✅ Succeeded 19s View ↗

☁️ Nx Cloud last updated this comment at 2026-07-20 15:57:42 UTC

@pkg-pr-new

pkg-pr-new Bot commented Jul 20, 2026

Copy link
Copy Markdown

@piecyk
piecyk merged commit ef6e92a into TanStack:main Jul 22, 2026
10 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.

2 participants