Index table sticky header fixes #11617

jesstelford · 2024-02-19T01:52:40Z

Fixes #11042

Fixes a couple of bugs in the IndexTable's vertical sticky header implementation:

Border styles weren't being applied to sticky column headers within the vertical sticky header ([IndexTable] Sticky header in first or last fixed column missing border and getting incorrect min-width #11042)
Sticky last column was missing its header in the sticky vertical header
Sticky vertical header column width wasn't being calculated at the appropriate times, so could get out of sync with the non-sticky header sizes.

polaris-react/src/components/IndexTable/IndexTable.module.scss

polaris-react/src/components/IndexTable/IndexTable.tsx

polaris-react/src/components/IndexTable/IndexTable.module.scss

jesstelford · 2024-02-19T02:08:20Z

polaris-react/src/components/IndexTable/IndexTable.tsx

        stickyTableHeadings.current.forEach((heading, index) => {
-          let minWidth = 0;
-          if (index === 0 && (!isBreakpointsXS() || !selectable)) {


Note to self: Logic elsewhere disables selecting when on mobile breakpoints, so this logic doesn't need replicating again, and hence we can later remove the isBreakpointsXS function below.

jesstelford · 2024-02-19T02:09:44Z

polaris-react/src/components/IndexTable/IndexTable.tsx

@@ -1221,36 +1184,6 @@ function IndexTableBase({
    handleSelectionChange(SelectionType.Page, checked);
  }

-  function renderStickyHeading(heading: IndexTableHeading, index: number) {


Function has been merged with renderHeading above since they were meant to be identical but had diverged in ways that introduced bugs in the sticky heading. By combining them, it ensures no divergence and consistent UX.

jesstelford · 2024-02-19T02:10:43Z

polaris-react/src/components/IndexTable/IndexTable.tsx

-      !selectable && styles['TableHeading-unselectable'],
-      heading.flush && styles['TableHeading-flush'],
-    );
+  function renderHeading(


Merged renderStickyHeading function into renderHeading since they were meant to be identical but had diverged in ways that introduced bugs in the sticky heading. By combining them, it ensures no divergence and consistent UX.

jesstelford · 2024-02-27T04:03:47Z

polaris-react/src/components/IndexTable/tests/IndexTable.test.tsx

@@ -729,7 +729,7 @@ describe('<IndexTable>', () => {
          </IndexTable>,
        );

-        expect(index.findAll(Tooltip)[2].prop('content')).toBe(


The previous sticky header code was rendering a duplicate tooltip when the first column was sticky and sortable, so to select the "second" column header, the test had to pick out the 3rd Tooltip element.

The changes in this PR remove that unnecessary duplicate Tooltip, and so the test selector can be corrected.

gwyneplaine · 2024-02-27T23:26:08Z

Removed myself as a reviewer since i contributed to this PR
Also would like a review from @chloerice and @mrcthms since they have way more context over this component 🙏

jesstelford · 2024-02-27T23:51:16Z

polaris-react/src/components/IndexTable/IndexTable.tsx

@@ -724,7 +694,7 @@ function IndexTableBase({
  const sharedMarkup = (
    <>
      <EventListener event="resize" handler={handleResize} />
-      <AfterInitialMount>{stickyHeaderMarkup}</AfterInitialMount>
+      {stickyHeaderMarkup}


This component is just a useEffect in disguise.

But we rely on a useLayoutEffect to read the DOM and measure the elements rendered by stickyHeaderMarkup.

As per React's docs, useLayoutEffect is run synchronously immediately after DOM tree reconciliation (but before paint) whereas useEffect is run _a_synchronously at some time in the future.

So the code in useLayoutEffect tries to read DOM elements which haven't been rendered yet (and wont be until after the useEffect has run), thereby breaking all the things.

Some git investigation reveals that this useEffect was inserted to balance out some other code which attempted to set the size of the sticky header elements on every render (so delaying the render was beneficial to allow the regular headings to fully render first).

This PR moves the resizing of sticky header elements to a more appropriate place (inside that useLayoutEffect), so there's no need to delay the rendering of the sticky header elements, and hence we don't need <AfterInitialMount>'s useEffect 🎉

mrcthms

This is some really lovely work here @jesstelford @gwyneplaine, I had noticed that we were having some strange behaviours when using a combination of sticky headings / tooltips / sortable headings, and I cannot seem to replicate those behaviours on the storybook here, which is fantastic!

Would be great to see this as a snapshot in a Spinstance before approving 🚀

jesstelford · 2024-03-01T00:56:40Z

/snapit

github-actions · 2024-03-01T00:59:46Z

🫰✨ Thanks @jesstelford! Your snapshots have been published to npm.

Test the snapshots by updating your package.json with the newly published versions:

yarn add @shopify/polaris-icons@0.0.0-snapshot-20240301005918

yarn add @shopify/polaris@0.0.0-snapshot-20240301005918

gwyneplaine · 2024-03-05T00:11:18Z

@mrcthms here's a spin instance with the above snapshot installed
https://admin.web.web-rt21.charles-lee.asia.spin.dev/store/shop1/products?selectedView=all

chloerice

Tophatted in Spin and Storybook and all looks great y'all 🙌🏽

chloerice · 2024-03-11T20:46:36Z

.changeset/hungry-crabs-vanish.md

+'@shopify/polaris': patch
+---
+
+[IndexTable] Unify sticky table header rendering with regular heading for consistency


Suggested change

[IndexTable] Unify sticky table header rendering with regular heading for consistency

Unified logic for sticky and fixed column sticky `IndexTable` header row styles

…hen horizontal scroll

jesstelford · 2024-03-28T00:52:34Z

/snapit

github-actions · 2024-03-28T00:55:49Z

🫰✨ Thanks @jesstelford! Your snapshots have been published to npm.

Test the snapshots by updating your package.json with the newly published versions:

yarn add @shopify/polaris-migrator@0.0.0-snapshot-20240328005416

yarn add @shopify/polaris@0.0.0-snapshot-20240328005416

yarn add @shopify/stylelint-polaris@0.0.0-snapshot-20240328005416

@aaronccasanova

This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to main, this PR will be updated. # Releases ## @shopify/polaris@12.25.0 ### Minor Changes - [#11802](#11802) [`3d93f8daf`](3d93f8d) Thanks [@aaronccasanova](https://github.com/aaronccasanova)! - Added `useHover`, `useFocus`, `useFocusIn`, and `useMediaQuery` hooks for building Copy to Clipboard actions - [#11801](#11801) [`f6308995e`](f630899) Thanks [@sophschneider](https://github.com/sophschneider)! - Added white alpha ramp and more dark experimental tokens ### Patch Changes - [#11617](#11617) [`2ff9427b3`](2ff9427) Thanks [@jesstelford](https://github.com/jesstelford)! - [IndexTable] Unify sticky table header rendering with regular heading for consistency - Updated dependencies \[[`f6308995e`](f630899)]: - @shopify/polaris-tokens@8.10.0 ## @shopify/polaris-tokens@8.10.0 ### Minor Changes - [#11801](#11801) [`f6308995e`](f630899) Thanks [@sophschneider](https://github.com/sophschneider)! - Added white alpha ramp and more dark experimental tokens ## @shopify/polaris-migrator@0.28.5 ### Patch Changes - Updated dependencies \[[`f6308995e`](f630899)]: - @shopify/polaris-tokens@8.10.0 - @shopify/stylelint-polaris@15.5.1 ## @shopify/stylelint-polaris@15.5.1 ### Patch Changes - Updated dependencies \[[`f6308995e`](f630899)]: - @shopify/polaris-tokens@8.10.0 ## polaris-for-vscode@0.9.8 ### Patch Changes - Updated dependencies \[[`f6308995e`](f630899)]: - @shopify/polaris-tokens@8.10.0 ## polaris.shopify.com@0.67.1 ### Patch Changes - Updated dependencies \[[`3d93f8daf`](3d93f8d), [`2ff9427b3`](2ff9427), [`f6308995e`](f630899)]: - @shopify/polaris@12.25.0 - @shopify/polaris-tokens@8.10.0 Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

jesstelford commented Feb 19, 2024

View reviewed changes

jesstelford force-pushed the index-table-sticky-header-fixes branch 2 times, most recently from 47fa094 to 4a46d98 Compare February 26, 2024 05:59

jesstelford marked this pull request as ready for review February 26, 2024 07:08

jesstelford requested a review from gwyneplaine February 26, 2024 07:08

jesstelford force-pushed the index-table-sticky-header-fixes branch from 04777fa to 8773a8f Compare February 27, 2024 03:15

jesstelford commented Feb 27, 2024

View reviewed changes

gwyneplaine requested review from chloerice and mrcthms and removed request for gwyneplaine February 27, 2024 23:24

jesstelford commented Feb 27, 2024

View reviewed changes

mrcthms reviewed Feb 28, 2024

View reviewed changes

chloerice approved these changes Mar 11, 2024

View reviewed changes

[IndexTable] Sticky first column in sticky header gets right border w…

a898303

…hen horizontal scroll

jesstelford force-pushed the index-table-sticky-header-fixes branch from 297c770 to a898303 Compare March 28, 2024 00:02

jesstelford merged commit 2ff9427 into main Apr 2, 2024
14 checks passed

jesstelford deleted the index-table-sticky-header-fixes branch April 2, 2024 00:00

shopify-github-actions-access bot mentioned this pull request Apr 1, 2024

Version Packages #11814

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Index table sticky header fixes #11617

Index table sticky header fixes #11617

jesstelford commented Feb 19, 2024 •

edited

jesstelford Feb 19, 2024

jesstelford Feb 19, 2024

jesstelford Feb 19, 2024

jesstelford Feb 27, 2024

gwyneplaine commented Feb 27, 2024

jesstelford Feb 27, 2024

mrcthms left a comment

jesstelford commented Mar 1, 2024

github-actions bot commented Mar 1, 2024

gwyneplaine commented Mar 5, 2024

chloerice left a comment

chloerice Mar 11, 2024 •

edited

jesstelford commented Mar 28, 2024

github-actions bot commented Mar 28, 2024

	[IndexTable] Unify sticky table header rendering with regular heading for consistency
	Unified logic for sticky and fixed column sticky `IndexTable` header row styles

Index table sticky header fixes #11617

Index table sticky header fixes #11617

Conversation

jesstelford commented Feb 19, 2024 • edited

jesstelford Feb 19, 2024

Choose a reason for hiding this comment

jesstelford Feb 19, 2024

Choose a reason for hiding this comment

jesstelford Feb 19, 2024

Choose a reason for hiding this comment

jesstelford Feb 27, 2024

Choose a reason for hiding this comment

gwyneplaine commented Feb 27, 2024

jesstelford Feb 27, 2024

Choose a reason for hiding this comment

mrcthms left a comment

Choose a reason for hiding this comment

jesstelford commented Mar 1, 2024

github-actions bot commented Mar 1, 2024

gwyneplaine commented Mar 5, 2024

chloerice left a comment

Choose a reason for hiding this comment

chloerice Mar 11, 2024 • edited

Choose a reason for hiding this comment

jesstelford commented Mar 28, 2024

github-actions bot commented Mar 28, 2024

jesstelford commented Feb 19, 2024 •

edited

chloerice Mar 11, 2024 •

edited