From 004bdd593ef5085c661fe1dda3431606a3bf6ad8 Mon Sep 17 00:00:00 2001
From: Mathias Jakobsen <mathias.jakobsen@overleaf.com>
Date: Mon, 11 Sep 2023 11:02:44 +0100
Subject: [PATCH] Merge pull request #14761 from
 overleaf/mj-table-tab-navigation

[visual] Allow tab to escape editing cell

GitOrigin-RevId: 10762c5909f5c1a13a98ed1709b6609cf9ab79b8
---
 .../components/table-generator/table.tsx      | 68 +++++++++++--------
 ...codemirror-editor-table-generator.spec.tsx |  5 ++
 2 files changed, 45 insertions(+), 28 deletions(-)

diff --git a/services/web/frontend/js/features/source-editor/components/table-generator/table.tsx b/services/web/frontend/js/features/source-editor/components/table-generator/table.tsx
index cd0ce3dcde..25c5a7dbfe 100644
--- a/services/web/frontend/js/features/source-editor/components/table-generator/table.tsx
+++ b/services/web/frontend/js/features/source-editor/components/table-generator/table.tsx
@@ -28,7 +28,11 @@ type NavigationKey =
 
 type NavigationMap = {
   // eslint-disable-next-line no-unused-vars
-  [key in NavigationKey]: [() => TableSelection, () => TableSelection]
+  [key in NavigationKey]: {
+    run: () => TableSelection
+    shift: () => TableSelection
+    canExitEditing?: boolean
+  }
 }
 
 const isMac = /Mac/.test(window.navigator?.platform)
@@ -103,26 +107,27 @@ export const Table: FC = () => {
 
   const navigation: NavigationMap = useMemo(
     () => ({
-      ArrowRight: [
-        () => selection!.moveRight(tableData),
-        () => selection!.extendRight(tableData),
-      ],
-      ArrowLeft: [
-        () => selection!.moveLeft(tableData),
-        () => selection!.extendLeft(tableData),
-      ],
-      ArrowUp: [
-        () => selection!.moveUp(tableData),
-        () => selection!.extendUp(tableData),
-      ],
-      ArrowDown: [
-        () => selection!.moveDown(tableData),
-        () => selection!.extendDown(tableData),
-      ],
-      Tab: [
-        () => selection!.moveNext(tableData),
-        () => selection!.movePrevious(tableData),
-      ],
+      ArrowRight: {
+        run: () => selection!.moveRight(tableData),
+        shift: () => selection!.extendRight(tableData),
+      },
+      ArrowLeft: {
+        run: () => selection!.moveLeft(tableData),
+        shift: () => selection!.extendLeft(tableData),
+      },
+      ArrowUp: {
+        run: () => selection!.moveUp(tableData),
+        shift: () => selection!.extendUp(tableData),
+      },
+      ArrowDown: {
+        run: () => selection!.moveDown(tableData),
+        shift: () => selection!.extendDown(tableData),
+      },
+      Tab: {
+        run: () => selection!.moveNext(tableData),
+        shift: () => selection!.movePrevious(tableData),
+        canExitEditing: true,
+      },
     }),
     [selection, tableData]
   )
@@ -190,10 +195,15 @@ export const Table: FC = () => {
           }
         }, 0)
       } else if (Object.prototype.hasOwnProperty.call(navigation, event.code)) {
-        const [defaultNavigation, shiftNavigation] =
-          navigation[event.code as NavigationKey]
+        const {
+          run: defaultNavigation,
+          shift: shiftNavigation,
+          canExitEditing,
+        } = navigation[event.code as NavigationKey]
         if (cellData) {
-          return
+          if (!canExitEditing) {
+            return
+          }
         }
         event.preventDefault()
         if (!selection) {
@@ -205,11 +215,13 @@ export const Table: FC = () => {
           )
           return
         }
-        if (event.shiftKey) {
-          setSelection(shiftNavigation())
-        } else {
-          setSelection(defaultNavigation())
+        const newSelection = event.shiftKey
+          ? shiftNavigation()
+          : defaultNavigation()
+        if (cellData && canExitEditing) {
+          commitCellData()
         }
+        setSelection(newSelection)
       } else if (isCharacterInput(event) && !cellData) {
         event.preventDefault()
         event.stopPropagation()
diff --git a/services/web/test/frontend/features/source-editor/components/codemirror-editor-table-generator.spec.tsx b/services/web/test/frontend/features/source-editor/components/codemirror-editor-table-generator.spec.tsx
index 3aa902d69d..3e3ea9f654 100644
--- a/services/web/test/frontend/features/source-editor/components/codemirror-editor-table-generator.spec.tsx
+++ b/services/web/test/frontend/features/source-editor/components/codemirror-editor-table-generator.spec.tsx
@@ -587,6 +587,11 @@ cell 3 & cell 4 \\\\
       cy.get('@cell-2').should('have.focus').should('have.class', 'selected')
       cy.get('@cell-2').tab({ shift: true })
       cy.get('@cell-1').should('have.focus').should('have.class', 'selected')
+      // Tabbing when editing a cell should commit change and move to next cell
+      cy.get('@cell-1').type('foo')
+      cy.get('@cell-1').tab()
+      cy.get('@cell-2').should('have.focus').should('have.class', 'selected')
+      cy.get('@cell-1').should('have.text', 'foo')
     })
 
     it('Can select rows and columns with selectors', function () {