fix: show the correct group header when scrolled flush to its top #50
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -140,10 +140,7 @@ describe('useFlattenRows', () => { | |
| { type: 'header', groupKey: 'B' }, | ||
| { type: 'item', item: items[1], index: 1 }, | ||
| ]); | ||
| expect(result.current.groupKeys).toEqual(['A', 'B']); | ||
| expect(result.current.groupKeyToItems).toEqual( | ||
| new Map([ | ||
| ['A', [items[0], items[2]]], | ||
|
|
@@ -168,7 +165,7 @@ describe('useFlattenRows', () => { | |
| { type: 'item', item: items[0], index: 0 }, | ||
| { type: 'item', item: items[1], index: 1 }, | ||
| ], | ||
| groupKeys: [], | ||
| groupKeyToItems: new Map(), | ||
| }); | ||
| }); | ||
|
|
@@ -183,10 +180,7 @@ describe('useStickyGroupHeader', () => { | |
| { id: 4, group: 'Group 2' }, | ||
| { id: 5, group: 'Group 2' }, | ||
| ]; | ||
| const groupKeys = ['Group 1', 'Group 2']; | ||
| const baseItemsMap = new Map<React.Key, GroupedItem[]>([ | ||
| ['Group 1', baseItems.slice(0, 3)], | ||
| ['Group 2', baseItems.slice(3, 6)], | ||
|
|
@@ -214,7 +208,7 @@ describe('useStickyGroupHeader', () => { | |
| key: (item) => item.group, | ||
| title, | ||
| }, | ||
| groupKeys, | ||
| groupKeyToItems: baseItemsMap, | ||
| prefixCls: PREFIX_CLS, | ||
| listRef: createListRef(container), | ||
|
|
@@ -243,7 +237,7 @@ describe('useStickyGroupHeader', () => { | |
| key: (item) => item.group, | ||
| title: () => <span>noop</span>, | ||
| }, | ||
| groupKeys, | ||
| groupKeyToItems: baseItemsMap, | ||
| prefixCls: PREFIX_CLS, | ||
| listRef: createListRef(container), | ||
|
|
@@ -256,14 +250,17 @@ describe('useStickyGroupHeader', () => { | |
| ); | ||
| expect(stickyHeader).toBeNull(); }); | ||
|
|
||
| it('keeps the fixed header pinned at 0 within a group regardless of scroll', () => { | ||
| const title = jest.fn().mockImplementation((key: React.Key) => ( | ||
| <span data-testid="sticky-title">{String(key)}</span> | ||
| )); | ||
|
|
||
| // Active group is Group 1, with Group 2's header far below the viewport. | ||
| const info = createRenderInfo({ | ||
| scrollTop: 80, | ||
| start: 1, | ||
| getSize: (key: React.Key) => | ||
| key === 'Group 2' ? { top: 500, bottom: 524 } : { top: 0, bottom: 24 }, | ||
| }); | ||
|
|
||
| const container = document.createElement('div'); | ||
|
|
@@ -274,7 +271,7 @@ describe('useStickyGroupHeader', () => { | |
| key: (item) => item.group, | ||
| title, | ||
| }, | ||
| groupKeys, | ||
| groupKeyToItems: baseItemsMap, | ||
| prefixCls: PREFIX_CLS, | ||
| listRef: createListRef(container), | ||
|
|
@@ -286,21 +283,26 @@ describe('useStickyGroupHeader', () => { | |
| `.${PREFIX_CLS}-group-header-fixed`, | ||
| ); | ||
| expect(stickyHeader).not.toBeNull(); | ||
| expect(stickyHeader).toHaveTextContent('Group 1'); | ||
| expect(stickyHeader).toHaveStyle({ top: '0px' }); }); | ||
|
|
||
| it('pushes the fixed header away when the next group reaches the top', () => { | ||
| const title = jest.fn().mockImplementation((key: React.Key) => ( | ||
| <span data-testid="sticky-title">{String(key)}</span> | ||
| )); | ||
|
|
||
| const info = createRenderInfo({ | ||
| scrollTop: 70, | ||
| start: 3, | ||
| getSize: (key: React.Key) => { | ||
| if (key === 'Group 1') { | ||
| return { top: 0, bottom: 20 }; | ||
| } | ||
| if (key === 'Group 2') { | ||
| return { top: 80, bottom: 100 }; | ||
| } | ||
| return { top: 0, bottom: 0 }; | ||
| }, | ||
| }); | ||
|
|
||
| const container = document.createElement('div'); | ||
|
|
@@ -311,7 +313,7 @@ describe('useStickyGroupHeader', () => { | |
| key: (item) => item.group, | ||
| title, | ||
| }, | ||
| groupKeys, | ||
| groupKeyToItems: baseItemsMap, | ||
| prefixCls: PREFIX_CLS, | ||
| listRef: createListRef(container), | ||
|
|
@@ -324,25 +326,62 @@ describe('useStickyGroupHeader', () => { | |
| ); | ||
| expect(stickyHeader).not.toBeNull(); | ||
| expect(stickyHeader).toHaveTextContent('Group 1'); | ||
| expect(stickyHeader).toHaveStyle({ top: '-10px' }); }); | ||
|
|
||
| it('activates the current group, not the previous one, when its header sits flush at the top', () => { | ||
| const title = jest.fn().mockImplementation((key: React.Key) => ( | ||
| <span data-testid="sticky-title">{String(key)}</span> | ||
| )); | ||
|
|
||
| // Group 2's header sits exactly at the viewport top (scrollTop === its top), | ||
| // while `start` is Group 1's last item row (3) — the row before Group 2's | ||
| // header row (4). This is the off-by-one boundary. | ||
| const info = createRenderInfo({ | ||
| scrollTop: 200, | ||
| start: 3, | ||
| getSize: (key: React.Key) => | ||
| key === 'Group 2' ? { top: 200, bottom: 220 } : { top: 0, bottom: 20 }, | ||
| }); | ||
|
|
||
| const container = document.createElement('div'); | ||
| document.body.appendChild(container); | ||
| const params: StickyHeaderParams<GroupedItem> = { | ||
| enabled: true, | ||
| group: { | ||
| key: (item) => item.group, | ||
| title, | ||
| }, | ||
| groupKeys, | ||
| groupKeyToItems: baseItemsMap, | ||
| prefixCls: PREFIX_CLS, | ||
| listRef: createListRef(container), | ||
| }; | ||
|
|
||
| render(<StickyHeaderTester params={params} info={info} />); | ||
|
|
||
| const stickyHeader = container.querySelector( | ||
| `.${PREFIX_CLS}-group-header-fixed`, | ||
| ); | ||
| expect(stickyHeader).not.toBeNull(); | ||
| // The current group (Group 2), not the previous one (Group 1). | ||
| expect(stickyHeader).toHaveTextContent('Group 2'); | ||
| expect(stickyHeader).toHaveStyle({ top: '0px' }); | ||
| expect(title).toHaveBeenCalledWith('Group 2', baseItems.slice(3, 6)); | ||
| }); | ||
|
|
||
| it('tolerates a sub-pixel scroll offset just short of the header top', () => { | ||
| const title = jest.fn().mockImplementation((key: React.Key) => ( | ||
| <span data-testid="sticky-title">{String(key)}</span> | ||
| )); | ||
|
|
||
| // On a HiDPI screen the scroll offset can rest a fraction of a pixel below | ||
| // a header's true top (here 199.5 vs 200). Without tolerance the strict | ||
| // compare resolves to the previous group and blanks the title. | ||
| const info = createRenderInfo({ | ||
| scrollTop: 199.5, | ||
| start: 3, | ||
| getSize: (key: React.Key) => | ||
| key === 'Group 2' ? { top: 200, bottom: 220 } : { top: 0, bottom: 20 }, | ||
| }); | ||
|
|
||
| const container = document.createElement('div'); | ||
|
|
@@ -353,7 +392,7 @@ describe('useStickyGroupHeader', () => { | |
| key: (item) => item.group, | ||
| title, | ||
| }, | ||
| groupKeys, | ||
| groupKeyToItems: baseItemsMap, | ||
| prefixCls: PREFIX_CLS, | ||
| listRef: createListRef(container), | ||
|
|
@@ -365,6 +404,6 @@ describe('useStickyGroupHeader', () => { | |
| `.${PREFIX_CLS}-group-header-fixed`, | ||
| ); | ||
| expect(stickyHeader).not.toBeNull(); | ||
| expect(stickyHeader).toHaveTextContent('Group 2'); | ||
| }); | ||
| }); | ||
|
Comment on lines
+369
to
409
Contributor
There was a problem hiding this comment. Add a test case to verify that the sticky header is not rendered when the list is scrolled above the first group header (e.g., during rubber-banding). |
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When
scrollTopis less than the first group header's top (e.g., during rubber-banding/elastic scrolling on iOS/macOS, or if there is header/padding space above the first group),findActiveHeaderIndexcurrently defaults to0. This causes the first group's sticky header to remain visible attop: 0even though the real header has not yet reached the top of the viewport, leading to a visual glitch (duplicate/detached header). We should initializeactiveIndexto-1to indicate that no header is active yet.