handsontable 0.0.0-next-1b1acbd-20221123 → 0.0.0-next-561a94b-20221129

package/helpers/mixed.js

@@ -152,7 +152,7 @@ var domMessages = {
 function _injectProductInfo(key, element) {
   var hasValidType = !isEmpty(key);
   var isNonCommercial = typeof key === 'string' && key.toLowerCase() === 'non-commercial-and-evaluation';
-  var hotVersion = "0.0.0-next-1b1acbd-20221123";
+  var hotVersion = "0.0.0-next-561a94b-20221129";
   var keyValidityDate;
   var consoleMessageState = 'invalid';
   var domMessageState = 'invalid';

package/helpers/mixed.mjs

@@ -142,7 +142,7 @@ var domMessages = {
 export function _injectProductInfo(key, element) {
   var hasValidType = !isEmpty(key);
   var isNonCommercial = typeof key === 'string' && key.toLowerCase() === 'non-commercial-and-evaluation';
-  var hotVersion = "0.0.0-next-1b1acbd-20221123";
+  var hotVersion = "0.0.0-next-561a94b-20221129";
   var keyValidityDate;
   var consoleMessageState = 'invalid';
   var domMessageState = 'invalid';

package/package.json

@@ -10,7 +10,7 @@
     "url": "https://github.com/handsontable/handsontable/issues"
   },
   "author": "Handsoncode <hello@handsontable.com>",
-  "version": "0.0.0-next-1b1acbd-20221123",
+  "version": "0.0.0-next-561a94b-20221129",
   "main": "index",
   "module": "index.mjs",
   "jsnext:main": "index.mjs",

package/pluginHooks.js

@@ -362,14 +362,12 @@ var REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-complete-sen
 /**
  * Fired after retrieving information about a column header and appending it to the table header.
  *
- * Since the 12.2 the hook is triggered with the 3rd `headerLevel` argument.
- *
  * @event Hooks#afterGetColHeader
  * @param {number} column Visual column index.
  * @param {HTMLTableCellElement} TH Header's TH element.
- * @param {number} [headerLevel=0] The index of header level. The header level accepts positive (0 to N)
- *                                 and negative (-1 to -N) values. For positive values, 0 points to the
- *                                 top most header, and for negative direction, -1 points to the most bottom
+ * @param {number} [headerLevel=0] (Since 12.2.0) Header level index. Accepts positive (0 to n)
+ *                                 and negative (-1 to -n) values. For positive values, 0 points to the
+ *                                 topmost header. For negative values, -1 points to the bottom-most
  *                                 header (the header closest to the cells).
  */
 'afterGetColHeader',
@@ -1321,7 +1319,7 @@ var REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-complete-sen
  */
 'modifyCopyableRange',
 /**
- * Fired by {@link CopyPaste} plugin before copying the values into clipboard and before clearing values of
+ * 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.
  *
  * @event Hooks#beforeCut
@@ -1376,22 +1374,19 @@ var REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-complete-sen
  * {@link Options#copyPaste} option is enabled.
  *
  * @event Hooks#afterCut
- * @param {Array[]} data An array of arrays which contains the cut out data.
+ * @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 into clipboard.
- *
- * Since the 12.3.0 the hook is triggered with the 3rd `copiedHeadersCount` argument.
+ * Fired before values are copied to the clipboard.
  *
  * @event Hooks#beforeCopy
  * @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 An object with keys that holds information with
- *                                                            the number of copied headers.
+ * @param {{ columnHeadersCount: number }} copiedHeadersCount (Since 12.3.0) The number of copied column headers.
  * @returns {*} If returns `false` then copying is canceled.
  *
  * @example
@@ -1454,6 +1449,7 @@ var REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-complete-sen
  * @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',
 /**
@@ -1512,7 +1508,7 @@ var REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-complete-sen
  * {@link Options#copyPaste} option is enabled.
  *
  * @event Hooks#afterPaste
- * @param {Array[]} data An array of arrays which contains the pasted data.
+ * @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.
  */
@@ -1820,17 +1816,17 @@ var REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-complete-sen
  */
 'modifyColumnHeaderHeight',
 /**
- * Fired while retrieving the column header value.
+ * Fired while retrieving a column header's value.
  *
  * @since 12.3.0
  * @event Hooks#modifyColumnHeaderValue
- * @param {string} value The column header value.
- * @param {number} visualColumnIndex The visual column index.
- * @param {number} [headerLevel=0] The index of header level. The header level accepts positive (0 to N)
- *                                 and negative (-1 to -N) values. For positive values, 0 points to the
- *                                 top most header, and for negative direction, -1 points to the most bottom
+ * @param {string} value A column header value.
+ * @param {number} visualColumnIndex A visual column index.
+ * @param {number} [headerLevel=0] Header level index. Accepts positive (0 to n)
+ *                                 and negative (-1 to -n) values. For positive values, 0 points to the
+ *                                 topmost header. For negative values, -1 points to the bottom-most
  *                                 header (the header closest to the cells).
- * @returns {string} Returns the column header value to update.
+ * @returns {string} The column header value to be updated.
  */
 'modifyColumnHeaderValue',
 /**

package/pluginHooks.mjs

@@ -357,14 +357,12 @@ var REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-complete-sen
 /**
  * Fired after retrieving information about a column header and appending it to the table header.
  *
- * Since the 12.2 the hook is triggered with the 3rd `headerLevel` argument.
- *
  * @event Hooks#afterGetColHeader
  * @param {number} column Visual column index.
  * @param {HTMLTableCellElement} TH Header's TH element.
- * @param {number} [headerLevel=0] The index of header level. The header level accepts positive (0 to N)
- *                                 and negative (-1 to -N) values. For positive values, 0 points to the
- *                                 top most header, and for negative direction, -1 points to the most bottom
+ * @param {number} [headerLevel=0] (Since 12.2.0) Header level index. Accepts positive (0 to n)
+ *                                 and negative (-1 to -n) values. For positive values, 0 points to the
+ *                                 topmost header. For negative values, -1 points to the bottom-most
  *                                 header (the header closest to the cells).
  */
 'afterGetColHeader',
@@ -1316,7 +1314,7 @@ var REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-complete-sen
  */
 'modifyCopyableRange',
 /**
- * Fired by {@link CopyPaste} plugin before copying the values into clipboard and before clearing values of
+ * 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.
  *
  * @event Hooks#beforeCut
@@ -1371,22 +1369,19 @@ var REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-complete-sen
  * {@link Options#copyPaste} option is enabled.
  *
  * @event Hooks#afterCut
- * @param {Array[]} data An array of arrays which contains the cut out data.
+ * @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 into clipboard.
- *
- * Since the 12.3.0 the hook is triggered with the 3rd `copiedHeadersCount` argument.
+ * Fired before values are copied to the clipboard.
  *
  * @event Hooks#beforeCopy
  * @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 An object with keys that holds information with
- *                                                            the number of copied headers.
+ * @param {{ columnHeadersCount: number }} copiedHeadersCount (Since 12.3.0) The number of copied column headers.
  * @returns {*} If returns `false` then copying is canceled.
  *
  * @example
@@ -1449,6 +1444,7 @@ var REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-complete-sen
  * @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',
 /**
@@ -1507,7 +1503,7 @@ var REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-complete-sen
  * {@link Options#copyPaste} option is enabled.
  *
  * @event Hooks#afterPaste
- * @param {Array[]} data An array of arrays which contains the pasted data.
+ * @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.
  */
@@ -1815,17 +1811,17 @@ var REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-complete-sen
  */
 'modifyColumnHeaderHeight',
 /**
- * Fired while retrieving the column header value.
+ * Fired while retrieving a column header's value.
  *
  * @since 12.3.0
  * @event Hooks#modifyColumnHeaderValue
- * @param {string} value The column header value.
- * @param {number} visualColumnIndex The visual column index.
- * @param {number} [headerLevel=0] The index of header level. The header level accepts positive (0 to N)
- *                                 and negative (-1 to -N) values. For positive values, 0 points to the
- *                                 top most header, and for negative direction, -1 points to the most bottom
+ * @param {string} value A column header value.
+ * @param {number} visualColumnIndex A visual column index.
+ * @param {number} [headerLevel=0] Header level index. Accepts positive (0 to n)
+ *                                 and negative (-1 to -n) values. For positive values, 0 points to the
+ *                                 topmost header. For negative values, -1 points to the bottom-most
  *                                 header (the header closest to the cells).
- * @returns {string} Returns the column header value to update.
+ * @returns {string} The column header value to be updated.
  */
 'modifyColumnHeaderValue',
 /**

package/plugins/contextMenu/contextMenu.js

@@ -58,22 +58,7 @@ _pluginHooks.default.getSingleton().register('afterContextMenuExecute');
  * * `true` (to enable default options),
  * * `false` (to disable completely)
  * * `{ uiContainer: containerDomElement }` (to declare a container for all of the Context Menu's dom elements to be placed in).
- *
- * or array of any available strings:
- * * `'row_above'`
- * * `'row_below'`
- * * `'col_left'`
- * * `'col_right'`
- * * `'remove_row'`
- * * `'remove_col'`
- * * `'undo'`
- * * `'redo'`
- * * `'make_read_only'`
- * * `'alignment'`
- * * `'---------'` (menu item separator)
- * * `'borders'` (with {@link Options#customBorders} turned on)
- * * `'commentsAddEdit'` (with {@link Options#comments} turned on)
- * * `'commentsRemove'` (with {@link Options#comments} turned on).
+ * * An array of [the available strings](@/guides/accessories-and-menus/context-menu.md#context-menu-with-specific-options)
  *
  * See [the context menu demo](@/guides/accessories-and-menus/context-menu.md) for examples.
  *

package/plugins/contextMenu/contextMenu.mjs

@@ -51,22 +51,7 @@ Hooks.getSingleton().register('afterContextMenuExecute');
  * * `true` (to enable default options),
  * * `false` (to disable completely)
  * * `{ uiContainer: containerDomElement }` (to declare a container for all of the Context Menu's dom elements to be placed in).
- *
- * or array of any available strings:
- * * `'row_above'`
- * * `'row_below'`
- * * `'col_left'`
- * * `'col_right'`
- * * `'remove_row'`
- * * `'remove_col'`
- * * `'undo'`
- * * `'redo'`
- * * `'make_read_only'`
- * * `'alignment'`
- * * `'---------'` (menu item separator)
- * * `'borders'` (with {@link Options#customBorders} turned on)
- * * `'commentsAddEdit'` (with {@link Options#comments} turned on)
- * * `'commentsRemove'` (with {@link Options#comments} turned on).
+ * * An array of [the available strings](@/guides/accessories-and-menus/context-menu.md#context-menu-with-specific-options)
  *
  * See [the context menu demo](@/guides/accessories-and-menus/context-menu.md) for examples.
  *

package/plugins/copyPaste/copyPaste.js

@@ -88,28 +88,25 @@ var META_HEAD = ['<meta name="generator" content="Handsontable"/>', '<style type
 /* eslint-disable jsdoc/require-description-complete-sentence */
 /**
  * @description
- * This plugin enables the copy/paste functionality in the Handsontable. The functionality works for API, Context Menu,
- * using keyboard shortcuts and menu bar from the browser.
- * Possible values:
- * * `true` (to enable default options),
- * * `false` (to disable completely).
+ * Copy, cut, and paste data by using the `CopyPaste` plugin.
  *
- * or an object with values:
- * * `'columnsLimit'` (see {@link CopyPaste#columnsLimit})
- * * `'rowsLimit'` (see {@link CopyPaste#rowsLimit})
- * * `'pasteMode'` (see {@link CopyPaste#pasteMode})
- * * `'copyColumnHeaders'`
- * * `'copyColumnGroupHeaders'`
- * * `'copyColumnHeadersOnly'`
- * * `'uiContainer'` (see {@link CopyPaste#uiContainer}).
+ * Control the `CopyPaste` plugin programmatically through its [API methods](#methods).
  *
- * See [the copy/paste demo](@/guides/cell-features/clipboard.md) for examples.
+ * The user can access the copy-paste features through:
+ * - The [context menu](@/guides/cell-features/clipboard.md#context-menu).
+ * - The [keyboard shortcuts](@/guides/cell-features/clipboard.md#related-keyboard-shortcuts).
+ * - The browser's menu bar.
+ *
+ * Read more:
+ * - [Guides: Clipboard](@/guides/cell-features/clipboard.md)
+ * - [Configuration options: `copyPaste`](@/api/options.md#copypaste)
  *
  * @example
  * ```js
- * // Enables the plugin with default values
+ * // enable the plugin with the default configuration
  * copyPaste: true,
- * // Enables the plugin with custom values
+ *
+ * // or, enable the plugin with a custom configuration
  * copyPaste: {
  *   columnsLimit: 25,
  *   rowsLimit: 50,
@@ -198,8 +195,10 @@ var CopyPaste = /*#__PURE__*/function (_BasePlugin) {
     key: "isEnabled",
     value:
     /**
-     * Checks if the plugin is enabled in the handsontable settings. This method is executed in {@link Hooks#beforeInit}
-     * hook and if it returns `true` then the {@link CopyPaste#enablePlugin} method is called.
+     * Checks if the [`CopyPaste`](#copypaste) plugin is enabled.
+     *
+     * This method gets called by Handsontable's [`beforeInit`](@/api/hooks.md#beforeinit) hook.
+     * If it returns `true`, the [`enablePlugin()`](#enableplugin) method gets called.
      *
      * @returns {boolean}
      */
@@ -208,7 +207,7 @@ var CopyPaste = /*#__PURE__*/function (_BasePlugin) {
     }
 
     /**
-     * Enables the plugin functionality for this Handsontable instance.
+     * Enables the [`CopyPaste`](#copypaste) plugin for your Handsontable instance.
      */
   }, {
     key: "enablePlugin",
@@ -253,9 +252,10 @@ var CopyPaste = /*#__PURE__*/function (_BasePlugin) {
     }
 
     /**
-     * Updates the plugin's state.
+     * Updates the state of the [`CopyPaste`](#copypaste) plugin.
      *
-     * This method is executed when [`updateSettings()`](@/api/core.md#updatesettings) is invoked with any of the following configuration options:
+     * Gets called when [`updateSettings()`](@/api/core.md#updatesettings)
+     * is invoked with any of the following configuration options:
      *  - [`copyPaste`](@/api/options.md#copypaste)
      *  - [`fragmentSelection`](@/api/options.md#fragmentselection)
      */
@@ -269,7 +269,7 @@ var CopyPaste = /*#__PURE__*/function (_BasePlugin) {
     }
 
     /**
-     * Disables the plugin functionality for this Handsontable instance.
+     * Disables the [`CopyPaste`](#copypaste) plugin for your Handsontable instance.
      */
   }, {
     key: "disablePlugin",
@@ -281,12 +281,18 @@ var CopyPaste = /*#__PURE__*/function (_BasePlugin) {
     }
 
     /**
-     * Copies the selected cell with or without column headers into the clipboard.
+     * Copies the contents of the selected cells (and/or their related column headers) to the system clipboard.
+     *
+     * Takes an optional parameter (`copyMode`) that defines the scope of copying:
+     *
+     * | `copyMode` value            | Description                                                     |
+     * | --------------------------- | --------------------------------------------------------------- |
+     * | `'cells-only'` (default)    | Copy the selected cells                                         |
+     * | `'with-column-headers'`     | - Copy the selected cells<br>- Copy the nearest column headers  |
+     * | `'with-all-column-headers'` | - Copy the selected cells<br>- Copy all related columns headers |
+     * | `'column-headers-only'`     | Copy the nearest column headers (without copying cells)         |
      *
-     * @param {'cells-only' | 'column-headers-only' | 'with-all-column-headers' | 'with-column-headers'} [copyMode='cells-only']
-     * Defines the data range to copy. Possible values: `cells-only` (copy selected cells only),
-     * `column-headers-only` (copy the most-bottom column headers only), `with-all-column-headers` (copy cells
-     * with all column headers levels) or `with-column-headers` (copy cells with the most-bottom column headers).
+     * @param {string} [copyMode='cells-only'] Copy mode.
      */
   }, {
     key: "copy",
@@ -300,7 +306,7 @@ var CopyPaste = /*#__PURE__*/function (_BasePlugin) {
     }
 
     /**
-     * Copies the selected cell/cells into the clipboard.
+     * Copies the contents of the selected cells.
      */
   }, {
     key: "copyCellsOnly",
@@ -308,7 +314,7 @@ var CopyPaste = /*#__PURE__*/function (_BasePlugin) {
       this.copy('cells-only');
     }
     /**
-     * Copies only the most-bottom column headers into the clipboard.
+     * Copies the contents of column headers that are nearest to the selected cells.
      */
   }, {
     key: "copyColumnHeadersOnly",
@@ -316,7 +322,7 @@ var CopyPaste = /*#__PURE__*/function (_BasePlugin) {
       this.copy('column-headers-only');
     }
     /**
-     * Copies the selected cell/cells and all column headers levels (including column group) into the clipboard.
+     * Copies the contents of the selected cells and all their related column headers.
      */
   }, {
     key: "copyWithAllColumnHeaders",
@@ -324,7 +330,7 @@ var CopyPaste = /*#__PURE__*/function (_BasePlugin) {
       this.copy('with-column-group-headers');
     }
     /**
-     * Copies the selected cell/cells and most-bottom column headers into the clipboard.
+     * Copies the contents of the selected cells and their nearest column headers.
      */
   }, {
     key: "copyWithColumnHeaders",
@@ -333,7 +339,7 @@ var CopyPaste = /*#__PURE__*/function (_BasePlugin) {
     }
 
     /**
-     * Cuts the selected cell into the clipboard.
+     * Cuts the contents of the selected cells to the system clipboard.
      */
   }, {
     key: "cut",
@@ -345,10 +351,10 @@ var CopyPaste = /*#__PURE__*/function (_BasePlugin) {
     }
 
     /**
-     * Creates copyable text related to range objects.
+     * Converts the contents of multiple ranges (`ranges`) into a single string.
      *
      * @param {Array<{startRow: number, startCol: number, endRow: number, endCol: number}>} ranges Array of objects with properties `startRow`, `endRow`, `startCol` and `endCol`.
-     * @returns {string} Returns string which will be copied into clipboard.
+     * @returns {string} A string that will be copied to the clipboard.
      */
   }, {
     key: "getRangedCopyableData",
@@ -357,10 +363,10 @@ var CopyPaste = /*#__PURE__*/function (_BasePlugin) {
     }
 
     /**
-     * Creates copyable text related to range objects.
+     * Converts the contents of multiple ranges (`ranges`) into an array of arrays.
      *
      * @param {Array<{startRow: number, startCol: number, endRow: number, endCol: number}>} ranges Array of objects with properties `startRow`, `startCol`, `endRow` and `endCol`.
-     * @returns {Array[]} Returns array of arrays which will be copied into clipboard.
+     * @returns {Array[]} An array of arrays that will be copied to the clipboard.
      */
   }, {
     key: "getRangedData",
@@ -371,12 +377,12 @@ var CopyPaste = /*#__PURE__*/function (_BasePlugin) {
         rows = _normalizeRanges.rows,
         columns = _normalizeRanges.columns;
 
-      // Concat all rows and columns data defined in ranges into one copyable string
+      // concatenate all rows and columns data defined in ranges into one copyable string
       (0, _array.arrayEach)(rows, function (row) {
         var rowSet = [];
         (0, _array.arrayEach)(columns, function (column) {
           if (row < 0) {
-            // 'row' as the second argument act here as 'headerLevel' argument
+            // `row` as the second argument acts here as the `headerLevel` argument
             rowSet.push(_this3.hot.getColHeader(column, row));
           } else {
             rowSet.push(_this3.hot.getCopyableData(row, column));
@@ -390,10 +396,10 @@ var CopyPaste = /*#__PURE__*/function (_BasePlugin) {
     /**
      * Simulates the paste action.
      *
-     * Due to security reasons, modern browsers disallow reading from the system clipboard.
+     * For security reasons, modern browsers don't allow reading from the system clipboard.
      *
-     * @param {string} pastableText Value as raw string to paste.
-     * @param {string} [pastableHtml=''] Value as HTML to paste.
+     * @param {string} pastableText The value to paste, as a raw string.
+     * @param {string} [pastableHtml=''] The value to paste, as HTML.
      */
   }, {
     key: "paste",
@@ -758,7 +764,7 @@ var CopyPaste = /*#__PURE__*/function (_BasePlugin) {
     }
 
     /**
-     * Destroys the plugin instance.
+     * Destroys the `CopyPaste` plugin instance.
      */
   }, {
     key: "destroy",
@@ -786,7 +792,7 @@ var CopyPaste = /*#__PURE__*/function (_BasePlugin) {
     }
 
     /**
-     * Maximum number of columns than can be copied to clipboard using <kbd>**Ctrl**</kbd>/<kbd>**Cmd**</kbd> + <kbd>**C**</kbd>.
+     * The maximum number of columns than can be copied to the clipboard.
      *
      * @type {number}
      * @default Infinity