From 1bb2c285ac5bbc94380f87f4aca930ece85edfa4 Mon Sep 17 00:00:00 2001
From: Pranav C <pranavxc@gmail.com>
Date: Thu, 6 Oct 2022 13:17:45 +0530
Subject: [PATCH] feat(gui): scroll to the active cell on active cell change

Signed-off-by: Pranav C <pranavxc@gmail.com>
---
 .../nc-gui/components/smartsheet/Grid.vue     | 311 +++++++++---------
 1 file changed, 164 insertions(+), 147 deletions(-)

diff --git a/packages/nc-gui/components/smartsheet/Grid.vue b/packages/nc-gui/components/smartsheet/Grid.vue
index 0a101e3946..3e773052f9 100644
--- a/packages/nc-gui/components/smartsheet/Grid.vue
+++ b/packages/nc-gui/components/smartsheet/Grid.vue
@@ -327,6 +327,22 @@ watch(
   },
   { immediate: true },
 )
+
+const tbodyEl = ref<HTMLElement>()
+
+watch([() => selected.row, () => selected.col], ([row, col]) => {
+  if (row !== null && col !== null) {
+    // get active cell
+    const td = tbodyEl.value?.querySelectorAll('tr')[row]?.querySelectorAll('td')[col + 1]
+    if (!td) return
+    // scroll into the active cell
+    td.scrollIntoView({
+      behavior: 'smooth',
+      block: 'end',
+      inline: 'end',
+    })
+  }
+})
 </script>
 
 <template>
