Skip to content

fix: sync controlled scrollbar visibility #382

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

Open
nrps9909 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix: sync controlled scrollbar visibility #382

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
19 changes: 11 additions & 8 deletions src/ScrollBar.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,14 +75,14 @@ const ScrollBar = React.forwardRef<ScrollBarRef, ScrollBarProps>((props, ref) =>
const [visible, setVisible] = React.useState(showScrollBar);
const visibleTimeoutRef = React.useRef<ReturnType<typeof setTimeout> | undefined>(undefined);

const delayHidden = () => {
const delayHidden = useEvent(() => {
if (showScrollBar === true || showScrollBar === false) return;
clearTimeout(visibleTimeoutRef.current);
setVisible(true);
visibleTimeoutRef.current = setTimeout(() => {
setVisible(false);
}, 3000);
};
});

// ======================== Range =========================
const enableScrollRange = scrollRange - containerSize || 0;
Expand Down Expand Up @@ -134,10 +134,7 @@ const ScrollBar = React.forwardRef<ScrollBarRef, ScrollBarProps>((props, ref) =>
nextTop = pagePosition - rect.top - spinSize / 2;
}

onScroll(
getScrollOffsetByThumbTop(nextTop, enableScrollRange, enableOffsetRange),
horizontal,
);
onScroll(getScrollOffsetByThumbTop(nextTop, enableScrollRange, enableOffsetRange), horizontal);
};

const onContainerMouseDown: React.MouseEventHandler = (e) => {
Expand Down Expand Up @@ -255,11 +252,17 @@ const ScrollBar = React.forwardRef<ScrollBarRef, ScrollBarProps>((props, ref) =>
}, [dragging]);

React.useEffect(() => {
delayHidden();
if (showScrollBar === true || showScrollBar === false) {
clearTimeout(visibleTimeoutRef.current);
setVisible(showScrollBar);
} else {
delayHidden();
}

return () => {
clearTimeout(visibleTimeoutRef.current);
};
}, [scrollOffset]);
}, [scrollOffset, showScrollBar, delayHidden]);

// ====================== Imperative ======================
React.useImperativeHandle(ref, () => ({
Expand Down
28 changes: 28 additions & 0 deletions tests/scroll.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -409,6 +409,34 @@ describe('List.Scroll', () => {
const scrollbarElement = container.querySelector('.rc-virtual-list-scrollbar-visible');
expect(scrollbarElement).not.toBeNull();
});

it('syncs scrollbar visibility when showScrollBar changes', () => {
const props = {
itemHeight: 20,
height: 100,
data: genData(100),
showScrollBar: false,
};
const { container, rerender } = genList(props);
const getScrollbar = () => container.querySelector('.rc-virtual-list-scrollbar-vertical');

expect(getScrollbar()).not.toHaveClass('rc-virtual-list-scrollbar-visible');

rerender(genNode({ ...props, showScrollBar: true }));
expect(getScrollbar()).toHaveClass('rc-virtual-list-scrollbar-visible');

rerender(genNode(props));
expect(getScrollbar()).not.toHaveClass('rc-virtual-list-scrollbar-visible');

rerender(genNode({ ...props, showScrollBar: 'optional' }));
expect(getScrollbar()).toHaveClass('rc-virtual-list-scrollbar-visible');

act(() => {
jest.advanceTimersByTime(3000);
});
expect(getScrollbar()).not.toHaveClass('rc-virtual-list-scrollbar-visible');
});

describe('not show scrollbar when disabled virtual', () => {
[
{ name: '!virtual', props: { virtual: false } },
Expand Down