@atlaskit/editor-plugin-table 7.3.9 → 7.3.10

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/editor-plugin-table
 
+## 7.3.10
+
+### Patch Changes
+
+- [#75205](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/75205) [`add1e7b7f424`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/add1e7b7f424) - Reduce NCS spam when holding the move column/row keyboard shortcut
+
 ## 7.3.9
 
 ### Patch Changes

package/dist/cjs/pm-plugins/drag-and-drop/plugin.js

@@ -240,9 +240,28 @@ var createPlugin = exports.createPlugin = function createPlugin(dispatch, eventD
       },
       handleKeyDown: function handleKeyDown(view, event) {
         var _ref8;
+        var tr = view.state.tr;
+        var keysToTrapWhen = ['ArrowUp', 'ArrowDown', 'ArrowLeft', 'ArrowRight'];
+
+        /** fix for NCS spam update where the user is holding down the move column / row keyboard shortcut
+         * if the user is holding down shortcut (ctrl + shift + alt + arrowKey), we want to move the selection only once
+         * See ticket ED-22154 https://product-fabric.atlassian.net/browse/ED-22154
+         */
+
+        // Do early check for the keys we want to trap here so we can abort early
+        if (event.ctrlKey && event.shiftKey && event.altKey) {
+          var _getSelectedCellInfo = (0, _utils.getSelectedCellInfo)(tr.selection),
+            verticalCells = _getSelectedCellInfo.verticalCells,
+            horizontalCells = _getSelectedCellInfo.horizontalCells,
+            totalRowCount = _getSelectedCellInfo.totalRowCount,
+            totalColumnCount = _getSelectedCellInfo.totalColumnCount;
+          var isRowOrColumnSelected = horizontalCells === totalColumnCount || verticalCells === totalRowCount;
+          if (isRowOrColumnSelected && keysToTrapWhen.includes(event.key) && event.repeat) {
+            return true;
+          }
+        }
         var isDragHandleFocused = ['drag-handle-button-row', 'drag-handle-button-column'].includes((_ref8 = event.target || null) === null || _ref8 === void 0 ? void 0 : _ref8.id);
         var keysToTrap = ['Enter', ' '];
-        var keysToTrapWhen = ['ArrowUp', 'ArrowDown', 'ArrowLeft', 'ArrowRight'];
         var _getPluginState3 = (0, _pluginFactory2.getPluginState)(view.state),
           isDragMenuOpen = _getPluginState3.isDragMenuOpen;
 

package/dist/cjs/pm-plugins/keymap.js

@@ -42,6 +42,13 @@ function keymapPlugin(getEditorContainerWidth, editorAnalyticsAPI, dragAndDropEn
   (0, _keymaps.bindKeymapWithCommand)(_keymaps.addColumnAfter.common, (0, _insert.addColumnAfter)(getEditorContainerWidth), list);
   if (dragAndDropEnabled) {
     // Move row/column shortcuts
+    /**
+     * NOTE: If the keyboard shortcut for moving rows or columns is changed, we need to update the handleKeyDown function
+     * in packages/editor/editor-plugin-table/src/pm-plugins/drag-and-drop/plugin.ts
+     * to make sure the logic for holding the shortcut keys is valid
+     * See ticket ED-22154 https://product-fabric.atlassian.net/browse/ED-22154
+     */
+
     (0, _keymaps.bindKeymapWithCommand)(_keymaps.moveRowDown.common, (0, _commandsWithAnalytics2.moveSourceWithAnalyticsViaShortcut)(editorAnalyticsAPI)('table-row', 1), list);
     (0, _keymaps.bindKeymapWithCommand)(_keymaps.moveRowUp.common, (0, _commandsWithAnalytics2.moveSourceWithAnalyticsViaShortcut)(editorAnalyticsAPI)('table-row', -1), list);
     (0, _keymaps.bindKeymapWithCommand)(_keymaps.moveColumnLeft.common, (0, _commandsWithAnalytics2.moveSourceWithAnalyticsViaShortcut)(editorAnalyticsAPI)('table-column', -1), list);

package/dist/es2019/pm-plugins/drag-and-drop/plugin.js

@@ -2,7 +2,7 @@ import { INPUT_METHOD, TABLE_STATUS } from '@atlaskit/editor-common/analytics';
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import { DecorationSet } from '@atlaskit/editor-prosemirror/view';
 import { CellSelection } from '@atlaskit/editor-tables/cell-selection';
-import { getCellsInRow } from '@atlaskit/editor-tables/utils';
+import { getCellsInRow, getSelectedCellInfo } from '@atlaskit/editor-tables/utils';
 import { autoScrollForElements } from '@atlaskit/pragmatic-drag-and-drop-auto-scroll/element';
 import { combine } from '@atlaskit/pragmatic-drag-and-drop/combine';
 import { monitorForElements } from '@atlaskit/pragmatic-drag-and-drop/element/adapter';
@@ -250,9 +250,33 @@ export const createPlugin = (dispatch, eventDispatcher, editorAnalyticsAPI) => {
       },
       handleKeyDown: (view, event) => {
         var _ref;
+        const {
+          state: {
+            tr
+          }
+        } = view;
+        const keysToTrapWhen = ['ArrowUp', 'ArrowDown', 'ArrowLeft', 'ArrowRight'];
+
+        /** fix for NCS spam update where the user is holding down the move column / row keyboard shortcut
+         * if the user is holding down shortcut (ctrl + shift + alt + arrowKey), we want to move the selection only once
+         * See ticket ED-22154 https://product-fabric.atlassian.net/browse/ED-22154
+         */
+
+        // Do early check for the keys we want to trap here so we can abort early
+        if (event.ctrlKey && event.shiftKey && event.altKey) {
+          const {
+            verticalCells,
+            horizontalCells,
+            totalRowCount,
+            totalColumnCount
+          } = getSelectedCellInfo(tr.selection);
+          const isRowOrColumnSelected = horizontalCells === totalColumnCount || verticalCells === totalRowCount;
+          if (isRowOrColumnSelected && keysToTrapWhen.includes(event.key) && event.repeat) {
+            return true;
+          }
+        }
         const isDragHandleFocused = ['drag-handle-button-row', 'drag-handle-button-column'].includes((_ref = event.target || null) === null || _ref === void 0 ? void 0 : _ref.id);
         const keysToTrap = ['Enter', ' '];
-        const keysToTrapWhen = ['ArrowUp', 'ArrowDown', 'ArrowLeft', 'ArrowRight'];
         const {
           isDragMenuOpen
         } = getPluginState(view.state);

package/dist/es2019/pm-plugins/keymap.js

@@ -33,6 +33,13 @@ export function keymapPlugin(getEditorContainerWidth, editorAnalyticsAPI, dragAn
   bindKeymapWithCommand(addColumnAfter.common, addColumnAfterCommand(getEditorContainerWidth), list);
   if (dragAndDropEnabled) {
     // Move row/column shortcuts
+    /**
+     * NOTE: If the keyboard shortcut for moving rows or columns is changed, we need to update the handleKeyDown function
+     * in packages/editor/editor-plugin-table/src/pm-plugins/drag-and-drop/plugin.ts
+     * to make sure the logic for holding the shortcut keys is valid
+     * See ticket ED-22154 https://product-fabric.atlassian.net/browse/ED-22154
+     */
+
     bindKeymapWithCommand(moveRowDown.common, moveSourceWithAnalyticsViaShortcut(editorAnalyticsAPI)('table-row', 1), list);
     bindKeymapWithCommand(moveRowUp.common, moveSourceWithAnalyticsViaShortcut(editorAnalyticsAPI)('table-row', -1), list);
     bindKeymapWithCommand(moveColumnLeft.common, moveSourceWithAnalyticsViaShortcut(editorAnalyticsAPI)('table-column', -1), list);

package/dist/esm/pm-plugins/drag-and-drop/plugin.js

@@ -2,7 +2,7 @@ import { INPUT_METHOD, TABLE_STATUS } from '@atlaskit/editor-common/analytics';
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import { DecorationSet } from '@atlaskit/editor-prosemirror/view';
 import { CellSelection } from '@atlaskit/editor-tables/cell-selection';
-import { getCellsInRow } from '@atlaskit/editor-tables/utils';
+import { getCellsInRow, getSelectedCellInfo } from '@atlaskit/editor-tables/utils';
 import { autoScrollForElements } from '@atlaskit/pragmatic-drag-and-drop-auto-scroll/element';
 import { combine } from '@atlaskit/pragmatic-drag-and-drop/combine';
 import { monitorForElements } from '@atlaskit/pragmatic-drag-and-drop/element/adapter';
@@ -234,9 +234,28 @@ export var createPlugin = function createPlugin(dispatch, eventDispatcher, edito
       },
       handleKeyDown: function handleKeyDown(view, event) {
         var _ref8;
+        var tr = view.state.tr;
+        var keysToTrapWhen = ['ArrowUp', 'ArrowDown', 'ArrowLeft', 'ArrowRight'];
+
+        /** fix for NCS spam update where the user is holding down the move column / row keyboard shortcut
+         * if the user is holding down shortcut (ctrl + shift + alt + arrowKey), we want to move the selection only once
+         * See ticket ED-22154 https://product-fabric.atlassian.net/browse/ED-22154
+         */
+
+        // Do early check for the keys we want to trap here so we can abort early
+        if (event.ctrlKey && event.shiftKey && event.altKey) {
+          var _getSelectedCellInfo = getSelectedCellInfo(tr.selection),
+            verticalCells = _getSelectedCellInfo.verticalCells,
+            horizontalCells = _getSelectedCellInfo.horizontalCells,
+            totalRowCount = _getSelectedCellInfo.totalRowCount,
+            totalColumnCount = _getSelectedCellInfo.totalColumnCount;
+          var isRowOrColumnSelected = horizontalCells === totalColumnCount || verticalCells === totalRowCount;
+          if (isRowOrColumnSelected && keysToTrapWhen.includes(event.key) && event.repeat) {
+            return true;
+          }
+        }
         var isDragHandleFocused = ['drag-handle-button-row', 'drag-handle-button-column'].includes((_ref8 = event.target || null) === null || _ref8 === void 0 ? void 0 : _ref8.id);
         var keysToTrap = ['Enter', ' '];
-        var keysToTrapWhen = ['ArrowUp', 'ArrowDown', 'ArrowLeft', 'ArrowRight'];
         var _getPluginState3 = getPluginState(view.state),
           isDragMenuOpen = _getPluginState3.isDragMenuOpen;
 

package/dist/esm/pm-plugins/keymap.js

@@ -35,6 +35,13 @@ export function keymapPlugin(getEditorContainerWidth, editorAnalyticsAPI, dragAn
   bindKeymapWithCommand(addColumnAfter.common, addColumnAfterCommand(getEditorContainerWidth), list);
   if (dragAndDropEnabled) {
     // Move row/column shortcuts
+    /**
+     * NOTE: If the keyboard shortcut for moving rows or columns is changed, we need to update the handleKeyDown function
+     * in packages/editor/editor-plugin-table/src/pm-plugins/drag-and-drop/plugin.ts
+     * to make sure the logic for holding the shortcut keys is valid
+     * See ticket ED-22154 https://product-fabric.atlassian.net/browse/ED-22154
+     */
+
     bindKeymapWithCommand(moveRowDown.common, moveSourceWithAnalyticsViaShortcut(editorAnalyticsAPI)('table-row', 1), list);
     bindKeymapWithCommand(moveRowUp.common, moveSourceWithAnalyticsViaShortcut(editorAnalyticsAPI)('table-row', -1), list);
     bindKeymapWithCommand(moveColumnLeft.common, moveSourceWithAnalyticsViaShortcut(editorAnalyticsAPI)('table-column', -1), list);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/editor-plugin-table",
-  "version": "7.3.9",
+  "version": "7.3.10",
   "description": "Table plugin for the @atlaskit/editor",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"

package/src/pm-plugins/drag-and-drop/plugin.ts

@@ -8,7 +8,10 @@ import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import type { EditorView } from '@atlaskit/editor-prosemirror/view';
 import { DecorationSet } from '@atlaskit/editor-prosemirror/view';
 import { CellSelection } from '@atlaskit/editor-tables/cell-selection';
-import { getCellsInRow } from '@atlaskit/editor-tables/utils';
+import {
+  getCellsInRow,
+  getSelectedCellInfo,
+} from '@atlaskit/editor-tables/utils';
 import { autoScrollForElements } from '@atlaskit/pragmatic-drag-and-drop-auto-scroll/element';
 import { combine } from '@atlaskit/pragmatic-drag-and-drop/combine';
 import { monitorForElements } from '@atlaskit/pragmatic-drag-and-drop/element/adapter';
@@ -313,17 +316,49 @@ export const createPlugin = (
         return decorationSet;
       },
       handleKeyDown: (view, event) => {
-        const isDragHandleFocused = [
-          'drag-handle-button-row',
-          'drag-handle-button-column',
-        ].includes(((event.target as HTMLElement) || null)?.id);
-        const keysToTrap = ['Enter', ' '];
+        const {
+          state: { tr },
+        } = view;
+
         const keysToTrapWhen = [
           'ArrowUp',
           'ArrowDown',
           'ArrowLeft',
           'ArrowRight',
         ];
+
+        /** fix for NCS spam update where the user is holding down the move column / row keyboard shortcut
+         * if the user is holding down shortcut (ctrl + shift + alt + arrowKey), we want to move the selection only once
+         * See ticket ED-22154 https://product-fabric.atlassian.net/browse/ED-22154
+         */
+
+        // Do early check for the keys we want to trap here so we can abort early
+        if (event.ctrlKey && event.shiftKey && event.altKey) {
+          const {
+            verticalCells,
+            horizontalCells,
+            totalRowCount,
+            totalColumnCount,
+          } = getSelectedCellInfo(tr.selection);
+
+          const isRowOrColumnSelected =
+            horizontalCells === totalColumnCount ||
+            verticalCells === totalRowCount;
+          if (
+            isRowOrColumnSelected &&
+            keysToTrapWhen.includes(event.key) &&
+            event.repeat
+          ) {
+            return true;
+          }
+        }
+
+        const isDragHandleFocused = [
+          'drag-handle-button-row',
+          'drag-handle-button-column',
+        ].includes(((event.target as HTMLElement) || null)?.id);
+        const keysToTrap = ['Enter', ' '];
+
         const { isDragMenuOpen } = getPluginState(view.state);
 
         // drag handle is focused, and user presses any key return them back to editing

package/src/pm-plugins/keymap.ts

@@ -129,6 +129,13 @@ export function keymapPlugin(
 
   if (dragAndDropEnabled) {
     // Move row/column shortcuts
+    /**
+     * NOTE: If the keyboard shortcut for moving rows or columns is changed, we need to update the handleKeyDown function
+     * in packages/editor/editor-plugin-table/src/pm-plugins/drag-and-drop/plugin.ts
+     * to make sure the logic for holding the shortcut keys is valid
+     * See ticket ED-22154 https://product-fabric.atlassian.net/browse/ED-22154
+     */
+
     bindKeymapWithCommand(
       moveRowDown.common!,
       moveSourceWithAnalyticsViaShortcut(editorAnalyticsAPI)('table-row', 1),