@@ -349,92 +365,93 @@ watch(
           @contextmenu="showContextMenu"
         >
           <thead>
-            <tr class="nc-grid-header border-1 bg-gray-100 sticky top[-1px]">
-              <th>
-                <div class="w-full h-full bg-gray-100 flex min-w-[70px] pl-5 pr-1 items-center">
-                  <template v-if="!readOnly">
-                    <div class="nc-no-label text-gray-500" :class="{ hidden: selectedAllRecords }">#</div>
-                    <div
-                      :class="{ hidden: !selectedAllRecords, flex: selectedAllRecords }"
-                      class="nc-check-all w-full items-center"
-                    >
-                      <a-checkbox v-model:checked="selectedAllRecords" />
+          <tr class="nc-grid-header border-1 bg-gray-100 sticky top[-1px]">
+            <th>
+              <div class="w-full h-full bg-gray-100 flex min-w-[70px] pl-5 pr-1 items-center">
+                <template v-if="!readOnly">
+                  <div class="nc-no-label text-gray-500" :class="{ hidden: selectedAllRecords }">#</div>
+                  <div
+                    :class="{ hidden: !selectedAllRecords, flex: selectedAllRecords }"
+                    class="nc-check-all w-full items-center"
+                  >
+                    <a-checkbox v-model:checked="selectedAllRecords" />
 
-                      <span class="flex-1" />
-                    </div>
-                  </template>
-                  <template v-else>
-                    <div class="text-gray-500">#</div>
-                  </template>
-                </div>
-              </th>
-              <th
-                v-for="col in fields"
-                :key="col.title"
-                v-xc-ver-resize
-                :data-col="col.id"
-                :data-title="col.title"
-                @xcresize="onresize(col.id, $event)"
-                @xcresizing="onXcResizing(col.title, $event)"
-                @xcresized="resizingCol = null"
+                    <span class="flex-1" />
+                  </div>
+                </template>
+                <template v-else>
+                  <div class="text-gray-500">#</div>
+                </template>
+              </div>
+            </th>
+            <th
+              v-for="col in fields"
+              :key="col.title"
+              v-xc-ver-resize
+              :data-col="col.id"
+              :data-title="col.title"
+              @xcresize="onresize(col.id, $event)"
+              @xcresizing="onXcResizing(col.title, $event)"
+              @xcresized="resizingCol = null"
+            >
+              <div class="w-full h-full bg-gray-100 flex items-center">
+                <LazySmartsheetHeaderVirtualCell v-if="isVirtualCol(col)" :column="col" :hide-menu="readOnly" />
+
+                <LazySmartsheetHeaderCell v-else :column="col" :hide-menu="readOnly" />
+              </div>
+            </th>
+            <th
+              v-if="!readOnly && !isLocked && isUIAllowed('add-column') && !isSqlView"
+              v-e="['c:column:add']"
+              class="cursor-pointer"
+              @click.stop="addColumnDropdown = true"
+            >
+              <a-dropdown
+                v-model:visible="addColumnDropdown"
+                :trigger="['click']"
+                overlay-class-name="nc-dropdown-grid-add-column"
               >
-                <div class="w-full h-full bg-gray-100 flex items-center">
-                  <LazySmartsheetHeaderVirtualCell v-if="isVirtualCol(col)" :column="col" :hide-menu="readOnly" />
-
-                  <LazySmartsheetHeaderCell v-else :column="col" :hide-menu="readOnly" />
+                <div class="h-full w-[60px] flex items-center justify-center">
+                  <MdiPlus class="text-sm nc-column-add" />
                 </div>
-              </th>
-              <th
-                v-if="!readOnly && !isLocked && isUIAllowed('add-column') && !isSqlView"
-                v-e="['c:column:add']"
-                class="cursor-pointer"
-                @click.stop="addColumnDropdown = true"
-              >
-                <a-dropdown
-                  v-model:visible="addColumnDropdown"
-                  :trigger="['click']"
-                  overlay-class-name="nc-dropdown-grid-add-column"
-                >
-                  <div class="h-full w-[60px] flex items-center justify-center">
-                    <MdiPlus class="text-sm nc-column-add" />
-                  </div>
 
-                  <template #overlay>
-                    <SmartsheetColumnEditOrAddProvider
-                      v-if="addColumnDropdown"
-                      @submit="addColumnDropdown = false"
-                      @cancel="addColumnDropdown = false"
-                      @click.stop
-                      @keydown.stop
-                    />
-                  </template>
-                </a-dropdown>
-              </th>
-            </tr>
+                <template #overlay>
+                  <SmartsheetColumnEditOrAddProvider
+                    v-if="addColumnDropdown"
+                    @submit="addColumnDropdown = false"
+                    @cancel="addColumnDropdown = false"
+                    @click.stop
+                    @keydown.stop
+                  />
+                </template>
+              </a-dropdown>
+            </th>
+          </tr>
           </thead>
           <!-- this prevent select text from field if not in edit mode -->
-          <tbody @selectstart.prevent>
-            <LazySmartsheetRow v-for="(row, rowIndex) of data" ref="rowRefs" :key="rowIndex" :row="row">
-              <template #default="{ state }">
-                <tr class="nc-grid-row">
-                  <td key="row-index" class="caption nc-grid-cell pl-5 pr-1">
-                    <div class="items-center flex gap-1 min-w-[55px]">
-                      <div
-                        v-if="!readOnly || !isLocked"
-                        class="nc-row-no text-xs text-gray-500"
-                        :class="{ toggle: !readOnly, hidden: row.rowMeta.selected }"
-                      >
-                        {{ rowIndex + 1 }}
-                      </div>
-                      <div
-                        v-if="!readOnly"
-                        :class="{ hidden: !row.rowMeta.selected, flex: row.rowMeta.selected }"
-                        class="nc-row-expand-and-checkbox"
-                      >
-                        <a-checkbox v-model:checked="row.rowMeta.selected" />
-                      </div>
-                      <span class="flex-1" />
-                      <div v-if="!readOnly && !isLocked" class="nc-expand" :class="{ 'nc-comment': row.rowMeta?.commentCount }">
+          <tbody ref="tbodyEl" @selectstart.prevent>
+          <LazySmartsheetRow v-for="(row, rowIndex) of data" ref="rowRefs" :key="rowIndex" :row="row">
+            <template #default="{ state }">
+              <tr class="nc-grid-row">
+                <td key="row-index" class="caption nc-grid-cell pl-5 pr-1">
+                  <div class="items-center flex gap-1 min-w-[55px]">
+                    <div
+                      v-if="!readOnly || !isLocked"
+                      class="nc-row-no text-xs text-gray-500"
+                      :class="{ toggle: !readOnly, hidden: row.rowMeta.selected }"
+                    >
+                      {{ rowIndex + 1 }}
+                    </div>
+                    <div
+                      v-if="!readOnly"
+                      :class="{ hidden: !row.rowMeta.selected, flex: row.rowMeta.selected }"
+                      class="nc-row-expand-and-checkbox"
+                    >
+                      <a-checkbox v-model:checked="row.rowMeta.selected" />
+                    </div>
+                    <span class="flex-1" />
+                    <div v-if="!readOnly && !isLocked" class="nc-expand"
+                         :class="{ 'nc-comment': row.rowMeta?.commentCount }">
                         <span
                           v-if="row.rowMeta?.commentCount"
                           class="py-1 px-3 rounded-full text-xs cursor-pointer select-none transform hover:(scale-110)"
@@ -443,82 +460,82 @@ watch(
                         >
                           {{ row.rowMeta.commentCount }}
                         </span>
-                        <div
-                          v-else
-                          class="cursor-pointer flex items-center border-1 active:ring rounded p-1 hover:(bg-primary bg-opacity-10)"
-                        >
-                          <MdiArrowExpand
-                            v-e="['c:row-expand']"
-                            class="select-none transform hover:(text-accent scale-120) nc-row-expand"
-                            @click="expandForm(row, state)"
-                          />
-                        </div>
+                      <div
+                        v-else
+                        class="cursor-pointer flex items-center border-1 active:ring rounded p-1 hover:(bg-primary bg-opacity-10)"
+                      >
+                        <MdiArrowExpand
+                          v-e="['c:row-expand']"
+                          class="select-none transform hover:(text-accent scale-120) nc-row-expand"
+                          @click="expandForm(row, state)"
+                        />
                       </div>
                     </div>
-                  </td>
-                  <td
-                    v-for="(columnObj, colIndex) of fields"
-                    :ref="cellRefs.set"
-                    :key="columnObj.id"
-                    class="cell relative cursor-pointer nc-grid-cell"
-                    :class="{
+                  </div>
+                </td>
+                <td
+                  v-for="(columnObj, colIndex) of fields"
+                  :ref="cellRefs.set"
+                  :key="columnObj.id"
+                  class="cell relative cursor-pointer nc-grid-cell"
+                  :class="{
                       active:
                         (isUIAllowed('xcDatatableEditable') && selected.col === colIndex && selected.row === rowIndex) ||
                         (isUIAllowed('xcDatatableEditable') && selectedRange(rowIndex, colIndex)),
                     }"
-                    :data-key="rowIndex + columnObj.id"
-                    :data-col="columnObj.id"
-                    :data-title="columnObj.title"
-                    @click="selectCell(rowIndex, colIndex)"
-                    @dblclick="makeEditable(row, columnObj)"
-                    @mousedown="startSelectRange($event, rowIndex, colIndex)"
-                    @mouseover="selectBlock(rowIndex, colIndex)"
-                    @contextmenu="showContextMenu($event, { row: rowIndex, col: colIndex })"
-                  >
-                    <div class="w-full h-full">
-                      <LazySmartsheetVirtualCell
-                        v-if="isVirtualCol(columnObj)"
-                        v-model="row.row[columnObj.title]"
-                        :column="columnObj"
-                        :active="selected.col === colIndex && selected.row === rowIndex"
-                        :row="row"
-                        @navigate="onNavigate"
-                      />
-
-                      <LazySmartsheetCell
-                        v-else
-                        v-model="row.row[columnObj.title]"
-                        :column="columnObj"
-                        :edit-enabled="hasEditPermission && editEnabled && selected.col === colIndex && selected.row === rowIndex"
-                        :row-index="rowIndex"
-                        :active="selected.col === colIndex && selected.row === rowIndex"
-                        @update:edit-enabled="editEnabled = false"
-                        @save="updateOrSaveRow(row, columnObj.title)"
-                        @navigate="onNavigate"
-                        @cancel="editEnabled = false"
-                      />
-                    </div>
-                  </td>
-                </tr>
-              </template>
-            </LazySmartsheetRow>
-
-            <tr v-if="!isView && !isLocked && hasEditPermission && !isSqlView">
-              <td
-                v-e="['c:row:add:grid-bottom']"
-                :colspan="visibleColLength + 1"
-                class="text-left pointer nc-grid-add-new-cell cursor-pointer"
-                @click="addEmptyRow()"
-              >
-                <div class="px-2 w-full flex items-center text-gray-500">
-                  <MdiPlus class="text-pint-500 text-xs ml-2 text-primary" />
+                  :data-key="rowIndex + columnObj.id"
+                  :data-col="columnObj.id"
+                  :data-title="columnObj.title"
+                  @click="selectCell(rowIndex, colIndex)"
+                  @dblclick="makeEditable(row, columnObj)"
+                  @mousedown="startSelectRange($event, rowIndex, colIndex)"
+                  @mouseover="selectBlock(rowIndex, colIndex)"
+                  @contextmenu="showContextMenu($event, { row: rowIndex, col: colIndex })"
+                >
+                  <div class="w-full h-full">
+                    <LazySmartsheetVirtualCell
+                      v-if="isVirtualCol(columnObj)"
+                      v-model="row.row[columnObj.title]"
+                      :column="columnObj"
+                      :active="selected.col === colIndex && selected.row === rowIndex"
+                      :row="row"
+                      @navigate="onNavigate"
+                    />
 
-                  <span class="ml-1">
+                    <LazySmartsheetCell
+                      v-else
+                      v-model="row.row[columnObj.title]"
+                      :column="columnObj"
+                      :edit-enabled="hasEditPermission && editEnabled && selected.col === colIndex && selected.row === rowIndex"
+                      :row-index="rowIndex"
+                      :active="selected.col === colIndex && selected.row === rowIndex"
+                      @update:edit-enabled="editEnabled = false"
+                      @save="updateOrSaveRow(row, columnObj.title)"
+                      @navigate="onNavigate"
+                      @cancel="editEnabled = false"
+                    />
+                  </div>
+                </td>
+              </tr>
+            </template>
+          </LazySmartsheetRow>
+
+          <tr v-if="!isView && !isLocked && hasEditPermission && !isSqlView">
+            <td
+              v-e="['c:row:add:grid-bottom']"
+              :colspan="visibleColLength + 1"
+              class="text-left pointer nc-grid-add-new-cell cursor-pointer"
+              @click="addEmptyRow()"
+            >
+              <div class="px-2 w-full flex items-center text-gray-500">
+                <MdiPlus class="text-pint-500 text-xs ml-2 text-primary" />
+
+                <span class="ml-1">
                     {{ $t('activity.addRow') }}
                   </span>
-                </div>
-              </td>
-            </tr>
+              </div>
+            </td>
+          </tr>
           </tbody>
         </table>