Skip to content

Commit

Permalink
Changes couple of words
Browse files Browse the repository at this point in the history
  • Loading branch information
schalkventer authored Sep 2, 2024
1 parent bf7a7e2 commit 7089985
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/api/virtualizer.md
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ scrollToFn?: (
) => void
```

An optional function that (if provided) should implement the scrolling behavior for your scrollElement. It will be called with the following: An offset to scroll towards; a boolean indicating if scrolling is allowed to be smoothed; and the virtualizer instance. Built-in scroll implementations are exported as `elementScroll` and `windowScroll` which are automatically configured for you by your framework adapter's exported functions like `useVirtualizer` or `useWindowVirtualizer`.
An optional function that (if provided) should implement the scrolling behavior for your scrollElement. It will be called with the following: An offset to scroll towards; a boolean indicating whether scrolling can be smoothed; and the virtualizer instance itself. Built-in scroll implementations are exported as `elementScroll` and `windowScroll` which are automatically configured for you by your framework adapter's exported functions like `useVirtualizer` or `useWindowVirtualizer`.

> ⚠️ Attempting to use smoothScroll with dynamically measured elements will not work.
Expand Down

0 comments on commit 7089985

Please sign in to comment.