docs(virtual-core): clarify shouldAdjustScrollPositionOnItemSizeChange usage

[xianjianlf2]

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]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 5f070252-6e00-4f57-9b4d-ca41ceb5676a

📥 Commits

Reviewing files that changed from the base of the PR and between 1e3b908 and dff54b7.

📒 Files selected for processing (2)

• docs/api/virtualizer.md
• packages/virtual-core/CHANGELOG.md

---

📝 Walkthrough

Walkthrough

The documentation and changelog clarify that shouldAdjustScrollPositionOnItemSizeChange is assigned directly on the virtualizer instance rather than provided as a construction option.

Changes

Callback documentation clarification

Layer / File(s)	Summary
Document instance property assignment docs/api/virtualizer.md, packages/virtual-core/CHANGELOG.md	The API documentation adds direct-assignment guidance and an example, while the 3.15.0 changelog clarifies that the instance callback is checked before default behavior.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Possibly related PRs

• TanStack/virtual#1168: Covers related scroll-position adjustment behavior controlled by the same callback.
• TanStack/virtual#1199: Changes the virtual-core backward-scroll adjustment logic using this callback.
• TanStack/virtual#1232: Changes wiring behavior between the options and instance callback.

Suggested reviewers:piecyk, tannerlinsley

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	The description covers the change and validation, but it omits the required template sections for Checklist and Release Impact.	Add the ## ✅ Checklist and ## 🚀 Release Impact sections, including the required checkboxes, to match the repository template.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title is concise and accurately summarizes the docs-only clarification to shouldAdjustScrollPositionOnItemSizeChange.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[nx-cloud]

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]

More templates

• @tanstack/virtual-example-angular-dynamic
• @tanstack/virtual-example-angular-fixed
• @tanstack/virtual-example-angular-infinite-scroll
• @tanstack/virtual-example-angular-padding
• @tanstack/virtual-example-angular-smooth-scroll
• @tanstack/virtual-example-angular-sticky
• @tanstack/virtual-example-angular-table
• @tanstack/virtual-example-angular-variable
• @tanstack/virtual-example-angular-window
• tanstack-react-virtual-example-chat
• tanstack-react-virtual-example-dynamic
• tanstack-react-virtual-example-fixed
• tanstack-react-virtual-example-infinite-scroll
• tanstack-react-virtual-example-padding
• tanstack-react-virtual-example-pretext
• tanstack-react-virtual-example-scroll-padding
• tanstack-react-virtual-example-smooth-scroll
• tanstack-react-virtual-example-sticky
• tanstack-react-virtual-example-table
• tanstack-react-virtual-example-variable
• tanstack-react-virtual-example-window
• tanstack-marko-virtual-example-dynamic
• tanstack-marko-virtual-example-fixed
• tanstack-marko-virtual-example-grid
• tanstack-marko-virtual-example-infinite-scroll
• tanstack-marko-virtual-example-smooth-scroll
• tanstack-marko-virtual-example-variable
• tanstack-marko-virtual-example-window
• tanstack-svelte-virtual-example-dynamic
• tanstack-svelte-virtual-example-fixed
• tanstack-svelte-virtual-example-infinite-scroll
• tanstack-svelte-virtual-example-smooth-scroll
• tanstack-svelte-virtual-example-sticky
• tanstack-svelte-virtual-example-table
• tanstack-vue-virtual-example-dynamic
• tanstack-vue-virtual-example-fixed
• tanstack-vue-virtual-example-infinite-scroll
• tanstack-vue-virtual-example-padding
• tanstack-vue-virtual-example-scroll-padding
• tanstack-vue-virtual-example-smooth-scroll
• tanstack-vue-virtual-example-sticky
• tanstack-vue-virtual-example-table
• tanstack-vue-virtual-example-variable
• tanstack-lit-virtual-example-dynamic
• tanstack-lit-virtual-example-fixed

@tanstack/angular-virtual

npm i https://pkg.pr.new/@tanstack/angular-virtual@1234

@tanstack/lit-virtual

npm i https://pkg.pr.new/@tanstack/lit-virtual@1234

@tanstack/marko-virtual

npm i https://pkg.pr.new/@tanstack/marko-virtual@1234

@tanstack/react-virtual

npm i https://pkg.pr.new/@tanstack/react-virtual@1234

@tanstack/solid-virtual

npm i https://pkg.pr.new/@tanstack/solid-virtual@1234

@tanstack/svelte-virtual

npm i https://pkg.pr.new/@tanstack/svelte-virtual@1234

@tanstack/virtual-core

npm i https://pkg.pr.new/@tanstack/virtual-core@1234

@tanstack/vue-virtual

npm i https://pkg.pr.new/@tanstack/vue-virtual@1234

commit: dff54b7