Skip to content

fix: Adjust the top height of the proxy to solve the sliding issue #1310

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 2 commits into from
Aug 25, 2025
Merged

fix: Adjust the top height of the proxy to solve the sliding issue #1310

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f63f76a
fix: Adjust the top height of the proxy to solve the sliding issue
Wxh16144 Aug 22, 2025
7a10759
test: add unit test
Wxh16144 Aug 22, 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
11 changes: 11 additions & 0 deletions src/VirtualTable/BodyGrid.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,17 @@ const Grid = React.forwardRef<GridRef, GridProps>((props, ref) => {
},
});

// https://github.com/ant-design/ant-design/issues/54734
Object.defineProperty(obj, 'scrollTop', {
get: () => listRef.current?.getScrollInfo().y || 0,

set: (value: number) => {
listRef.current?.scrollTo({
top: value,
});
},
});

return obj;
});

Expand Down
32 changes: 31 additions & 1 deletion tests/Virtual.spec.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,10 @@ import { resetWarned } from 'rc-util/lib/warning';
import React from 'react';
import { VirtualTable, type Reference, type VirtualTableProps } from '../src';

const identity = (value: any) => value;

global.scrollToConfig = null;
global.collectGetScrollInfoReturn = identity;

vi.mock('rc-virtual-list', async () => {
const RealVirtualList = ((await vi.importActual('rc-virtual-list')) as any).default;
Expand All @@ -20,6 +23,10 @@ vi.mock('rc-virtual-list', async () => {
global.scrollToConfig = config;
return myRef.current.scrollTo(config);
},
getScrollInfo: () => {
const originResult = myRef.current.getScrollInfo();
return global.collectGetScrollInfoReturn(originResult);
},
}));

return <RealVirtualList ref={myRef} {...props} data-scroll-width={props.scrollWidth} />;
Expand Down Expand Up @@ -59,7 +66,8 @@ describe('Table.Virtual', () => {
beforeEach(() => {
scrollLeftCalled = false;
setScrollLeft.mockReset();
global.scrollToConfig = null;
global.scrollToConfig = vi.fn(identity);
// global.collectGetScrollInfoReturn.mockReset();
Comment on lines +69 to +70
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot Aug 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

high

There are a couple of issues in the test setup within beforeEach that could lead to problems:

  1. Test State Pollution: The new test should get and set scrollTop correctly modifies the global collectGetScrollInfoReturn function. This change persists across tests, which can cause other tests to fail or behave unpredictably depending on execution order. This should be reset to its default identity value before each test.
  2. Incorrect Mock Initialization: global.scrollToConfig is being initialized as a mock function (vi.fn(identity)), but its purpose is to hold the configuration object passed to the scrollTo method. It should be reset to null as it was previously to accurately reflect its intended use.

The suggested change below addresses both of these points.

Suggested change
global.scrollToConfig = vi.fn(identity);
// global.collectGetScrollInfoReturn.mockReset();
global.scrollToConfig = null;
global.collectGetScrollInfoReturn = identity;

vi.useFakeTimers();
resetWarned();
});
Expand Down Expand Up @@ -563,4 +571,26 @@ describe('Table.Virtual', () => {
).toBeTruthy();
});
});

/**
* In antd, we need to call the scrollTop method through ref to achieve scrolling.
* see: https://github.com/ant-design/ant-design/issues/54734
*/
it('should get and set scrollTop correctly', async () => {
const ref = React.createRef<any>();

global.collectGetScrollInfoReturn = (origin: any) => ({
...origin,
y: 50,
});

getTable({ internalRefs: { body: ref } });

expect(ref.current.scrollTop).toBe(50);

ref.current.scrollTop = 200;
expect(global.scrollToConfig).toEqual({
top: 200,
});
});
});