Column resizing: handle coalesced pointer move events (#3594)

adazzle · Sep 6, 2024 · adef894 · adef894
1 parent b0ba55f
commit adef894
Show file tree

Hide file tree

Showing 3 changed files with 39 additions and 37 deletions.
diff --git a/src/HeaderCell.tsx b/src/HeaderCell.tsx
@@ -122,22 +122,37 @@ export default function HeaderCell<R, SR>({
     const headerCell = currentTarget.parentElement!;
     const { right, left } = headerCell.getBoundingClientRect();
     const offset = isRtl ? event.clientX - left : right - event.clientX;
+    let hasDoubleClicked = false;
 
     function onPointerMove(event: PointerEvent) {
-      const { right, left } = headerCell.getBoundingClientRect();
-      const width = isRtl ? right + offset - event.clientX : event.clientX + offset - left;
-      if (width > 0) {
-        onColumnResize(column, clampColumnWidth(width, column));
+      const { width, right, left } = headerCell.getBoundingClientRect();
+      let newWidth = isRtl ? right + offset - event.clientX : event.clientX + offset - left;
+      newWidth = clampColumnWidth(newWidth, column);
+      if (width > 0 && newWidth !== width) {
+        onColumnResize(column, newWidth);
       }
     }
 
-    function onLostPointerCapture() {
+    function onDoubleClick() {
+      hasDoubleClicked = true;
+      onColumnResize(column, 'max-content');
+    }
+
+    function onLostPointerCapture(event: PointerEvent) {
+      // Handle final pointer position that may have been skipped by coalesced pointer move events.
+      // Skip move pointer handling if the user double-clicked.
+      if (!hasDoubleClicked) {
+        onPointerMove(event);
+      }
+
       currentTarget.removeEventListener('pointermove', onPointerMove);
+      currentTarget.removeEventListener('dblclick', onDoubleClick);
       currentTarget.removeEventListener('lostpointercapture', onLostPointerCapture);
     }
 
     currentTarget.setPointerCapture(pointerId);
     currentTarget.addEventListener('pointermove', onPointerMove);
+    currentTarget.addEventListener('dblclick', onDoubleClick);
     currentTarget.addEventListener('lostpointercapture', onLostPointerCapture);
   }
 
@@ -186,10 +201,6 @@ export default function HeaderCell<R, SR>({
     }
   }
 
-  function onDoubleClick() {
-    onColumnResize(column, 'max-content');
-  }
-
   function handleFocus(event: React.FocusEvent<HTMLDivElement>) {
     onFocus?.(event);
     if (shouldFocusGrid) {
@@ -295,7 +306,6 @@ export default function HeaderCell<R, SR>({
         <div
           className={resizeHandleClassname}
           onClick={stopPropagation}
-          onDoubleClick={onDoubleClick}
           onPointerDown={onPointerDown}
         />
       )}

diff --git a/test/browser/column/resizable.test.tsx b/test/browser/column/resizable.test.tsx
@@ -10,14 +10,27 @@ interface Row {
   readonly col2: string;
 }
 
+function queryResizeHandle(column: HTMLElement) {
+  return column.querySelector(`.${resizeHandleClassname}`);
+}
+
+function getResizeHandle(column: HTMLElement) {
+  const resizeHandle = column.querySelector(`.${resizeHandleClassname}`);
+
+  if (resizeHandle === null) {
+    throw new Error('Resize handle not found');
+  }
+
+  return resizeHandle;
+}
+
 interface ResizeArgs {
   readonly column: HTMLElement;
   readonly resizeBy: number;
 }
 
 async function resize({ column, resizeBy }: ResizeArgs) {
-  const resizeHandle = column.querySelector(`.${resizeHandleClassname}`);
-  if (resizeHandle === null) return;
+  expect(getResizeHandle(column)).toBeInTheDocument();
 
   await act(async () => {
     // @ts-expect-error
@@ -26,8 +39,7 @@ async function resize({ column, resizeBy }: ResizeArgs) {
 }
 
 async function autoResize(column: HTMLElement) {
-  const resizeHandle = column.querySelector(`.${resizeHandleClassname}`);
-  if (resizeHandle === null) return;
+  const resizeHandle = getResizeHandle(column);
 
   // eslint-disable-next-line testing-library/no-unnecessary-act
   await act(async () => {
@@ -51,14 +63,10 @@ const columns: readonly Column<Row>[] = [
   }
 ];
 
-test('should not resize column if resizable is not specified', async () => {
+test('cannot not resize or auto resize column when resizable is not specified', () => {
   setup<Row, unknown>({ columns, rows: [] });
   const [col1] = getHeaderCells();
-  expect(getGrid()).toHaveStyle({ gridTemplateColumns: '100px 200px' });
-  await resize({ column: col1, resizeBy: 50 });
-  expect(getGrid()).toHaveStyle({ gridTemplateColumns: '100px 200px' });
-  await resize({ column: col1, resizeBy: -50 });
-  expect(getGrid()).toHaveStyle({ gridTemplateColumns: '100px 200px' });
+  expect(queryResizeHandle(col1)).not.toBeInTheDocument();
 });
 
 test('should resize column when dragging the handle', async () => {
@@ -86,22 +94,6 @@ test('should use the minWidth if specified', async () => {
   expect(getGrid()).toHaveStyle({ gridTemplateColumns: '100px 100px' });
 });
 
-test('should not auto resize column if resizable is not specified', async () => {
-  setup<Row, unknown>({
-    columns,
-    rows: [
-      {
-        col1: 1,
-        col2: 'a'.repeat(50)
-      }
-    ]
-  });
-  const [col1] = getHeaderCells();
-  expect(getGrid()).toHaveStyle({ gridTemplateColumns: '100px 200px' });
-  await autoResize(col1);
-  expect(getGrid()).toHaveStyle({ gridTemplateColumns: '100px 200px' });
-});
-
 test('should auto resize column when resize handle is double clicked', async () => {
   setup<Row, unknown>({
     columns,

diff --git a/vitest.workspace.ts b/vitest.workspace.ts
@@ -5,7 +5,7 @@ import type { BrowserCommand } from 'vitest/node';
 const resizeColumn: BrowserCommand<[resizeBy: number]> = async (context, resizeBy) => {
   const page = context.page;
   const frame = await context.frame();
-  const resizeHandle = frame.locator('[role="columnheader"][aria-colindex="2"]  div');
+  const resizeHandle = frame.locator('[role="columnheader"][aria-colindex="2"] div');
   const { x, y } = (await resizeHandle.boundingBox())!;
   await resizeHandle.hover({
     position: { x: 5, y: 5 }