handsontable 0.0.0-next-1af4e47-20241125 → 0.0.0-next-c3d40ad-20241127

package/3rdparty/walkontable/src/core/_base.js

@@ -171,47 +171,43 @@ class CoreAbstract {
    * Scrolls the viewport to a cell (rerenders if needed).
    *
    * @param {CellCoords} coords The cell coordinates to scroll to.
-   * @param {boolean} [snapToTop] If `true`, viewport is scrolled to show the cell on the top of the table.
-   * @param {boolean} [snapToRight] If `true`, viewport is scrolled to show the cell on the right of the table.
-   * @param {boolean} [snapToBottom] If `true`, viewport is scrolled to show the cell on the bottom of the table.
-   * @param {boolean} [snapToLeft] If `true`, viewport is scrolled to show the cell on the left of the table.
+   * @param {'auto' | 'start' | 'end'} [horizontalSnap='auto'] If `'start'`, viewport is scrolled to show
+   * the cell on the left of the table. If `'end'`, viewport is scrolled to show the cell on the right of
+   * the table. When `'auto'`, the viewport is scrolled only when the column is outside of the viewport.
+   * @param {'auto' | 'top' | 'bottom'} [verticalSnap='auto'] If `'top'`, viewport is scrolled to show
+   * the cell on the top of the table. If `'bottom'`, viewport is scrolled to show the cell on the bottom of
+   * the table. When `'auto'`, the viewport is scrolled only when the row is outside of the viewport.
    * @returns {boolean}
    */
-  scrollViewport(coords, snapToTop, snapToRight, snapToBottom, snapToLeft) {
-    if (coords.col < 0 || coords.row < 0) {
-      return false;
-    }
-    return this.wtScroll.scrollViewport(coords, snapToTop, snapToRight, snapToBottom, snapToLeft);
+  scrollViewport(coords, horizontalSnap, verticalSnap) {
+    return this.wtScroll.scrollViewport(coords, horizontalSnap, verticalSnap);
   }
 
   /**
    * Scrolls the viewport to a column (rerenders if needed).
    *
    * @param {number} column Visual column index.
-   * @param {boolean} [snapToRight] If `true`, viewport is scrolled to show the cell on the right of the table.
-   * @param {boolean} [snapToLeft] If `true`, viewport is scrolled to show the cell on the left of the table.
+   * @param {'auto' | 'start' | 'end'} [snapping='auto'] If `'start'`, viewport is scrolled to show
+   * the cell on the left of the table. If `'end'`, viewport is scrolled to show the cell on the right of
+   * the table. When `'auto'`, the viewport is scrolled only when the column is outside of the viewport.
    * @returns {boolean}
    */
-  scrollViewportHorizontally(column, snapToRight, snapToLeft) {
-    if (column < 0) {
-      return false;
-    }
-    return this.wtScroll.scrollViewportHorizontally(column, snapToRight, snapToLeft);
+  scrollViewportHorizontally(column, snapping) {
+    return this.wtScroll.scrollViewportHorizontally(column, snapping);
   }
 
   /**
    * Scrolls the viewport to a row (rerenders if needed).
    *
    * @param {number} row Visual row index.
-   * @param {boolean} [snapToTop] If `true`, viewport is scrolled to show the cell on the top of the table.
-   * @param {boolean} [snapToBottom] If `true`, viewport is scrolled to show the cell on the bottom of the table.
+   * @param {'auto' | 'top' | 'bottom'} [snapping='auto'] If `'top'`, viewport is scrolled to show
+   * the cell on the top of the table. If `'bottom'`, viewport is scrolled to show the cell on
+   * the bottom of the table. When `'auto'`, the viewport is scrolled only when the row is outside of
+   * the viewport.
    * @returns {boolean}
    */
-  scrollViewportVertically(row, snapToTop, snapToBottom) {
-    if (row < 0) {
-      return false;
-    }
-    return this.wtScroll.scrollViewportVertically(row, snapToTop, snapToBottom);
+  scrollViewportVertically(row, snapping) {
+    return this.wtScroll.scrollViewportVertically(row, snapping);
   }
 
   /**

package/3rdparty/walkontable/src/core/_base.mjs

@@ -167,47 +167,43 @@ export default class CoreAbstract {
    * Scrolls the viewport to a cell (rerenders if needed).
    *
    * @param {CellCoords} coords The cell coordinates to scroll to.
-   * @param {boolean} [snapToTop] If `true`, viewport is scrolled to show the cell on the top of the table.
-   * @param {boolean} [snapToRight] If `true`, viewport is scrolled to show the cell on the right of the table.
-   * @param {boolean} [snapToBottom] If `true`, viewport is scrolled to show the cell on the bottom of the table.
-   * @param {boolean} [snapToLeft] If `true`, viewport is scrolled to show the cell on the left of the table.
+   * @param {'auto' | 'start' | 'end'} [horizontalSnap='auto'] If `'start'`, viewport is scrolled to show
+   * the cell on the left of the table. If `'end'`, viewport is scrolled to show the cell on the right of
+   * the table. When `'auto'`, the viewport is scrolled only when the column is outside of the viewport.
+   * @param {'auto' | 'top' | 'bottom'} [verticalSnap='auto'] If `'top'`, viewport is scrolled to show
+   * the cell on the top of the table. If `'bottom'`, viewport is scrolled to show the cell on the bottom of
+   * the table. When `'auto'`, the viewport is scrolled only when the row is outside of the viewport.
    * @returns {boolean}
    */
-  scrollViewport(coords, snapToTop, snapToRight, snapToBottom, snapToLeft) {
-    if (coords.col < 0 || coords.row < 0) {
-      return false;
-    }
-    return this.wtScroll.scrollViewport(coords, snapToTop, snapToRight, snapToBottom, snapToLeft);
+  scrollViewport(coords, horizontalSnap, verticalSnap) {
+    return this.wtScroll.scrollViewport(coords, horizontalSnap, verticalSnap);
   }
 
   /**
    * Scrolls the viewport to a column (rerenders if needed).
    *
    * @param {number} column Visual column index.
-   * @param {boolean} [snapToRight] If `true`, viewport is scrolled to show the cell on the right of the table.
-   * @param {boolean} [snapToLeft] If `true`, viewport is scrolled to show the cell on the left of the table.
+   * @param {'auto' | 'start' | 'end'} [snapping='auto'] If `'start'`, viewport is scrolled to show
+   * the cell on the left of the table. If `'end'`, viewport is scrolled to show the cell on the right of
+   * the table. When `'auto'`, the viewport is scrolled only when the column is outside of the viewport.
    * @returns {boolean}
    */
-  scrollViewportHorizontally(column, snapToRight, snapToLeft) {
-    if (column < 0) {
-      return false;
-    }
-    return this.wtScroll.scrollViewportHorizontally(column, snapToRight, snapToLeft);
+  scrollViewportHorizontally(column, snapping) {
+    return this.wtScroll.scrollViewportHorizontally(column, snapping);
   }
 
   /**
    * Scrolls the viewport to a row (rerenders if needed).
    *
    * @param {number} row Visual row index.
-   * @param {boolean} [snapToTop] If `true`, viewport is scrolled to show the cell on the top of the table.
-   * @param {boolean} [snapToBottom] If `true`, viewport is scrolled to show the cell on the bottom of the table.
+   * @param {'auto' | 'top' | 'bottom'} [snapping='auto'] If `'top'`, viewport is scrolled to show
+   * the cell on the top of the table. If `'bottom'`, viewport is scrolled to show the cell on
+   * the bottom of the table. When `'auto'`, the viewport is scrolled only when the row is outside of
+   * the viewport.
    * @returns {boolean}
    */
-  scrollViewportVertically(row, snapToTop, snapToBottom) {
-    if (row < 0) {
-      return false;
-    }
-    return this.wtScroll.scrollViewportVertically(row, snapToTop, snapToBottom);
+  scrollViewportVertically(row, snapping) {
+    return this.wtScroll.scrollViewportVertically(row, snapping);
   }
 
   /**

package/3rdparty/walkontable/src/facade/core.js

@@ -125,14 +125,14 @@ class WalkontableFacade {
     let topmost = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
     return this._wot.getCell(coords, topmost);
   }
-  scrollViewport(coords, snapToTop, snapToRight, snapToBottom, snapToLeft) {
-    return this._wot.scrollViewport(coords, snapToTop, snapToRight, snapToBottom, snapToLeft);
+  scrollViewport(coords, horizontalSnap, verticalSnap) {
+    return this._wot.scrollViewport(coords, horizontalSnap, verticalSnap);
   }
-  scrollViewportHorizontally(column, snapToRight, snapToLeft) {
-    return this._wot.scrollViewportHorizontally(column, snapToRight, snapToLeft);
+  scrollViewportHorizontally(column, snapping) {
+    return this._wot.scrollViewportHorizontally(column, snapping);
   }
-  scrollViewportVertically(row, snapToTop, snapToBottom) {
-    return this._wot.scrollViewportVertically(row, snapToTop, snapToBottom);
+  scrollViewportVertically(row, snapping) {
+    return this._wot.scrollViewportVertically(row, snapping);
   }
   getViewport() {
     return this._wot.getViewport();

package/3rdparty/walkontable/src/facade/core.mjs

@@ -121,14 +121,14 @@ export default class WalkontableFacade {
     let topmost = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
     return this._wot.getCell(coords, topmost);
   }
-  scrollViewport(coords, snapToTop, snapToRight, snapToBottom, snapToLeft) {
-    return this._wot.scrollViewport(coords, snapToTop, snapToRight, snapToBottom, snapToLeft);
+  scrollViewport(coords, horizontalSnap, verticalSnap) {
+    return this._wot.scrollViewport(coords, horizontalSnap, verticalSnap);
   }
-  scrollViewportHorizontally(column, snapToRight, snapToLeft) {
-    return this._wot.scrollViewportHorizontally(column, snapToRight, snapToLeft);
+  scrollViewportHorizontally(column, snapping) {
+    return this._wot.scrollViewportHorizontally(column, snapping);
   }
-  scrollViewportVertically(row, snapToTop, snapToBottom) {
-    return this._wot.scrollViewportVertically(row, snapToTop, snapToBottom);
+  scrollViewportVertically(row, snapping) {
+    return this._wot.scrollViewportVertically(row, snapping);
   }
   getViewport() {
     return this._wot.getViewport();

package/3rdparty/walkontable/src/scroll.js

@@ -3,6 +3,7 @@
 exports.__esModule = true;
 require("core-js/modules/es.error.cause.js");
 var _element = require("../../../helpers/dom/element");
+var _object = require("../../../helpers/object");
 function _classPrivateMethodInitSpec(e, a) { _checkPrivateRedeclaration(e, a), a.add(e); }
 function _checkPrivateRedeclaration(e, t) { if (t.has(e)) throw new TypeError("Cannot initialize the same private elements twice on an object"); }
 function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
@@ -39,15 +40,20 @@ class Scroll {
    * Scrolls viewport to a cell.
    *
    * @param {CellCoords} coords The cell coordinates.
-   * @param {boolean} [snapToTop] If `true`, viewport is scrolled to show the cell on the top of the table.
-   * @param {boolean} [snapToRight] If `true`, viewport is scrolled to show the cell on the right of the table.
-   * @param {boolean} [snapToBottom] If `true`, viewport is scrolled to show the cell on the bottom of the table.
-   * @param {boolean} [snapToLeft] If `true`, viewport is scrolled to show the cell on the left of the table.
+   * @param {'auto' | 'start' | 'end'} [horizontalSnap='auto'] If `'start'`, viewport is scrolled to show
+   * the cell on the left of the table. If `'end'`, viewport is scrolled to show the cell on the right of
+   * the table. When `'auto'`, the viewport is scrolled only when the column is outside of the viewport.
+   * @param {'auto' | 'top' | 'bottom'} [verticalSnap='auto'] If `'top'`, viewport is scrolled to show
+   * the cell on the top of the table. If `'bottom'`, viewport is scrolled to show the cell on the bottom of
+   * the table. When `'auto'`, the viewport is scrolled only when the row is outside of the viewport.
    * @returns {boolean}
    */
-  scrollViewport(coords, snapToTop, snapToRight, snapToBottom, snapToLeft) {
-    const scrolledHorizontally = this.scrollViewportHorizontally(coords.col, snapToRight, snapToLeft);
-    const scrolledVertically = this.scrollViewportVertically(coords.row, snapToTop, snapToBottom);
+  scrollViewport(coords, horizontalSnap, verticalSnap) {
+    if (coords.col < 0 || coords.row < 0) {
+      return false;
+    }
+    const scrolledHorizontally = this.scrollViewportHorizontally(coords.col, horizontalSnap);
+    const scrolledVertically = this.scrollViewportVertically(coords.row, verticalSnap);
     return scrolledHorizontally || scrolledVertically;
   }
 
@@ -55,42 +61,43 @@ class Scroll {
    * Scrolls viewport to a column.
    *
    * @param {number} column Visual column index.
-   * @param {boolean} [snapToRight] If `true`, viewport is scrolled to show the cell on the right of the table.
-   * @param {boolean} [snapToLeft] If `true`, viewport is scrolled to show the cell on the left of the table.
+   * @param {'auto' | 'start' | 'end'} [snapping='auto'] If `'start'`, viewport is scrolled to show
+   * the cell on the left of the table. If `'end'`, viewport is scrolled to show the cell on the right of
+   * the table. When `'auto'`, the viewport is scrolled only when the column is outside of the viewport.
    * @returns {boolean}
    */
-  scrollViewportHorizontally(column, snapToRight, snapToLeft) {
+  scrollViewportHorizontally(column) {
+    let snapping = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 'auto';
     const {
       drawn,
       totalColumns
     } = this.dataAccessObject;
-
-    // do not scroll the viewport when the column points to a range outside of the dataset
-    if (!drawn || !Number.isInteger(column) || column < 0 || column > totalColumns) {
+    if (!drawn) {
+      return false;
+    }
+    const snappingObject = (0, _object.createObjectPropListener)(snapping);
+    column = this.dataAccessObject.wtSettings.getSetting('onBeforeViewportScrollHorizontally', column, snappingObject);
+    if (!Number.isInteger(column) || column < 0 || column > totalColumns) {
       return false;
     }
-    const autoSnapping = snapToRight === undefined && snapToLeft === undefined;
+    snapping = snappingObject.value;
     const {
       fixedColumnsStart,
       inlineStartOverlay
     } = this.dataAccessObject;
+    const autoSnapping = snapping === 'auto';
 
-    // for auto-snapping (both snap* arguments are undefined) do not scroll the viewport
-    // when the columns points to the overlays
+    // for auto-snapping do not scroll the viewport when the columns points to the overlays
     if (autoSnapping && column < fixedColumnsStart) {
       return false;
     }
-    column = this.dataAccessObject.wtSettings.getSetting('onBeforeViewportScrollHorizontally', column);
-    if (!Number.isInteger(column) || column < 0 || column > totalColumns) {
-      return false;
-    }
     const firstColumn = this.getFirstVisibleColumn();
     const lastColumn = this.getLastVisibleColumn();
     let result = false;
     if (autoSnapping && (column < firstColumn || column > lastColumn) || !autoSnapping) {
       // if there is at least one fully visible column determine the snapping direction based on
-      // that columns or by snapToRight/snapToLeft flags, if provided.
-      result = inlineStartOverlay.scrollTo(column, autoSnapping ? column >= this.getLastPartiallyVisibleColumn() : snapToRight);
+      // that columns or by snapping flag, if provided.
+      result = inlineStartOverlay.scrollTo(column, autoSnapping ? column >= this.getLastPartiallyVisibleColumn() : snapping === 'end');
     }
     return result;
   }
@@ -99,43 +106,45 @@ class Scroll {
    * Scrolls viewport to a row.
    *
    * @param {number} row Visual row index.
-   * @param {boolean} [snapToTop] If `true`, viewport is scrolled to show the cell on the top of the table.
-   * @param {boolean} [snapToBottom] If `true`, viewport is scrolled to show the cell on the bottom of the table.
+   * @param {'auto' | 'top' | 'bottom'} [snapping='auto'] If `'top'`, viewport is scrolled to show
+   * the cell on the top of the table. If `'bottom'`, viewport is scrolled to show the cell on
+   * the bottom of the table. When `'auto'`, the viewport is scrolled only when the row is outside of
+   * the viewport.
    * @returns {boolean}
    */
-  scrollViewportVertically(row, snapToTop, snapToBottom) {
+  scrollViewportVertically(row) {
+    let snapping = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 'auto';
     const {
       drawn,
       totalRows
     } = this.dataAccessObject;
-
-    // do not scroll the viewport when the row points to a range outside of the dataset
-    if (!drawn || !Number.isInteger(row) || row < 0 || row > totalRows) {
+    if (!drawn) {
+      return false;
+    }
+    const snappingObject = (0, _object.createObjectPropListener)(snapping);
+    row = this.dataAccessObject.wtSettings.getSetting('onBeforeViewportScrollVertically', row, snappingObject);
+    if (!Number.isInteger(row) || row < 0 || row > totalRows) {
       return false;
     }
-    const autoSnapping = snapToTop === undefined && snapToBottom === undefined;
+    snapping = snappingObject.value;
     const {
       fixedRowsBottom,
       fixedRowsTop,
       topOverlay
     } = this.dataAccessObject;
+    const autoSnapping = snapping === 'auto';
 
-    // for auto-snapping (both snap* arguments are undefined) do not scroll the viewport
-    // when the rows points to the overlays
+    // for auto-snapping do not scroll the viewport when the rows points to the overlays
     if (autoSnapping && (row < fixedRowsTop || row > totalRows - fixedRowsBottom - 1)) {
       return false;
     }
-    row = this.dataAccessObject.wtSettings.getSetting('onBeforeViewportScrollVertically', row);
-    if (!Number.isInteger(row) || row < 0 || row > totalRows) {
-      return false;
-    }
     const firstRow = this.getFirstVisibleRow();
     const lastRow = this.getLastVisibleRow();
     let result = false;
     if (autoSnapping && (row < firstRow || row > lastRow) || !autoSnapping) {
       // if there is at least one fully visible row determine the snapping direction based on
-      // that rows or by snapToTop/snapToBottom flags, if provided.
-      result = topOverlay.scrollTo(row, autoSnapping ? row >= this.getLastPartiallyVisibleRow() : snapToBottom);
+      // that rows or by snapping flag, if provided.
+      result = topOverlay.scrollTo(row, autoSnapping ? row >= this.getLastPartiallyVisibleRow() : snapping === 'bottom');
     }
     return result;
   }

package/3rdparty/walkontable/src/scroll.mjs

@@ -6,6 +6,7 @@ function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol"
 function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != typeof i) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
 function _assertClassBrand(e, t, n) { if ("function" == typeof e ? e === t : e.has(t)) return arguments.length < 3 ? t : n; throw new TypeError("Private element is not present on this object"); }
 import { innerHeight, innerWidth, getScrollLeft, getScrollTop, offset } from "../../../helpers/dom/element.mjs";
+import { createObjectPropListener } from "../../../helpers/object.mjs";
 /**
  * @class Scroll
  */
@@ -36,15 +37,20 @@ class Scroll {
    * Scrolls viewport to a cell.
    *
    * @param {CellCoords} coords The cell coordinates.
-   * @param {boolean} [snapToTop] If `true`, viewport is scrolled to show the cell on the top of the table.
-   * @param {boolean} [snapToRight] If `true`, viewport is scrolled to show the cell on the right of the table.
-   * @param {boolean} [snapToBottom] If `true`, viewport is scrolled to show the cell on the bottom of the table.
-   * @param {boolean} [snapToLeft] If `true`, viewport is scrolled to show the cell on the left of the table.
+   * @param {'auto' | 'start' | 'end'} [horizontalSnap='auto'] If `'start'`, viewport is scrolled to show
+   * the cell on the left of the table. If `'end'`, viewport is scrolled to show the cell on the right of
+   * the table. When `'auto'`, the viewport is scrolled only when the column is outside of the viewport.
+   * @param {'auto' | 'top' | 'bottom'} [verticalSnap='auto'] If `'top'`, viewport is scrolled to show
+   * the cell on the top of the table. If `'bottom'`, viewport is scrolled to show the cell on the bottom of
+   * the table. When `'auto'`, the viewport is scrolled only when the row is outside of the viewport.
    * @returns {boolean}
    */
-  scrollViewport(coords, snapToTop, snapToRight, snapToBottom, snapToLeft) {
-    const scrolledHorizontally = this.scrollViewportHorizontally(coords.col, snapToRight, snapToLeft);
-    const scrolledVertically = this.scrollViewportVertically(coords.row, snapToTop, snapToBottom);
+  scrollViewport(coords, horizontalSnap, verticalSnap) {
+    if (coords.col < 0 || coords.row < 0) {
+      return false;
+    }
+    const scrolledHorizontally = this.scrollViewportHorizontally(coords.col, horizontalSnap);
+    const scrolledVertically = this.scrollViewportVertically(coords.row, verticalSnap);
     return scrolledHorizontally || scrolledVertically;
   }
 
@@ -52,42 +58,43 @@ class Scroll {
    * Scrolls viewport to a column.
    *
    * @param {number} column Visual column index.
-   * @param {boolean} [snapToRight] If `true`, viewport is scrolled to show the cell on the right of the table.
-   * @param {boolean} [snapToLeft] If `true`, viewport is scrolled to show the cell on the left of the table.
+   * @param {'auto' | 'start' | 'end'} [snapping='auto'] If `'start'`, viewport is scrolled to show
+   * the cell on the left of the table. If `'end'`, viewport is scrolled to show the cell on the right of
+   * the table. When `'auto'`, the viewport is scrolled only when the column is outside of the viewport.
    * @returns {boolean}
    */
-  scrollViewportHorizontally(column, snapToRight, snapToLeft) {
+  scrollViewportHorizontally(column) {
+    let snapping = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 'auto';
     const {
       drawn,
       totalColumns
     } = this.dataAccessObject;
-
-    // do not scroll the viewport when the column points to a range outside of the dataset
-    if (!drawn || !Number.isInteger(column) || column < 0 || column > totalColumns) {
+    if (!drawn) {
+      return false;
+    }
+    const snappingObject = createObjectPropListener(snapping);
+    column = this.dataAccessObject.wtSettings.getSetting('onBeforeViewportScrollHorizontally', column, snappingObject);
+    if (!Number.isInteger(column) || column < 0 || column > totalColumns) {
       return false;
     }
-    const autoSnapping = snapToRight === undefined && snapToLeft === undefined;
+    snapping = snappingObject.value;
     const {
       fixedColumnsStart,
       inlineStartOverlay
     } = this.dataAccessObject;
+    const autoSnapping = snapping === 'auto';
 
-    // for auto-snapping (both snap* arguments are undefined) do not scroll the viewport
-    // when the columns points to the overlays
+    // for auto-snapping do not scroll the viewport when the columns points to the overlays
     if (autoSnapping && column < fixedColumnsStart) {
       return false;
     }
-    column = this.dataAccessObject.wtSettings.getSetting('onBeforeViewportScrollHorizontally', column);
-    if (!Number.isInteger(column) || column < 0 || column > totalColumns) {
-      return false;
-    }
     const firstColumn = this.getFirstVisibleColumn();
     const lastColumn = this.getLastVisibleColumn();
     let result = false;
     if (autoSnapping && (column < firstColumn || column > lastColumn) || !autoSnapping) {
       // if there is at least one fully visible column determine the snapping direction based on
-      // that columns or by snapToRight/snapToLeft flags, if provided.
-      result = inlineStartOverlay.scrollTo(column, autoSnapping ? column >= this.getLastPartiallyVisibleColumn() : snapToRight);
+      // that columns or by snapping flag, if provided.
+      result = inlineStartOverlay.scrollTo(column, autoSnapping ? column >= this.getLastPartiallyVisibleColumn() : snapping === 'end');
     }
     return result;
   }
@@ -96,43 +103,45 @@ class Scroll {
    * Scrolls viewport to a row.
    *
    * @param {number} row Visual row index.
-   * @param {boolean} [snapToTop] If `true`, viewport is scrolled to show the cell on the top of the table.
-   * @param {boolean} [snapToBottom] If `true`, viewport is scrolled to show the cell on the bottom of the table.
+   * @param {'auto' | 'top' | 'bottom'} [snapping='auto'] If `'top'`, viewport is scrolled to show
+   * the cell on the top of the table. If `'bottom'`, viewport is scrolled to show the cell on
+   * the bottom of the table. When `'auto'`, the viewport is scrolled only when the row is outside of
+   * the viewport.
    * @returns {boolean}
    */
-  scrollViewportVertically(row, snapToTop, snapToBottom) {
+  scrollViewportVertically(row) {
+    let snapping = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 'auto';
     const {
       drawn,
       totalRows
     } = this.dataAccessObject;
-
-    // do not scroll the viewport when the row points to a range outside of the dataset
-    if (!drawn || !Number.isInteger(row) || row < 0 || row > totalRows) {
+    if (!drawn) {
+      return false;
+    }
+    const snappingObject = createObjectPropListener(snapping);
+    row = this.dataAccessObject.wtSettings.getSetting('onBeforeViewportScrollVertically', row, snappingObject);
+    if (!Number.isInteger(row) || row < 0 || row > totalRows) {
       return false;
     }
-    const autoSnapping = snapToTop === undefined && snapToBottom === undefined;
+    snapping = snappingObject.value;
     const {
       fixedRowsBottom,
       fixedRowsTop,
       topOverlay
     } = this.dataAccessObject;
+    const autoSnapping = snapping === 'auto';
 
-    // for auto-snapping (both snap* arguments are undefined) do not scroll the viewport
-    // when the rows points to the overlays
+    // for auto-snapping do not scroll the viewport when the rows points to the overlays
     if (autoSnapping && (row < fixedRowsTop || row > totalRows - fixedRowsBottom - 1)) {
       return false;
     }
-    row = this.dataAccessObject.wtSettings.getSetting('onBeforeViewportScrollVertically', row);
-    if (!Number.isInteger(row) || row < 0 || row > totalRows) {
-      return false;
-    }
     const firstRow = this.getFirstVisibleRow();
     const lastRow = this.getLastVisibleRow();
     let result = false;
     if (autoSnapping && (row < firstRow || row > lastRow) || !autoSnapping) {
       // if there is at least one fully visible row determine the snapping direction based on
-      // that rows or by snapToTop/snapToBottom flags, if provided.
-      result = topOverlay.scrollTo(row, autoSnapping ? row >= this.getLastPartiallyVisibleRow() : snapToBottom);
+      // that rows or by snapping flag, if provided.
+      result = topOverlay.scrollTo(row, autoSnapping ? row >= this.getLastPartiallyVisibleRow() : snapping === 'bottom');
     }
     return result;
   }

package/base.js

@@ -45,8 +45,8 @@ Handsontable.hooks = _hooks.Hooks.getSingleton();
 Handsontable.CellCoords = _src.CellCoords;
 Handsontable.CellRange = _src.CellRange;
 Handsontable.packageName = 'handsontable';
-Handsontable.buildDate = "25/11/2024 11:12:47";
-Handsontable.version = "0.0.0-next-1af4e47-20241125";
+Handsontable.buildDate = "27/11/2024 10:03:09";
+Handsontable.version = "0.0.0-next-c3d40ad-20241127";
 Handsontable.languages = {
   dictionaryKeys: _registry.dictionaryKeys,
   getLanguageDictionary: _registry.getLanguageDictionary,

package/base.mjs

@@ -35,8 +35,8 @@ Handsontable.hooks = Hooks.getSingleton();
 Handsontable.CellCoords = CellCoords;
 Handsontable.CellRange = CellRange;
 Handsontable.packageName = 'handsontable';
-Handsontable.buildDate = "25/11/2024 11:12:53";
-Handsontable.version = "0.0.0-next-1af4e47-20241125";
+Handsontable.buildDate = "27/11/2024 10:03:15";
+Handsontable.version = "0.0.0-next-c3d40ad-20241127";
 Handsontable.languages = {
   dictionaryKeys,
   getLanguageDictionary,

package/core/hooks/constants.js

@@ -543,6 +543,10 @@ const REGISTERED_HOOKS = exports.REGISTERED_HOOKS = [/* eslint-disable jsdoc/req
  * @since 14.0.0
  * @event Hooks#beforeViewportScrollVertically
  * @param {number} visualRow Visual row index.
+ * @param {'auto' | 'top' | 'bottom'} [snapping='auto'] If `'top'`, viewport is scrolled to show
+ * the cell on the top of the table. If `'bottom'`, viewport is scrolled to show the cell on
+ * the bottom of the table. When `'auto'`, the viewport is scrolled only when the row is outside of
+ * the viewport.
  * @returns {number | boolean} Returns modified row index (or the same as passed in the method argument) to which
  * the viewport will be scrolled. If the returned value is `false`, the scrolling will be canceled.
  */
@@ -554,6 +558,9 @@ const REGISTERED_HOOKS = exports.REGISTERED_HOOKS = [/* eslint-disable jsdoc/req
  * @since 14.0.0
  * @event Hooks#beforeViewportScrollHorizontally
  * @param {number} visualColumn Visual column index.
+ * @param {'auto' | 'start' | 'end'} [snapping='auto'] If `'start'`, viewport is scrolled to show
+ * the cell on the left of the table. If `'end'`, viewport is scrolled to show the cell on the right of
+ * the table. When `'auto'`, the viewport is scrolled only when the column is outside of the viewport.
  * @returns {number | boolean} Returns modified column index (or the same as passed in the method argument) to which
  * the viewport will be scrolled. If the returned value is `false`, the scrolling will be canceled.
  */

package/core/hooks/constants.mjs

@@ -540,6 +540,10 @@ export const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-com
  * @since 14.0.0
  * @event Hooks#beforeViewportScrollVertically
  * @param {number} visualRow Visual row index.
+ * @param {'auto' | 'top' | 'bottom'} [snapping='auto'] If `'top'`, viewport is scrolled to show
+ * the cell on the top of the table. If `'bottom'`, viewport is scrolled to show the cell on
+ * the bottom of the table. When `'auto'`, the viewport is scrolled only when the row is outside of
+ * the viewport.
  * @returns {number | boolean} Returns modified row index (or the same as passed in the method argument) to which
  * the viewport will be scrolled. If the returned value is `false`, the scrolling will be canceled.
  */
@@ -551,6 +555,9 @@ export const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-com
  * @since 14.0.0
  * @event Hooks#beforeViewportScrollHorizontally
  * @param {number} visualColumn Visual column index.
+ * @param {'auto' | 'start' | 'end'} [snapping='auto'] If `'start'`, viewport is scrolled to show
+ * the cell on the left of the table. If `'end'`, viewport is scrolled to show the cell on the right of
+ * the table. When `'auto'`, the viewport is scrolled only when the column is outside of the viewport.
  * @returns {number | boolean} Returns modified column index (or the same as passed in the method argument) to which
  * the viewport will be scrolled. If the returned value is `false`, the scrolling will be canceled.
  */

package/core/hooks/index.d.ts

@@ -226,8 +226,8 @@ export interface Events {
   beforeUpdateData?: (sourceData: CellValue[], initialLoad: boolean, source: string | undefined) => void;
   beforeValidate?: (value: CellValue, row: number, prop: string | number, source?: ChangeSource) => void;
   beforeValueRender?: (value: CellValue, cellProperties: CellProperties) => void;
-  beforeViewportScrollVertically?: (visualRow: number) => number | boolean;
-  beforeViewportScrollHorizontally?: (visualColumn: number) => number | boolean;
+  beforeViewportScrollVertically?: (visualRow: number, snapping: 'auto' | 'top' | 'bottom') => number | boolean | null;
+  beforeViewportScrollHorizontally?: (visualColumn: number, snapping: 'auto' | 'start' | 'end') => number | boolean | null;
   beforeViewportScroll?: () => void;
   beforeViewRender?: (isForced: boolean, skipRender: { skipRender?: boolean }) => void;
   construct?: () => void;

package/core.js

@@ -4083,22 +4083,8 @@ function Core(rootElement, userSettings) {
     const {
       row,
       col,
-      verticalSnap,
-      horizontalSnap,
       considerHiddenIndexes
     } = (_options = options) !== null && _options !== void 0 ? _options : {};
-    let snapToTop;
-    let snapToBottom;
-    let snapToInlineStart;
-    let snapToInlineEnd;
-    if (verticalSnap !== undefined) {
-      snapToTop = verticalSnap === 'top';
-      snapToBottom = !snapToTop;
-    }
-    if (horizontalSnap !== undefined) {
-      snapToInlineStart = horizontalSnap === 'start';
-      snapToInlineEnd = !snapToInlineStart;
-    }
     let renderableRow = row;
     let renderableColumn = col;
     if (considerHiddenIndexes === undefined || considerHiddenIndexes) {
@@ -4115,13 +4101,13 @@ function Core(rootElement, userSettings) {
     const isRowInteger = Number.isInteger(renderableRow);
     const isColumnInteger = Number.isInteger(renderableColumn);
     if (isRowInteger && renderableRow >= 0 && isColumnInteger && renderableColumn >= 0) {
-      return instance.view.scrollViewport(instance._createCellCoords(renderableRow, renderableColumn), snapToTop, snapToInlineEnd, snapToBottom, snapToInlineStart);
+      return instance.view.scrollViewport(instance._createCellCoords(renderableRow, renderableColumn), options.horizontalSnap, options.verticalSnap);
     }
     if (isRowInteger && renderableRow >= 0 && (isColumnInteger && renderableColumn < 0 || !isColumnInteger)) {
-      return instance.view.scrollViewportVertically(renderableRow, snapToTop, snapToBottom);
+      return instance.view.scrollViewportVertically(renderableRow, options.verticalSnap);
     }
     if (isColumnInteger && renderableColumn >= 0 && (isRowInteger && renderableRow < 0 || !isRowInteger)) {
-      return instance.view.scrollViewportHorizontally(renderableColumn, snapToInlineEnd, snapToInlineStart);
+      return instance.view.scrollViewportHorizontally(renderableColumn, options.horizontalSnap);
     }
     return false;
   };