handsontable 14.1.0 → 14.2.0-next-7ae341f-20240229

package/core.js

@@ -110,7 +110,6 @@ function Core(rootElement, userSettings) {
   var _userSettings$layoutD,
     _this = this;
   let rootInstanceSymbol = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : false;
-  let preventScrollingToCell = false;
   let instance = this;
   const eventManager = new _eventManager.default(instance);
   let datamap;
@@ -118,6 +117,7 @@ function Core(rootElement, userSettings) {
   let grid;
   let editorManager;
   let focusManager;
+  let viewportScroller;
   let firstRun = true;
   if ((0, _rootInstance.hasValidParameter)(rootInstanceSymbol)) {
     (0, _rootInstance.registerAsRootInstance)(this);
@@ -307,7 +307,7 @@ function Core(rootElement, userSettings) {
   };
   this.columnIndexMapper.addLocalHook('cacheUpdated', onIndexMapperCacheUpdate);
   this.rowIndexMapper.addLocalHook('cacheUpdated', onIndexMapperCacheUpdate);
-  this.selection.addLocalHook('afterSetRangeEnd', cellCoords => {
+  this.selection.addLocalHook('afterSetRangeEnd', (cellCoords, isLastSelectionLayer) => {
     const preventScrolling = (0, _object.createObjectPropListener)(false);
     const selectionRange = this.selection.getSelectedRange();
     const {
@@ -316,53 +316,12 @@ function Core(rootElement, userSettings) {
     } = selectionRange.current();
     const selectionLayerLevel = selectionRange.size() - 1;
     this.runHooks('afterSelection', from.row, from.col, to.row, to.col, preventScrolling, selectionLayerLevel);
-    this.runHooks('afterSelectionByProp', from.row, instance.colToProp(from.col), to.row, instance.colToProp(to.col), preventScrolling, selectionLayerLevel); // eslint-disable-line max-len
-
-    let scrollToCell = true;
-    if (preventScrollingToCell) {
-      scrollToCell = false;
-    }
-    if (preventScrolling.isTouched()) {
-      scrollToCell = !preventScrolling.value;
-    }
-    const currentSelectedRange = this.selection.selectedRange.current();
-    const isSelectedByAnyHeader = this.selection.isSelectedByAnyHeader();
-    const isSelectedByRowHeader = this.selection.isSelectedByRowHeader();
-    const isSelectedByColumnHeader = this.selection.isSelectedByColumnHeader();
-    if (scrollToCell !== false) {
-      if (!isSelectedByAnyHeader) {
-        if (currentSelectedRange && !this.selection.isMultiple()) {
-          const {
-            row,
-            col
-          } = currentSelectedRange.from;
-          if (row < 0 && col >= 0) {
-            this.scrollViewportTo({
-              col
-            });
-          } else if (col < 0 && row >= 0) {
-            this.scrollViewportTo({
-              row
-            });
-          } else {
-            this.scrollViewportTo({
-              row,
-              col
-            });
-          }
-        } else {
-          this.scrollViewportTo(cellCoords.toObject());
-        }
-      } else if (isSelectedByRowHeader) {
-        this.scrollViewportTo({
-          row: cellCoords.row
-        });
-      } else if (isSelectedByColumnHeader) {
-        this.scrollViewportTo({
-          col: cellCoords.col
-        });
-      }
+    this.runHooks('afterSelectionByProp', from.row, instance.colToProp(from.col), to.row, instance.colToProp(to.col), preventScrolling, selectionLayerLevel);
+    if (isLastSelectionLayer && (!preventScrolling.isTouched() || preventScrolling.isTouched() && !preventScrolling.value)) {
+      viewportScroller.scrollTo(cellCoords);
     }
+    const isSelectedByRowHeader = selection.isSelectedByRowHeader();
+    const isSelectedByColumnHeader = selection.isSelectedByColumnHeader();
 
     // @TODO: These CSS classes are no longer needed anymore. They are used only as a indicator of the selected
     // rows/columns in the MergedCells plugin (via border.js#L520 in the walkontable module). After fixing
@@ -1098,6 +1057,7 @@ function Core(rootElement, userSettings) {
     this.updateSettings(tableMeta, true);
     this.view = new _tableView.default(this);
     editorManager = _editorManager.default.getInstance(instance, tableMeta, selection);
+    viewportScroller = (0, _index3.createViewportScroller)(instance);
     focusManager = new _focusManager.FocusManager(instance);
     if ((0, _rootInstance.isRootInstance)(this)) {
       (0, _index3.installFocusCatcher)(instance);
@@ -3915,13 +3875,13 @@ function Core(rootElement, userSettings) {
     let scrollToCell = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : true;
     let changeListener = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : true;
     if (scrollToCell === false) {
-      preventScrollingToCell = true;
+      viewportScroller.suspend();
     }
     const wasSelected = selection.selectCells(coords);
     if (wasSelected && changeListener) {
       instance.listen();
     }
-    preventScrollingToCell = false;
+    viewportScroller.resume();
     return wasSelected;
   };
 
@@ -4053,9 +4013,8 @@ function Core(rootElement, userSettings) {
     let includeRowHeaders = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : true;
     let includeColumnHeaders = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : includeRowHeaders;
     let options = arguments.length > 2 ? arguments[2] : undefined;
-    preventScrollingToCell = true;
+    viewportScroller.skipNextScrollCycle();
     selection.selectAll(includeRowHeaders, includeColumnHeaders, options);
-    preventScrollingToCell = false;
   };
   const getIndexToScroll = (indexMapper, visualIndex) => {
     // Looking for a visual index on the right and then (when not found) on the left.

package/core.mjs

@@ -28,7 +28,7 @@ import { hasLanguageDictionary, getValidLanguageCode, getTranslatedPhrase } from
 import { warnUserAboutLanguageRegistration, normalizeLanguageCode } from "./i18n/utils.mjs";
 import { Selection } from "./selection/index.mjs";
 import { MetaManager, DynamicCellMetaMod, ExtendMetaPropertiesMod, replaceData } from "./dataMap/index.mjs";
-import { installFocusCatcher } from "./core/index.mjs";
+import { installFocusCatcher, createViewportScroller } from "./core/index.mjs";
 import { createUniqueMap } from "./utils/dataStructures/uniqueMap.mjs";
 import { createShortcutManager } from "./shortcuts/index.mjs";
 import { registerAllShortcutContexts } from "./shortcutContexts/index.mjs";
@@ -105,7 +105,6 @@ export default function Core(rootElement, userSettings) {
   var _userSettings$layoutD,
     _this = this;
   let rootInstanceSymbol = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : false;
-  let preventScrollingToCell = false;
   let instance = this;
   const eventManager = new EventManager(instance);
   let datamap;
@@ -113,6 +112,7 @@ export default function Core(rootElement, userSettings) {
   let grid;
   let editorManager;
   let focusManager;
+  let viewportScroller;
   let firstRun = true;
   if (hasValidParameter(rootInstanceSymbol)) {
     registerAsRootInstance(this);
@@ -302,7 +302,7 @@ export default function Core(rootElement, userSettings) {
   };
   this.columnIndexMapper.addLocalHook('cacheUpdated', onIndexMapperCacheUpdate);
   this.rowIndexMapper.addLocalHook('cacheUpdated', onIndexMapperCacheUpdate);
-  this.selection.addLocalHook('afterSetRangeEnd', cellCoords => {
+  this.selection.addLocalHook('afterSetRangeEnd', (cellCoords, isLastSelectionLayer) => {
     const preventScrolling = createObjectPropListener(false);
     const selectionRange = this.selection.getSelectedRange();
     const {
@@ -311,53 +311,12 @@ export default function Core(rootElement, userSettings) {
     } = selectionRange.current();
     const selectionLayerLevel = selectionRange.size() - 1;
     this.runHooks('afterSelection', from.row, from.col, to.row, to.col, preventScrolling, selectionLayerLevel);
-    this.runHooks('afterSelectionByProp', from.row, instance.colToProp(from.col), to.row, instance.colToProp(to.col), preventScrolling, selectionLayerLevel); // eslint-disable-line max-len
-
-    let scrollToCell = true;
-    if (preventScrollingToCell) {
-      scrollToCell = false;
-    }
-    if (preventScrolling.isTouched()) {
-      scrollToCell = !preventScrolling.value;
-    }
-    const currentSelectedRange = this.selection.selectedRange.current();
-    const isSelectedByAnyHeader = this.selection.isSelectedByAnyHeader();
-    const isSelectedByRowHeader = this.selection.isSelectedByRowHeader();
-    const isSelectedByColumnHeader = this.selection.isSelectedByColumnHeader();
-    if (scrollToCell !== false) {
-      if (!isSelectedByAnyHeader) {
-        if (currentSelectedRange && !this.selection.isMultiple()) {
-          const {
-            row,
-            col
-          } = currentSelectedRange.from;
-          if (row < 0 && col >= 0) {
-            this.scrollViewportTo({
-              col
-            });
-          } else if (col < 0 && row >= 0) {
-            this.scrollViewportTo({
-              row
-            });
-          } else {
-            this.scrollViewportTo({
-              row,
-              col
-            });
-          }
-        } else {
-          this.scrollViewportTo(cellCoords.toObject());
-        }
-      } else if (isSelectedByRowHeader) {
-        this.scrollViewportTo({
-          row: cellCoords.row
-        });
-      } else if (isSelectedByColumnHeader) {
-        this.scrollViewportTo({
-          col: cellCoords.col
-        });
-      }
+    this.runHooks('afterSelectionByProp', from.row, instance.colToProp(from.col), to.row, instance.colToProp(to.col), preventScrolling, selectionLayerLevel);
+    if (isLastSelectionLayer && (!preventScrolling.isTouched() || preventScrolling.isTouched() && !preventScrolling.value)) {
+      viewportScroller.scrollTo(cellCoords);
     }
+    const isSelectedByRowHeader = selection.isSelectedByRowHeader();
+    const isSelectedByColumnHeader = selection.isSelectedByColumnHeader();
 
     // @TODO: These CSS classes are no longer needed anymore. They are used only as a indicator of the selected
     // rows/columns in the MergedCells plugin (via border.js#L520 in the walkontable module). After fixing
@@ -1093,6 +1052,7 @@ export default function Core(rootElement, userSettings) {
     this.updateSettings(tableMeta, true);
     this.view = new TableView(this);
     editorManager = EditorManager.getInstance(instance, tableMeta, selection);
+    viewportScroller = createViewportScroller(instance);
     focusManager = new FocusManager(instance);
     if (isRootInstance(this)) {
       installFocusCatcher(instance);
@@ -3910,13 +3870,13 @@ export default function Core(rootElement, userSettings) {
     let scrollToCell = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : true;
     let changeListener = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : true;
     if (scrollToCell === false) {
-      preventScrollingToCell = true;
+      viewportScroller.suspend();
     }
     const wasSelected = selection.selectCells(coords);
     if (wasSelected && changeListener) {
       instance.listen();
     }
-    preventScrollingToCell = false;
+    viewportScroller.resume();
     return wasSelected;
   };
 
@@ -4048,9 +4008,8 @@ export default function Core(rootElement, userSettings) {
     let includeRowHeaders = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : true;
     let includeColumnHeaders = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : includeRowHeaders;
     let options = arguments.length > 2 ? arguments[2] : undefined;
-    preventScrollingToCell = true;
+    viewportScroller.skipNextScrollCycle();
     selection.selectAll(includeRowHeaders, includeColumnHeaders, options);
-    preventScrollingToCell = false;
   };
   const getIndexToScroll = (indexMapper, visualIndex) => {
     // Looking for a visual index on the right and then (when not found) on the left.

package/dataMap/metaManager/index.js

@@ -218,7 +218,7 @@ class MetaManager {
 
   /**
    * Returns all cell meta objects that were created during the Handsontable operation but for
-   * specyfic row index.
+   * specific row index.
    *
    * @param {number} physicalRow The physical row index.
    * @returns {object[]}

package/dataMap/metaManager/index.mjs

@@ -214,7 +214,7 @@ export default class MetaManager {
 
   /**
    * Returns all cell meta objects that were created during the Handsontable operation but for
-   * specyfic row index.
+   * specific row index.
    *
    * @param {number} physicalRow The physical row index.
    * @returns {object[]}

package/dataMap/metaManager/metaLayers/cellMeta.js

@@ -6,6 +6,7 @@ require("core-js/modules/es.error.cause.js");
 var _object = require("../../../helpers/object");
 var _utils = require("../utils");
 var _lazyFactoryMap = _interopRequireDefault(require("../lazyFactoryMap"));
+var _mixed = require("../../../helpers/mixed");
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
 function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == typeof i ? i : String(i); }
@@ -171,7 +172,11 @@ class CellMeta {
     const metas = [];
     const rows = Array.from(this.metas.values());
     for (let row = 0; row < rows.length; row++) {
-      metas.push(...rows[row].values());
+      // Getting a meta for already added row (new row already exist - it has been added using `createRow` method).
+      // However, is not ready until the first `getMeta` call (lazy loading).
+      if ((0, _mixed.isDefined)(rows[row])) {
+        metas.push(...rows[row].values());
+      }
     }
     return metas;
   }

package/dataMap/metaManager/metaLayers/cellMeta.mjs

@@ -6,6 +6,7 @@ function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e =
 import { extend } from "../../../helpers/object.mjs";
 import { extendByMetaType, assert, isUnsignedNumber } from "../utils.mjs";
 import LazyFactoryMap from "../lazyFactoryMap.mjs";
+import { isDefined } from "../../../helpers/mixed.mjs";
 /* eslint-disable jsdoc/require-description-complete-sentence */
 /**
  * @class CellMeta
@@ -167,7 +168,11 @@ export default class CellMeta {
     const metas = [];
     const rows = Array.from(this.metas.values());
     for (let row = 0; row < rows.length; row++) {
-      metas.push(...rows[row].values());
+      // Getting a meta for already added row (new row already exist - it has been added using `createRow` method).
+      // However, is not ready until the first `getMeta` call (lazy loading).
+      if (isDefined(rows[row])) {
+        metas.push(...rows[row].values());
+      }
     }
     return metas;
   }

package/dataMap/metaManager/metaSchema.js

@@ -1169,9 +1169,9 @@ var _default = () => {
      * ]
      *
      * // enable copying for specific cells
-     * cells: [
+     * cell: [
      *   {
-     *     cell: 0,
+     *     coll: 0,
      *     row: 0,
      *     // disable copying for cell (0, 0)
      *     copyable: false,
@@ -2217,7 +2217,7 @@ var _default = () => {
      *
      * formulas: {
      *   // set `engine` to a HyperFormula instance
-     *   engine: hyperFormulaInstance,
+     *   engine: hyperformulaInstance,
      *   sheetId: 1,
      *   sheetName: 'Sheet 1'
      * }
@@ -2226,7 +2226,7 @@ var _default = () => {
      * formulas: {
      *   // set `engine` to a HyperFormula configuration object
      *   engine: {
-     *     hyperformula: HyperFormula // or `engine: hyperFormulaInstance`
+     *     hyperformula: HyperFormula // or `engine: hyperformulaInstance`
      *     leapYear1900: false,       // this option comes from HyperFormula
      *     // add more HyperFormula configuration options
      *   },
@@ -2257,7 +2257,7 @@ var _default = () => {
      *
      * You can set the `fragmentSelection` option to one of the following:
      *
-     * | Setting           | Decription                                        |
+     * | Setting           | Description                                        |
      * | ----------------- | ------------------------------------------------- |
      * | `false` (default) | Disable text selection                            |
      * | `true`            | Enable text selection in multiple cells at a time |
@@ -3209,7 +3209,7 @@ var _default = () => {
      * | `true`            | Enable the [`NestedRows`](@/api/nestedRows.md) plugin  |
      *
      * Read more:
-     * - [Plugins: `NestedRows`](@/api/nestedRows.md)
+     * - [Plugins: `NestedRows`](@/guides/rows/row-parent-child.md)
      *
      * @example
      * ```js
@@ -3493,11 +3493,11 @@ var _default = () => {
     preventWheel: false,
     /**
      * @description
-     * The `readOnly` option determines whether a cell, column or comment is editable or not.
-     *
-     * You can set the `readOnly` option to one of the following:
+     * The `readOnly` option determines whether a [cell](@/guides/cell-features/disabled-cells.md#read-only-specific-cells),
+     * [comment](@/guides/cell-features/comments.md#make-a-comment-read-only), [column](@/guides/cell-features/disabled-cells.md#read-only-columns)
+     * or the [entire grid](@/guides/cell-features/disabled-cells.md#read-only-grid) is editable or not. You can configure it as follows:
      *
-     * | Setting           | Decription                                                                                                                |
+     * | Setting           | Description                                                                                                                |
      * | ----------------- | ------------------------------------------------------------------------------------------------------------------------- |
      * | `false` (default) | Set as editable                                                                                                           |
      * | `true`            | - Set as read-only<br>- Add the [`readOnlyCellClassName`](#readOnlyCellClassName) CSS class name (by default: `htDimmed`) |
@@ -3505,6 +3505,7 @@ var _default = () => {
      * `readOnly` cells can't be changed by the [`populateFromArray()`](@/api/core.md#populatefromarray) method.
      *
      * Read more:
+     * - [Disabled cells](@/guides/cell-features/disabled-cells.md)
      * - [Configuration options: Cascading configuration](@/guides/getting-started/configuration-options.md#cascading-configuration)
      *
      * @memberof Options#
@@ -3514,8 +3515,31 @@ var _default = () => {
      *
      * @example
      * ```js
-     * // set as read-only
-     * readOnly: true,
+     * // make the entire grid read-only
+     * const configurationOptions = {
+     *   columnSorting: true,
+     * };
+     *
+     * // make the third column read-only
+     * const configurationOptions = {
+     *   columns: [
+     *     {},
+     *     {},
+     *     {
+     *       readOnly: true,
+     *     },
+     *   ],
+     * };
+     *
+     * // make a specific cell read-only
+     * const configurationOptions = {
+     *   cell: [
+     *     {
+     *       row: 0,
+     *       col: 0,
+     *       readOnly: true,
+     *     },
+     * };
      * ```
      */
     readOnly: false,

package/dataMap/metaManager/metaSchema.mjs

@@ -1166,9 +1166,9 @@ export default (() => {
      * ]
      *
      * // enable copying for specific cells
-     * cells: [
+     * cell: [
      *   {
-     *     cell: 0,
+     *     coll: 0,
      *     row: 0,
      *     // disable copying for cell (0, 0)
      *     copyable: false,
@@ -2214,7 +2214,7 @@ export default (() => {
      *
      * formulas: {
      *   // set `engine` to a HyperFormula instance
-     *   engine: hyperFormulaInstance,
+     *   engine: hyperformulaInstance,
      *   sheetId: 1,
      *   sheetName: 'Sheet 1'
      * }
@@ -2223,7 +2223,7 @@ export default (() => {
      * formulas: {
      *   // set `engine` to a HyperFormula configuration object
      *   engine: {
-     *     hyperformula: HyperFormula // or `engine: hyperFormulaInstance`
+     *     hyperformula: HyperFormula // or `engine: hyperformulaInstance`
      *     leapYear1900: false,       // this option comes from HyperFormula
      *     // add more HyperFormula configuration options
      *   },
@@ -2254,7 +2254,7 @@ export default (() => {
      *
      * You can set the `fragmentSelection` option to one of the following:
      *
-     * | Setting           | Decription                                        |
+     * | Setting           | Description                                        |
      * | ----------------- | ------------------------------------------------- |
      * | `false` (default) | Disable text selection                            |
      * | `true`            | Enable text selection in multiple cells at a time |
@@ -3206,7 +3206,7 @@ export default (() => {
      * | `true`            | Enable the [`NestedRows`](@/api/nestedRows.md) plugin  |
      *
      * Read more:
-     * - [Plugins: `NestedRows`](@/api/nestedRows.md)
+     * - [Plugins: `NestedRows`](@/guides/rows/row-parent-child.md)
      *
      * @example
      * ```js
@@ -3490,11 +3490,11 @@ export default (() => {
     preventWheel: false,
     /**
      * @description
-     * The `readOnly` option determines whether a cell, column or comment is editable or not.
-     *
-     * You can set the `readOnly` option to one of the following:
+     * The `readOnly` option determines whether a [cell](@/guides/cell-features/disabled-cells.md#read-only-specific-cells),
+     * [comment](@/guides/cell-features/comments.md#make-a-comment-read-only), [column](@/guides/cell-features/disabled-cells.md#read-only-columns)
+     * or the [entire grid](@/guides/cell-features/disabled-cells.md#read-only-grid) is editable or not. You can configure it as follows:
      *
-     * | Setting           | Decription                                                                                                                |
+     * | Setting           | Description                                                                                                                |
      * | ----------------- | ------------------------------------------------------------------------------------------------------------------------- |
      * | `false` (default) | Set as editable                                                                                                           |
      * | `true`            | - Set as read-only<br>- Add the [`readOnlyCellClassName`](#readOnlyCellClassName) CSS class name (by default: `htDimmed`) |
@@ -3502,6 +3502,7 @@ export default (() => {
      * `readOnly` cells can't be changed by the [`populateFromArray()`](@/api/core.md#populatefromarray) method.
      *
      * Read more:
+     * - [Disabled cells](@/guides/cell-features/disabled-cells.md)
      * - [Configuration options: Cascading configuration](@/guides/getting-started/configuration-options.md#cascading-configuration)
      *
      * @memberof Options#
@@ -3511,8 +3512,31 @@ export default (() => {
      *
      * @example
      * ```js
-     * // set as read-only
-     * readOnly: true,
+     * // make the entire grid read-only
+     * const configurationOptions = {
+     *   columnSorting: true,
+     * };
+     *
+     * // make the third column read-only
+     * const configurationOptions = {
+     *   columns: [
+     *     {},
+     *     {},
+     *     {
+     *       readOnly: true,
+     *     },
+     *   ],
+     * };
+     *
+     * // make a specific cell read-only
+     * const configurationOptions = {
+     *   cell: [
+     *     {
+     *       row: 0,
+     *       col: 0,
+     *       readOnly: true,
+     *     },
+     * };
      * ```
      */
     readOnly: false,

package/dist/handsontable.css

@@ -25,8 +25,8 @@
  * INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES OF ANY CHARACTER ARISING FROM
  * USE OR INABILITY TO USE THIS SOFTWARE.
  *
- * Version: 14.1.0
- * Release date: 16/01/2024 (built at 16/01/2024 10:27:31)
+ * Version: 14.2.0-next-7ae341f-20240229
+ * Release date: 06/03/2024 (built at 29/02/2024 08:44:44)
  */
 /**
  * Fix for bootstrap styles

package/dist/handsontable.full.css

@@ -25,8 +25,8 @@
  * INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES OF ANY CHARACTER ARISING FROM
  * USE OR INABILITY TO USE THIS SOFTWARE.
  *
- * Version: 14.1.0
- * Release date: 16/01/2024 (built at 16/01/2024 10:27:31)
+ * Version: 14.2.0-next-7ae341f-20240229
+ * Release date: 06/03/2024 (built at 29/02/2024 08:44:44)
  */
 /**
  * Fix for bootstrap styles