Skip to content
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

Jump to bottom

fix: scrollToItem method causes empty rows #139

Merged
merged 1 commit into from
Jun 12, 2021
Merged

fix: scrollToItem method causes empty rows #139

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 5 additions & 0 deletions .changeset/pretty-maps-exercise.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"react-cool-virtual": patch
---

fix: `scrollToItem` causes empty rows
27 changes: 18 additions & 9 deletions src/useVirtual.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@ export default <
getInitItems(itemSize, ssrItemCount)
);
const isMountedRef = useRef(false);
const isScrollToItemRef = useRef(false);
const hasDynamicSizeRef = useRef(false);
const rosRef = useRef<Map<Element, ResizeObserver>>(new Map());
const scrollOffsetRef = useRef(0);
Expand Down Expand Up @@ -132,7 +133,7 @@ export default <
if (hasDynamicSizeRef.current) {
while (
vStart < msData.length &&
// To prevent items from jumping while backward scrolling in dynamic size
// To prevent dynamic size from jumping during backward scrolling
msData[vStart].start < (msData[vStart + 1]?.start ?? 0) &&
msData[vStart].start + msData[vStart].size < scrollOffset
)
Expand Down Expand Up @@ -231,6 +232,9 @@ export default <

if (!isNumber(index)) return;

isScrollToItemRef.current = true;

// For dynamic size, we must measure it for getting the correct scroll position
if (hasDynamicSizeRef.current) measureItems();

const { current: msData } = msDataRef;
Expand Down Expand Up @@ -297,8 +301,9 @@ export default <
DEBOUNCE_INTERVAL
);

const [resetUserScroll, cancelResetUserScroll] = useDebounce(() => {
const [resetScrollTo, cancelResetScrollTo] = useDebounce(() => {
userScrollRef.current = true;
isScrollToItemRef.current = false;
}, DEBOUNCE_INTERVAL);

const handleScroll = useCallback(
Expand Down Expand Up @@ -363,11 +368,13 @@ export default <
const prevEnd = msData[i - 1]?.end ?? 0;

if (measuredSize !== size || start !== prevEnd) {
// To prevent dynamic size from jumping during backward scrolling
if (i < prevItemIdxRef.current && start < scrollOffset)
scrollTo(scrollOffset + measuredSize - size);

msDataRef.current[i] = getMeasure(i, measuredSize);
handleScroll(scrollOffset, isScrolling, uxScrolling);
if (!isScrollToItemRef.current)
handleScroll(scrollOffset, isScrolling, uxScrolling);

hasDynamicSizeRef.current = true;
}
Expand Down Expand Up @@ -418,6 +425,8 @@ export default <

if (!isScrolling) return;

const { current: userScroll } = userScrollRef;

if (onScrollRef.current)
onScrollRef.current({
overscanStartIndex: oStart,
Expand All @@ -426,7 +435,7 @@ export default <
visibleStopIndex: vStop,
scrollOffset,
scrollForward: scrollOffset > scrollOffsetRef.current,
userScroll: userScrollRef.current,
userScroll,
});

const loadIndex = Math.floor((vStop + 1) / loadMoreCount);
Expand All @@ -442,13 +451,13 @@ export default <
stopIndex: startIndex + loadMoreCount - 1,
loadIndex,
scrollOffset,
userScroll: userScrollRef.current,
userScroll,
});

prevVStopRef.current = vStop;

if (uxScrolling) resetIsScrolling();
if (!userScrollRef.current) resetUserScroll();
if (!userScroll) resetScrollTo();
},
[
getCalcData,
Expand All @@ -459,7 +468,7 @@ export default <
marginKey,
onScrollRef,
resetIsScrolling,
resetUserScroll,
resetScrollTo,
scrollTo,
sizeKey,
]
Expand Down Expand Up @@ -519,7 +528,7 @@ export default <

return () => {
cancelResetIsScrolling();
cancelResetUserScroll();
cancelResetScrollTo();
if (scrollToRafRef.current) {
cancelAnimationFrame(scrollToRafRef.current);
scrollToRafRef.current = undefined;
Expand All @@ -532,7 +541,7 @@ export default <
};
}, [
cancelResetIsScrolling,
cancelResetUserScroll,
cancelResetScrollTo,
handleScroll,
scrollKey,
useIsScrollingRef,
Expand Down