handsontable 16.0.1 → 16.1.0-next-abd8f2e-20250904

package/core/focusCatcher/index.js

@@ -3,7 +3,9 @@
 exports.__esModule = true;
 exports.installFocusCatcher = installFocusCatcher;
 var _shortcutContexts = require("../../shortcutContexts");
-var _focusDetector = require("./focusDetector");
+var _focusDetector = require("../../utils/focusDetector");
+var _utils = require("./utils");
+var _mixed = require("../../helpers/mixed");
 /**
  * Installs a focus catcher module. The module observes when the table is focused and depending on
  * from the which side it was focused on it selects a specified cell or releases the TAB navigation
@@ -12,27 +14,27 @@ var _focusDetector = require("./focusDetector");
  * @param {Core} hot The Handsontable instance.
  */
 function installFocusCatcher(hot) {
-  const clampCoordsIfNeeded = normalizeCoordsIfNeeded(hot);
+  const clampCoordsIfNeeded = (0, _utils.normalizeCoordsIfNeeded)(hot);
   let recentlyAddedFocusCoords;
   const {
     activate,
     deactivate
-  } = (0, _focusDetector.installFocusDetector)(hot, {
-    onFocusFromTop() {
-      var _clampCoordsIfNeeded;
-      const mostTopStartCoords = (_clampCoordsIfNeeded = clampCoordsIfNeeded(recentlyAddedFocusCoords)) !== null && _clampCoordsIfNeeded !== void 0 ? _clampCoordsIfNeeded : getMostTopStartPosition(hot);
-      if (mostTopStartCoords) {
-        hot.runHooks('modifyFocusOnTabNavigation', 'from_above', mostTopStartCoords);
-        hot.selectCell(mostTopStartCoords.row, mostTopStartCoords.col);
-      }
-      hot.listen();
-    },
-    onFocusFromBottom() {
-      var _clampCoordsIfNeeded2;
-      const mostBottomEndCoords = (_clampCoordsIfNeeded2 = clampCoordsIfNeeded(recentlyAddedFocusCoords)) !== null && _clampCoordsIfNeeded2 !== void 0 ? _clampCoordsIfNeeded2 : getMostBottomEndPosition(hot);
-      if (mostBottomEndCoords) {
-        hot.runHooks('modifyFocusOnTabNavigation', 'from_below', mostBottomEndCoords);
-        hot.selectCell(mostBottomEndCoords.row, mostBottomEndCoords.col);
+  } = (0, _focusDetector.installFocusDetector)(hot, hot.rootGridElement, {
+    onFocus(from) {
+      if (from === 'from_above') {
+        var _clampCoordsIfNeeded;
+        const mostTopStartCoords = (_clampCoordsIfNeeded = clampCoordsIfNeeded(recentlyAddedFocusCoords)) !== null && _clampCoordsIfNeeded !== void 0 ? _clampCoordsIfNeeded : (0, _mixed.getMostTopStartPosition)(hot);
+        const result = hot.runHooks('modifyFocusOnTabNavigation', 'from_above', mostTopStartCoords);
+        if (mostTopStartCoords && result !== false) {
+          hot.selectCell(mostTopStartCoords.row, mostTopStartCoords.col);
+        }
+      } else {
+        var _clampCoordsIfNeeded2;
+        const mostBottomEndCoords = (_clampCoordsIfNeeded2 = clampCoordsIfNeeded(recentlyAddedFocusCoords)) !== null && _clampCoordsIfNeeded2 !== void 0 ? _clampCoordsIfNeeded2 : (0, _mixed.getMostBottomEndPosition)(hot);
+        const result = hot.runHooks('modifyFocusOnTabNavigation', 'from_below', mostBottomEndCoords);
+        if (mostBottomEndCoords && result !== false) {
+          hot.selectCell(mostBottomEndCoords.row, mostBottomEndCoords.col);
+        }
       }
       hot.listen();
     }
@@ -44,8 +46,20 @@ function installFocusCatcher(hot) {
   let isSavingCoordsEnabled = true;
   let isTabOrShiftTabPressed = false;
   let preventViewportScroll = false;
-  hot.addHook('afterListen', () => deactivate());
-  hot.addHook('afterUnlisten', () => activate());
+  hot.addHook('afterListen', () => {
+    const activeContextName = hot.getShortcutManager().getActiveContextName();
+    const activeContext = hot.getShortcutManager().getContext(activeContextName);
+    if ((activeContext === null || activeContext === void 0 ? void 0 : activeContext.scope) === 'table') {
+      deactivate();
+    }
+  });
+  hot.addHook('afterUnlisten', () => {
+    const activeContextName = hot.getShortcutManager().getActiveContextName();
+    const activeContext = hot.getShortcutManager().getContext(activeContextName);
+    if ((activeContext === null || activeContext === void 0 ? void 0 : activeContext.scope) === 'table') {
+      activate();
+    }
+  });
   hot.addHook('afterSelection', (row, column, row2, column2, preventScrolling) => {
     if (isTabOrShiftTabPressed && (rowWrapState.wrapped && rowWrapState.flipped || preventViewportScroll)) {
       preventViewportScroll = false;
@@ -53,7 +67,7 @@ function installFocusCatcher(hot) {
     }
     if (isSavingCoordsEnabled) {
       var _hot$getSelectedRange;
-      recentlyAddedFocusCoords = (_hot$getSelectedRange = hot.getSelectedRangeLast()) === null || _hot$getSelectedRange === void 0 ? void 0 : _hot$getSelectedRange.highlight;
+      recentlyAddedFocusCoords = (_hot$getSelectedRange = hot.getSelectedRangeActive()) === null || _hot$getSelectedRange === void 0 ? void 0 : _hot$getSelectedRange.highlight;
     }
   });
   hot.addHook('beforeRowWrap', (interruptedByAutoInsertMode, newCoords, isFlipped) => {
@@ -84,7 +98,7 @@ function installFocusCatcher(hot) {
         tabNavigation
       } = hot.getSettings();
       isTabOrShiftTabPressed = true;
-      if (hot.getSelectedRangeLast() && !tabNavigation) {
+      if (hot.getSelectedRangeActive() && !tabNavigation) {
         isSavingCoordsEnabled = false;
       }
       if (!tabNavigation) {
@@ -103,7 +117,7 @@ function installFocusCatcher(hot) {
       isSavingCoordsEnabled = true;
       if (!tabNavigation || !hot.selection.isSelected() || autoWrapRow && rowWrapState.wrapped && rowWrapState.flipped || !autoWrapRow && rowWrapState.wrapped) {
         if (autoWrapRow && rowWrapState.wrapped && rowWrapState.flipped) {
-          recentlyAddedFocusCoords = event.shiftKey ? getMostTopStartPosition(hot) : getMostBottomEndPosition(hot);
+          recentlyAddedFocusCoords = event.shiftKey ? (0, _mixed.getMostTopStartPosition)(hot) : (0, _mixed.getMostBottomEndPosition)(hot);
         }
         deactivateTable();
         return false;
@@ -114,93 +128,4 @@ function installFocusCatcher(hot) {
     },
     position: 'after'
   }]);
-}
-
-/**
- * Gets the coordinates of the most top-start cell or header (depends on the table settings and its size).
- *
- * @param {Core} hot The Handsontable instance.
- * @returns {CellCoords|null}
- */
-function getMostTopStartPosition(hot) {
-  const {
-    rowIndexMapper,
-    columnIndexMapper
-  } = hot;
-  const {
-    navigableHeaders
-  } = hot.getSettings();
-  let topRow = navigableHeaders && hot.countColHeaders() > 0 ? -hot.countColHeaders() : 0;
-  let startColumn = navigableHeaders && hot.countRowHeaders() > 0 ? -hot.countRowHeaders() : 0;
-  if (topRow === 0) {
-    topRow = rowIndexMapper.getVisualFromRenderableIndex(topRow);
-  }
-  if (startColumn === 0) {
-    startColumn = columnIndexMapper.getVisualFromRenderableIndex(startColumn);
-  }
-  if (topRow === null || startColumn === null) {
-    return null;
-  }
-  return hot._createCellCoords(topRow, startColumn);
-}
-
-/**
- * Gets the coordinates of the most bottom-end cell or header (depends on the table settings and its size).
- *
- * @param {Core} hot The Handsontable instance.
- * @returns {CellCoords|null}
- */
-function getMostBottomEndPosition(hot) {
-  var _rowIndexMapper$getVi, _columnIndexMapper$ge;
-  const {
-    rowIndexMapper,
-    columnIndexMapper
-  } = hot;
-  const {
-    navigableHeaders
-  } = hot.getSettings();
-  let bottomRow = rowIndexMapper.getRenderableIndexesLength() - 1;
-  let endColumn = columnIndexMapper.getRenderableIndexesLength() - 1;
-  if (bottomRow < 0) {
-    if (!navigableHeaders || hot.countColHeaders() === 0) {
-      return null;
-    }
-    bottomRow = -1;
-  }
-  if (endColumn < 0) {
-    if (!navigableHeaders || hot.countColHeaders() === 0) {
-      return null;
-    }
-    endColumn = -1;
-  }
-  return hot._createCellCoords((_rowIndexMapper$getVi = rowIndexMapper.getVisualFromRenderableIndex(bottomRow)) !== null && _rowIndexMapper$getVi !== void 0 ? _rowIndexMapper$getVi : bottomRow, (_columnIndexMapper$ge = columnIndexMapper.getVisualFromRenderableIndex(endColumn)) !== null && _columnIndexMapper$ge !== void 0 ? _columnIndexMapper$ge : endColumn);
-}
-
-/**
- * Normalizes the coordinates (clamps to nearest visible cell position within dataset range).
- *
- * @param {Core} hot The Handsontable instance.
- * @returns {function(Coords | undefined): Coords | null}
- */
-function normalizeCoordsIfNeeded(hot) {
-  return coords => {
-    if (!coords) {
-      return null;
-    }
-    const mostTopStartCoords = getMostTopStartPosition(hot);
-    const mostBottomEndCoords = getMostBottomEndPosition(hot);
-    if (coords.col < mostTopStartCoords.col) {
-      coords.col = mostTopStartCoords.col;
-    }
-    if (coords.col > mostBottomEndCoords.col) {
-      coords.col = mostBottomEndCoords.col;
-    }
-    if (coords.row < mostTopStartCoords.row) {
-      coords.row = mostTopStartCoords.row;
-    }
-    if (coords.row > mostBottomEndCoords.row) {
-      coords.row = mostBottomEndCoords.row;
-    }
-    return coords;
-  };
 }

package/core/focusCatcher/index.mjs

@@ -1,5 +1,7 @@
 import { GRID_GROUP } from "../../shortcutContexts/index.mjs";
-import { installFocusDetector } from "./focusDetector.mjs";
+import { installFocusDetector } from "../../utils/focusDetector.mjs";
+import { normalizeCoordsIfNeeded } from "./utils.mjs";
+import { getMostTopStartPosition, getMostBottomEndPosition } from "../../helpers/mixed.mjs";
 /**
  * Installs a focus catcher module. The module observes when the table is focused and depending on
  * from the which side it was focused on it selects a specified cell or releases the TAB navigation
@@ -13,22 +15,22 @@ export function installFocusCatcher(hot) {
   const {
     activate,
     deactivate
-  } = installFocusDetector(hot, {
-    onFocusFromTop() {
-      var _clampCoordsIfNeeded;
-      const mostTopStartCoords = (_clampCoordsIfNeeded = clampCoordsIfNeeded(recentlyAddedFocusCoords)) !== null && _clampCoordsIfNeeded !== void 0 ? _clampCoordsIfNeeded : getMostTopStartPosition(hot);
-      if (mostTopStartCoords) {
-        hot.runHooks('modifyFocusOnTabNavigation', 'from_above', mostTopStartCoords);
-        hot.selectCell(mostTopStartCoords.row, mostTopStartCoords.col);
-      }
-      hot.listen();
-    },
-    onFocusFromBottom() {
-      var _clampCoordsIfNeeded2;
-      const mostBottomEndCoords = (_clampCoordsIfNeeded2 = clampCoordsIfNeeded(recentlyAddedFocusCoords)) !== null && _clampCoordsIfNeeded2 !== void 0 ? _clampCoordsIfNeeded2 : getMostBottomEndPosition(hot);
-      if (mostBottomEndCoords) {
-        hot.runHooks('modifyFocusOnTabNavigation', 'from_below', mostBottomEndCoords);
-        hot.selectCell(mostBottomEndCoords.row, mostBottomEndCoords.col);
+  } = installFocusDetector(hot, hot.rootGridElement, {
+    onFocus(from) {
+      if (from === 'from_above') {
+        var _clampCoordsIfNeeded;
+        const mostTopStartCoords = (_clampCoordsIfNeeded = clampCoordsIfNeeded(recentlyAddedFocusCoords)) !== null && _clampCoordsIfNeeded !== void 0 ? _clampCoordsIfNeeded : getMostTopStartPosition(hot);
+        const result = hot.runHooks('modifyFocusOnTabNavigation', 'from_above', mostTopStartCoords);
+        if (mostTopStartCoords && result !== false) {
+          hot.selectCell(mostTopStartCoords.row, mostTopStartCoords.col);
+        }
+      } else {
+        var _clampCoordsIfNeeded2;
+        const mostBottomEndCoords = (_clampCoordsIfNeeded2 = clampCoordsIfNeeded(recentlyAddedFocusCoords)) !== null && _clampCoordsIfNeeded2 !== void 0 ? _clampCoordsIfNeeded2 : getMostBottomEndPosition(hot);
+        const result = hot.runHooks('modifyFocusOnTabNavigation', 'from_below', mostBottomEndCoords);
+        if (mostBottomEndCoords && result !== false) {
+          hot.selectCell(mostBottomEndCoords.row, mostBottomEndCoords.col);
+        }
       }
       hot.listen();
     }
@@ -40,8 +42,20 @@ export function installFocusCatcher(hot) {
   let isSavingCoordsEnabled = true;
   let isTabOrShiftTabPressed = false;
   let preventViewportScroll = false;
-  hot.addHook('afterListen', () => deactivate());
-  hot.addHook('afterUnlisten', () => activate());
+  hot.addHook('afterListen', () => {
+    const activeContextName = hot.getShortcutManager().getActiveContextName();
+    const activeContext = hot.getShortcutManager().getContext(activeContextName);
+    if ((activeContext === null || activeContext === void 0 ? void 0 : activeContext.scope) === 'table') {
+      deactivate();
+    }
+  });
+  hot.addHook('afterUnlisten', () => {
+    const activeContextName = hot.getShortcutManager().getActiveContextName();
+    const activeContext = hot.getShortcutManager().getContext(activeContextName);
+    if ((activeContext === null || activeContext === void 0 ? void 0 : activeContext.scope) === 'table') {
+      activate();
+    }
+  });
   hot.addHook('afterSelection', (row, column, row2, column2, preventScrolling) => {
     if (isTabOrShiftTabPressed && (rowWrapState.wrapped && rowWrapState.flipped || preventViewportScroll)) {
       preventViewportScroll = false;
@@ -49,7 +63,7 @@ export function installFocusCatcher(hot) {
     }
     if (isSavingCoordsEnabled) {
       var _hot$getSelectedRange;
-      recentlyAddedFocusCoords = (_hot$getSelectedRange = hot.getSelectedRangeLast()) === null || _hot$getSelectedRange === void 0 ? void 0 : _hot$getSelectedRange.highlight;
+      recentlyAddedFocusCoords = (_hot$getSelectedRange = hot.getSelectedRangeActive()) === null || _hot$getSelectedRange === void 0 ? void 0 : _hot$getSelectedRange.highlight;
     }
   });
   hot.addHook('beforeRowWrap', (interruptedByAutoInsertMode, newCoords, isFlipped) => {
@@ -80,7 +94,7 @@ export function installFocusCatcher(hot) {
         tabNavigation
       } = hot.getSettings();
       isTabOrShiftTabPressed = true;
-      if (hot.getSelectedRangeLast() && !tabNavigation) {
+      if (hot.getSelectedRangeActive() && !tabNavigation) {
         isSavingCoordsEnabled = false;
       }
       if (!tabNavigation) {
@@ -110,93 +124,4 @@ export function installFocusCatcher(hot) {
     },
     position: 'after'
   }]);
-}
-
-/**
- * Gets the coordinates of the most top-start cell or header (depends on the table settings and its size).
- *
- * @param {Core} hot The Handsontable instance.
- * @returns {CellCoords|null}
- */
-function getMostTopStartPosition(hot) {
-  const {
-    rowIndexMapper,
-    columnIndexMapper
-  } = hot;
-  const {
-    navigableHeaders
-  } = hot.getSettings();
-  let topRow = navigableHeaders && hot.countColHeaders() > 0 ? -hot.countColHeaders() : 0;
-  let startColumn = navigableHeaders && hot.countRowHeaders() > 0 ? -hot.countRowHeaders() : 0;
-  if (topRow === 0) {
-    topRow = rowIndexMapper.getVisualFromRenderableIndex(topRow);
-  }
-  if (startColumn === 0) {
-    startColumn = columnIndexMapper.getVisualFromRenderableIndex(startColumn);
-  }
-  if (topRow === null || startColumn === null) {
-    return null;
-  }
-  return hot._createCellCoords(topRow, startColumn);
-}
-
-/**
- * Gets the coordinates of the most bottom-end cell or header (depends on the table settings and its size).
- *
- * @param {Core} hot The Handsontable instance.
- * @returns {CellCoords|null}
- */
-function getMostBottomEndPosition(hot) {
-  var _rowIndexMapper$getVi, _columnIndexMapper$ge;
-  const {
-    rowIndexMapper,
-    columnIndexMapper
-  } = hot;
-  const {
-    navigableHeaders
-  } = hot.getSettings();
-  let bottomRow = rowIndexMapper.getRenderableIndexesLength() - 1;
-  let endColumn = columnIndexMapper.getRenderableIndexesLength() - 1;
-  if (bottomRow < 0) {
-    if (!navigableHeaders || hot.countColHeaders() === 0) {
-      return null;
-    }
-    bottomRow = -1;
-  }
-  if (endColumn < 0) {
-    if (!navigableHeaders || hot.countColHeaders() === 0) {
-      return null;
-    }
-    endColumn = -1;
-  }
-  return hot._createCellCoords((_rowIndexMapper$getVi = rowIndexMapper.getVisualFromRenderableIndex(bottomRow)) !== null && _rowIndexMapper$getVi !== void 0 ? _rowIndexMapper$getVi : bottomRow, (_columnIndexMapper$ge = columnIndexMapper.getVisualFromRenderableIndex(endColumn)) !== null && _columnIndexMapper$ge !== void 0 ? _columnIndexMapper$ge : endColumn);
-}
-
-/**
- * Normalizes the coordinates (clamps to nearest visible cell position within dataset range).
- *
- * @param {Core} hot The Handsontable instance.
- * @returns {function(Coords | undefined): Coords | null}
- */
-function normalizeCoordsIfNeeded(hot) {
-  return coords => {
-    if (!coords) {
-      return null;
-    }
-    const mostTopStartCoords = getMostTopStartPosition(hot);
-    const mostBottomEndCoords = getMostBottomEndPosition(hot);
-    if (coords.col < mostTopStartCoords.col) {
-      coords.col = mostTopStartCoords.col;
-    }
-    if (coords.col > mostBottomEndCoords.col) {
-      coords.col = mostBottomEndCoords.col;
-    }
-    if (coords.row < mostTopStartCoords.row) {
-      coords.row = mostTopStartCoords.row;
-    }
-    if (coords.row > mostBottomEndCoords.row) {
-      coords.row = mostBottomEndCoords.row;
-    }
-    return coords;
-  };
 }

package/core/focusCatcher/utils.js

@@ -0,0 +1,31 @@
+"use strict";
+
+exports.__esModule = true;
+exports.normalizeCoordsIfNeeded = normalizeCoordsIfNeeded;
+var _number = require("../../helpers/number");
+var _mixed = require("../../helpers/mixed");
+/**
+ * Normalizes the coordinates (clamps to nearest visible cell position within dataset range).
+ *
+ * @param {Core} hot The Handsontable instance.
+ * @returns {function(Coords | undefined): Coords | null}
+ */
+function normalizeCoordsIfNeeded(hot) {
+  return coords => {
+    if (!coords) {
+      return null;
+    }
+    const {
+      rowIndexMapper,
+      columnIndexMapper
+    } = hot;
+    if (rowIndexMapper.isHidden(coords.row) || columnIndexMapper.isHidden(coords.col)) {
+      return null;
+    }
+    const mostTopStartCoords = (0, _mixed.getMostTopStartPosition)(hot);
+    const mostBottomEndCoords = (0, _mixed.getMostBottomEndPosition)(hot);
+    coords.row = (0, _number.clamp)(coords.row, mostTopStartCoords.row, mostBottomEndCoords.row);
+    coords.col = (0, _number.clamp)(coords.col, mostTopStartCoords.col, mostBottomEndCoords.col);
+    return coords;
+  };
+}

package/core/focusCatcher/utils.mjs

@@ -0,0 +1,27 @@
+import { clamp } from "../../helpers/number.mjs";
+import { getMostTopStartPosition, getMostBottomEndPosition } from "../../helpers/mixed.mjs";
+/**
+ * Normalizes the coordinates (clamps to nearest visible cell position within dataset range).
+ *
+ * @param {Core} hot The Handsontable instance.
+ * @returns {function(Coords | undefined): Coords | null}
+ */
+export function normalizeCoordsIfNeeded(hot) {
+  return coords => {
+    if (!coords) {
+      return null;
+    }
+    const {
+      rowIndexMapper,
+      columnIndexMapper
+    } = hot;
+    if (rowIndexMapper.isHidden(coords.row) || columnIndexMapper.isHidden(coords.col)) {
+      return null;
+    }
+    const mostTopStartCoords = getMostTopStartPosition(hot);
+    const mostBottomEndCoords = getMostBottomEndPosition(hot);
+    coords.row = clamp(coords.row, mostTopStartCoords.row, mostBottomEndCoords.row);
+    coords.col = clamp(coords.col, mostTopStartCoords.col, mostBottomEndCoords.col);
+    return coords;
+  };
+}