docs: add documentation for sync parameter of the onChange function.

[taylous]

summary

the description for the sync parameter of the onChange function was missing from the API documentation,
so I've added it.

upon reviewing the internal code, i found that it is invoked by the notify function.

specifically through: maybeNotify, resizeItem, measure

references

virtual/packages/virtual-core/src/index.ts

Line 447 in 721bf53

private notify = (sync: boolean) => {

virtual/packages/virtual-core/src/index.ts

Line 462 in 721bf53

this.notify(isScrolling)

virtual/packages/virtual-core/src/index.ts

Line 827 in 721bf53

this.notify(false)

virtual/packages/virtual-core/src/index.ts

Line 1072 in 721bf53

this.notify(false)

[changeset-bot]

⚠️ No Changeset found

Latest commit: 070d63d

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[nx-cloud]

View your CI Pipeline Execution ↗ for commit 070d63d.

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

---

☁️ Nx Cloud last updated this comment at 2025-03-09 14:12:03 UTC

[pkg-pr-new]

Open in Stackblitz

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-lit-virtual-example-dynamic
• tanstack-lit-virtual-example-fixed
• 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-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-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/angular-virtual

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

@tanstack/lit-virtual

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

@tanstack/solid-virtual

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

@tanstack/react-virtual

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

@tanstack/svelte-virtual

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

@tanstack/virtual-core

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

@tanstack/vue-virtual

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

commit: 070d63d

[piecyk]

Thanks