Skip to content

fix: add useScrollendEvent option #875

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
merged 3 commits into from
Nov 7, 2024
Merged

fix: add useScrollendEvent option #875

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
af3ab4c
fix: add explicit debounce fallback
hshoja Nov 6, 2024
a7effba
review comments
hshoja Nov 6, 2024
85604b0
add useScrollendEvent to observeWindowOffset
hshoja Nov 7, 2024
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
10 changes: 10 additions & 0 deletions docs/api/virtualizer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -240,6 +240,16 @@ This option allows you to specify the duration to wait after the last scroll eve

The implementation of this option is driven by the need for a reliable mechanism to handle scrolling behavior across different browsers. Until all browsers uniformly support the scrollEnd event.

### `useScrollendEvent`

```tsx
useScrollendEvent: boolean
```

This option allows you to switch to use debounced fallback to reset the isScrolling instance property after `isScrollingResetDelay` milliseconds. The default value is `true`.

The implementation of this option is driven by the need for a reliable mechanism to handle scrolling behavior across different browsers. Until all browsers uniformly support the scrollEnd event.

### `isRtl`

```tsx
Expand Down
49 changes: 27 additions & 22 deletions packages/virtual-core/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,9 +130,11 @@ export const observeWindowRect = (
const supportsScrollend =
typeof window == 'undefined' ? true : 'onscrollend' in window

type ObserveOffsetCallBack = (offset: number, isScrolling: boolean) => void

export const observeElementOffset = <T extends Element>(
instance: Virtualizer<T, any>,
cb: (offset: number, isScrolling: boolean) => void,
cb: ObserveOffsetCallBack,
) => {
const element = instance.scrollElement
if (!element) {
Expand All @@ -144,15 +146,16 @@ export const observeElementOffset = <T extends Element>(
}

let offset = 0
const fallback = supportsScrollend
? () => undefined
: debounce(
targetWindow,
() => {
cb(offset, false)
},
instance.options.isScrollingResetDelay,
)
const fallback =
instance.options.useScrollendEvent && supportsScrollend
? () => undefined
: debounce(
targetWindow,
() => {
cb(offset, false)
},
instance.options.isScrollingResetDelay,
)

const createHandler = (isScrolling: boolean) => () => {
const { horizontal, isRtl } = instance.options
Expand All @@ -177,7 +180,7 @@ export const observeElementOffset = <T extends Element>(

export const observeWindowOffset = (
instance: Virtualizer<Window, any>,
cb: (offset: number, isScrolling: boolean) => void,
cb: ObserveOffsetCallBack,
) => {
const element = instance.scrollElement
if (!element) {
Expand All @@ -189,15 +192,16 @@ export const observeWindowOffset = (
}

let offset = 0
const fallback = supportsScrollend
? () => undefined
: debounce(
targetWindow,
() => {
cb(offset, false)
},
instance.options.isScrollingResetDelay,
)
const fallback =
instance.options.useScrollendEvent && supportsScrollend
? () => undefined
: debounce(
targetWindow,
() => {
cb(offset, false)
},
instance.options.isScrollingResetDelay,
)

const createHandler = (isScrolling: boolean) => () => {
offset = element[instance.options.horizontal ? 'scrollX' : 'scrollY']
Expand Down Expand Up @@ -291,9 +295,8 @@ export interface VirtualizerOptions<
) => void | (() => void)
observeElementOffset: (
instance: Virtualizer<TScrollElement, TItemElement>,
cb: (offset: number, isScrolling: boolean) => void,
cb: ObserveOffsetCallBack,
) => void | (() => void)

// Optional
debug?: boolean
initialRect?: Rect
Expand Down Expand Up @@ -321,6 +324,7 @@ export interface VirtualizerOptions<
initialMeasurementsCache?: Array<VirtualItem>
lanes?: number
isScrollingResetDelay?: number
useScrollendEvent?: boolean
enabled?: boolean
isRtl?: boolean
}
Expand Down Expand Up @@ -412,6 +416,7 @@ export class Virtualizer<
isScrollingResetDelay: 150,
enabled: true,
isRtl: false,
useScrollendEvent: true,
...opts,
}
}
Expand Down