handsontable 0.0.0-next-3d099da-20231208 → 0.0.0-next-16c18c1-20231212

package/pluginHooks.js

@@ -10,8 +10,8 @@ var _console = require("./helpers/console");
 var _templateLiteralTag = require("./helpers/templateLiteralTag");
 var _function = require("./helpers/function");
 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(arg) { var key = _toPrimitive(arg, "string"); return typeof key === "symbol" ? key : String(key); }
-function _toPrimitive(input, hint) { if (typeof input !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (typeof res !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == typeof i ? i : String(i); }
+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); }
 /* eslint-disable jsdoc/require-description-complete-sentence */
 /**
  * @description
@@ -122,7 +122,9 @@ function _toPrimitive(input, hint) { if (typeof input !== "object" || input ===
  * });
  * :::
  * ...
- */ // @TODO: Move plugin description hooks to plugin?
+ */
+
+// @TODO: Move plugin description hooks to plugin?
 const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-complete-sentence */
 /**
  * Fired after resetting a cell's meta. This happens when the {@link Core#updateSettings} method is called.
@@ -1511,36 +1513,26 @@ const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-complete-s
  * Fired by {@link CopyPaste} plugin before copying the values to the clipboard and before clearing values of
  * the selected cells. This hook is fired when {@link Options#copyPaste} option is enabled.
  *
- * Note: Please keep in mind since @15.0.0 the method arguments has been changed.
- *
  * @event Hooks#beforeCut
- * @param {object} clipboardData Information about cut action which is going to happen.
- * @param {Function} clipboardData.removeRow Remove row from the copied dataset.
- * @param {Function} clipboardData.removeColumn Remove column from the copied dataset.
- * @param {Function} clipboardData.insertAtRow Insert values at row index.
- * @param {Function} clipboardData.insertAtColumn Insert values at column index.
- * @param {Function} clipboardData.setCellAt Change headers or cells in the copied dataset.
- * @param {Function} clipboardData.getCellAt Get headers or cells from the copied dataset.
- * @param {Function} clipboardData.getData Gets copied data stored as array of arrays.
- * @param {Function} clipboardData.getMetaInfo Gets meta information for the copied data.
- * @param {Function} clipboardData.setMetaInfo Sets meta information for the copied data.
- * @param {Function} clipboardData.getRanges Returns ranges related to copied part of Handsontable.
+ * @param {Array[]} data An array of arrays which contains data to cut.
+ * @param {object[]} coords An array of objects with ranges of the visual indexes (`startRow`, `startCol`, `endRow`, `endCol`)
+ *                       which will be cut out.
  * @returns {*} If returns `false` then operation of the cutting out is canceled.
  * @example
  * ::: only-for javascript
  * ```js
- * // To disregard a single row or column, remove it from copied dataset using `removeRows`/`removeColumns` method on the object from the first callback argument.
+ * // To disregard a single row, remove it from the array using data.splice(i, 1).
  * new Handsontable(element, {
- *   beforeCut: function(clipboardData) {
- *     // clipboardData.getData() -> [[1, 2, 3], [4, 5, 6]]
- *    clipboardData.removeRows([0]);
- *    clipboardData.removeColumns([0]);
- *     // clipboardData.getData() -> [[5, 6]]
+ *   beforeCut: function(data, coords) {
+ *     // data -> [[1, 2, 3], [4, 5, 6]]
+ *     data.splice(0, 1);
+ *     // data -> [[4, 5, 6]]
+ *     // coords -> [{startRow: 0, startCol: 0, endRow: 1, endCol: 2}]
  *   }
  * });
  * // To cancel a cutting action, just return `false`.
  * new Handsontable(element, {
- *   beforeCut: function(clipboardData) {
+ *   beforeCut: function(data, coords) {
  *     return false;
  *   }
  * });
@@ -1549,18 +1541,18 @@ const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-complete-s
  *
  * ::: only-for react
  * ```jsx
- * // To disregard a single row or column, remove it from copied dataset using `removeRows`/`removeColumns` method on the object from the first callback argument.
+ * // To disregard a single row, remove it from the array using data.splice(i, 1).
  * <HotTable
- *   beforeCut={(clipboardData) => {
- *     // clipboardData.getData() -> [[1, 2, 3], [4, 5, 6]]
- *    clipboardData.removeRows([0]);
- *    clipboardData.removeColumns([0]);
- *     // clipboardData.getData() -> [[5, 6]]
+ *   beforeCut={(data, coords) => {
+ *     // data -> [[1, 2, 3], [4, 5, 6]]
+ *     data.splice(0, 1);
+ *     // data -> [[4, 5, 6]]
+ *     // coords -> [{startRow: 0, startCol: 0, endRow: 1, endCol: 2}]
  *   }}
  * />
  * // To cancel a cutting action, just return `false`.
  * <HotTable
- *   beforeCut={(clipboardData) => {
+ *   beforeCut={(data, coords) => {
  *     return false;
  *   }}
  * />
@@ -1572,52 +1564,33 @@ const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-complete-s
  * Fired by {@link CopyPaste} plugin after data was cut out from the table. This hook is fired when
  * {@link Options#copyPaste} option is enabled.
  *
- * Note: Please keep in mind since @15.0.0 the method arguments has been changed.
- *
  * @event Hooks#afterCut
- * @param {object} clipboardData Information about already performed cut action.
- * @param {Function} clipboardData.removeRow Remove row from the copied dataset.
- * @param {Function} clipboardData.removeColumn Remove column from the copied dataset.
- * @param {Function} clipboardData.insertAtRow Insert values at row index.
- * @param {Function} clipboardData.insertAtColumn Insert values at column index.
- * @param {Function} clipboardData.setCellAt Change headers or cells in the copied dataset.
- * @param {Function} clipboardData.getCellAt Get headers or cells from the copied dataset.
- * @param {Function} clipboardData.getData Gets copied data stored as array of arrays.
- * @param {Function} clipboardData.getMetaInfo Gets meta information for the copied data.
- * @param {Function} clipboardData.setMetaInfo Sets meta information for the copied data.
- * @param {Function} clipboardData.getRanges Returns ranges related to copied part of Handsontable.
+ * @param {Array[]} data An array of arrays with the cut data.
+ * @param {object[]} coords An array of objects with ranges of the visual indexes (`startRow`, `startCol`, `endRow`, `endCol`)
+ *                       which was cut out.
  */
 'afterCut',
 /**
  * Fired before values are copied to the clipboard.
  *
- * Note: Please keep in mind since @15.0.0 the method arguments has been changed.
- *
  * @event Hooks#beforeCopy
- * @param {object} clipboardData Information about copy action which is going to happen.
- * @param {Function} clipboardData.removeRow Remove row from the copied dataset.
- * @param {Function} clipboardData.removeColumn Remove column from the copied dataset.
- * @param {Function} clipboardData.insertAtRow Insert values at row index.
- * @param {Function} clipboardData.insertAtColumn Insert values at column index.
- * @param {Function} clipboardData.setCellAt Change headers or cells in the copied dataset.
- * @param {Function} clipboardData.getCellAt Get headers or cells from the copied dataset.
- * @param {Function} clipboardData.getData Gets copied data stored as array of arrays.
- * @param {Function} clipboardData.getMetaInfo Gets meta information for the copied data.
- * @param {Function} clipboardData.setMetaInfo Sets meta information for the copied data.
- * @param {Function} clipboardData.getRanges Returns ranges related to copied part of Handsontable.
+ * @param {Array[]} data An array of arrays which contains data to copied.
+ * @param {object[]} coords An array of objects with ranges of the visual indexes (`startRow`, `startCol`, `endRow`, `endCol`)
+ *                         which will copied.
+ * @param {{ columnHeadersCount: number }} copiedHeadersCount (Since 12.3.0) The number of copied column headers.
  * @returns {*} If returns `false` then copying is canceled.
  *
  * @example
  * ::: only-for javascript
  * ```js
- * // To disregard a single row or column, remove it from copied dataset using `removeRows`/`removeColumns` method on the object from the first callback argument.
+ * // To disregard a single row, remove it from array using data.splice(i, 1).
  * ...
  * new Handsontable(document.getElementById('example'), {
- *   beforeCopy: (clipboardData) => {
- *     // clipboardData.getData() -> [[1, 2, 3], [4, 5, 6]]
- *    clipboardData.removeRows([0]);
- *    clipboardData.removeColumns([0]);
- *     // clipboardData.getData() -> [[5, 6]]
+ *   beforeCopy: (data, coords) => {
+ *     // data -> [[1, 2, 3], [4, 5, 6]]
+ *     data.splice(0, 1);
+ *     // data -> [[4, 5, 6]]
+ *     // coords -> [{startRow: 0, startCol: 0, endRow: 1, endCol: 2}]
  *   }
  * });
  * ...
@@ -1625,7 +1598,7 @@ const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-complete-s
  * // To cancel copying, return false from the callback.
  * ...
  * new Handsontable(document.getElementById('example'), {
- *   beforeCopy: (clipboardData) => {
+ *   beforeCopy: (data, coords) => {
  *     return false;
  *   }
  * });
@@ -1635,14 +1608,14 @@ const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-complete-s
  *
  * ::: only-for react
  * ```jsx
- * // To disregard a single row or column, remove it from copied dataset using `removeRows`/`removeColumns` method on the object from the first callback argument.
+ * // To disregard a single row, remove it from array using data.splice(i, 1).
  * ...
  * <HotTable
- *   beforeCopy={(clipboardData) => {
- *     // clipboardData.getData() -> [[1, 2, 3], [4, 5, 6]]
- *    clipboardData.removeRows([0]);
- *    clipboardData.removeColumns([0]);
- *     // clipboardData.getData() -> [[5, 6]]
+ *   beforeCopy={(data, coords) => {
+ *     // data -> [[1, 2, 3], [4, 5, 6]]
+ *     data.splice(0, 1);
+ *     // data -> [[4, 5, 6]]
+ *     // coords -> [{startRow: 0, startCol: 0, endRow: 1, endCol: 2}]
  *   }}
  * />
  * ...
@@ -1650,7 +1623,7 @@ const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-complete-s
  * // To cancel copying, return false from the callback.
  * ...
  * <HotTable
- *   beforeCopy={(clipboardData) => {
+ *   beforeCopy={(data, coords) => {
  *     return false;
  *   }}
  * />
@@ -1663,57 +1636,37 @@ const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-complete-s
  * Fired by {@link CopyPaste} plugin after data are pasted into table. This hook is fired when {@link Options#copyPaste}
  * option is enabled.
  *
- * Note: Please keep in mind since @15.0.0 the method arguments has been changed.
- *
  * @event Hooks#afterCopy
- * @param {object} clipboardData Information about already performed copy action.
- * @param {Function} clipboardData.removeRow Remove row from the copied dataset.
- * @param {Function} clipboardData.removeColumn Remove column from the copied dataset.
- * @param {Function} clipboardData.insertAtRow Insert values at row index.
- * @param {Function} clipboardData.insertAtColumn Insert values at column index.
- * @param {Function} clipboardData.setCellAt Change headers or cells in the copied dataset.
- * @param {Function} clipboardData.getCellAt Get headers or cells from the copied dataset.
- * @param {Function} clipboardData.getData Gets copied data stored as array of arrays.
- * @param {Function} clipboardData.getMetaInfo Gets meta information for the copied data.
- * @param {Function} clipboardData.setMetaInfo Sets meta information for the copied data.
- * @param {Function} clipboardData.getRanges Returns ranges related to copied part of Handsontable.
+ * @param {Array[]} data An array of arrays which contains the copied data.
+ * @param {object[]} coords An array of objects with ranges of the visual indexes (`startRow`, `startCol`, `endRow`, `endCol`)
+ *                         which was copied.
+ * @param {{ columnHeadersCount: number }} copiedHeadersCount (Since 12.3.0) The number of copied column headers.
  */
 'afterCopy',
 /**
  * Fired by {@link CopyPaste} plugin before values are pasted into table. This hook is fired when
  * {@link Options#copyPaste} option is enabled.
  *
- * Note: Please keep in mind since @15.0.0 the method arguments has been changed.
- *
  * @event Hooks#beforePaste
- * @param {object} clipboardData Information about paste action which is going to happen.
- * @param {Function} clipboardData.removeRow Remove row from the pasted dataset.
- * @param {Function} clipboardData.removeColumn Remove column from the pasted dataset.
- * @param {Function} clipboardData.insertAtRow Insert values at row index.
- * @param {Function} clipboardData.insertAtColumn Insert values at column index.
- * @param {Function} clipboardData.setCellAt Change headers or cells in the pasted dataset.
- * @param {Function} clipboardData.getCellAt Get headers or cells from the pasted dataset.
- * @param {Function} clipboardData.getData Gets copied data stored as array of arrays.
- * @param {Function} clipboardData.getMetaInfo Gets meta information for the copied data.
- * @param {Function} clipboardData.setMetaInfo Sets meta information for the copied data.
- * @param {Function} clipboardData.getSource Gets information about source of the copied data
- * (Handsontable, table or string).
+ * @param {Array[]} data An array of arrays which contains data to paste.
+ * @param {object[]} coords An array of objects with ranges of the visual indexes (`startRow`, `startCol`, `endRow`, `endCol`)
+ *                       that correspond to the previously selected area.
  * @returns {*} If returns `false` then pasting is canceled.
  * @example
  * ```js
  * ::: only-for javascript
- * // To disregard a single row or column, remove it from copied dataset using `removeRows`/`removeColumns` method on the object from the first callback argument.
+ * // To disregard a single row, remove it from array using data.splice(i, 1).
  * new Handsontable(example, {
- *   beforePaste: (clipboardData) => {
- *     // clipboardData.getData() -> [[1, 2, 3], [4, 5, 6]]
- *    clipboardData.removeRows([0]);
- *    clipboardData.removeColumns([0]);
- *     // clipboardData.getData() -> [[5, 6]]
+ *   beforePaste: (data, coords) => {
+ *     // data -> [[1, 2, 3], [4, 5, 6]]
+ *     data.splice(0, 1);
+ *     // data -> [[4, 5, 6]]
+ *     // coords -> [{startRow: 0, startCol: 0, endRow: 1, endCol: 2}]
  *   }
  * });
  * // To cancel pasting, return false from the callback.
  * new Handsontable(example, {
- *   beforePaste: (clipboardData) => {
+ *   beforePaste: (data, coords) => {
  *     return false;
  *   }
  * });
@@ -1722,18 +1675,18 @@ const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-complete-s
  *
  * ::: only-for react
  * ```jsx
- * // To disregard a single row or column, remove it from copied dataset using `removeRows`/`removeColumns` method on the object from the first callback argument.
+ * // To disregard a single row, remove it from array using data.splice(i, 1).
  * <HotTable
- *   beforePaste={(clipboardData) => {
- *     // clipboardData.getData() -> [[1, 2, 3], [4, 5, 6]]
- *    clipboardData.removeRows([0]);
- *    clipboardData.removeColumns([0]);
- *     // clipboardData.getData() -> [[5, 6]]
+ *   beforePaste={(data, coords) => {
+ *     // data -> [[1, 2, 3], [4, 5, 6]]
+ *     data.splice(0, 1);
+ *     // data -> [[4, 5, 6]]
+ *     // coords -> [{startRow: 0, startCol: 0, endRow: 1, endCol: 2}]
  *   }}
  * />
  * // To cancel pasting, return false from the callback.
  * <HotTable
- *   beforePaste={(clipboardData) => {
+ *   beforePaste={(data, coords) => {
  *     return false;
  *   }}
  * />
@@ -1745,21 +1698,10 @@ const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-complete-s
  * Fired by {@link CopyPaste} plugin after values are pasted into table. This hook is fired when
  * {@link Options#copyPaste} option is enabled.
  *
- * Note: Please keep in mind since @15.0.0 the method arguments has been changed.
- *
  * @event Hooks#afterPaste
- * @param {object} clipboardData Information about already performed paste action.
- * @param {Function} clipboardData.removeRow Remove row from the pasted dataset.
- * @param {Function} clipboardData.removeColumn Remove column from the pasted dataset.
- * @param {Function} clipboardData.insertAtRow Insert values at row index.
- * @param {Function} clipboardData.insertAtColumn Insert values at column index.
- * @param {Function} clipboardData.setCellAt Change headers or cells in the pasted dataset.
- * @param {Function} clipboardData.getCellAt Get headers or cells from the pasted dataset.
- * @param {Function} clipboardData.getData Gets copied data stored as array of arrays.
- * @param {Function} clipboardData.getMetaInfo Gets meta information for the copied data.
- * @param {Function} clipboardData.setMetaInfo Sets meta information for the copied data.
- * @param {Function} clipboardData.getSource Gets information about source of the copied data
- * (Handsontable, table or string).
+ * @param {Array[]} data An array of arrays with the pasted data.
+ * @param {object[]} coords An array of objects with ranges of the visual indexes (`startRow`, `startCol`, `endRow`, `endCol`)
+ *                       that correspond to the previously selected area.
  */
 'afterPaste',
 /**