Skip to content

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

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

Merged
piecyk merged 2 commits into from
Mar 12, 2025
Merged

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

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5ca5c24
add missing parameter(sync)
taylous Mar 3, 2025
070d63d
add documentation for sync parameter of the onChange
taylous Mar 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions docs/api/virtualizer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,10 +67,12 @@ The initial `Rect` of the scrollElement. This is mostly useful if you need to ru
### `onChange`

```tsx
onChange?: (instance: Virtualizer<TScrollElement, TItemElement>) => void
onChange?: (instance: Virtualizer<TScrollElement, TItemElement>, sync: boolean) => void
```

A callback function that fires when the virtualizer's internal state changes. It's passed the virtualizer instance.
A callback function that fires when the virtualizer's internal state changes. It's passed the virtualizer instance and the sync parameter.

The sync parameter indicates whether scrolling is currently in progress. It is `true` when scrolling is ongoing, and `false` when scrolling has stopped or other actions (such as resizing) are being performed.

### `overscan`

Expand Down