handsontable 12.1.3 → 12.3.0-next-bb1a7c2-20221208

package/pluginHooks.mjs

@@ -1,14 +1,18 @@
+function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
 import "core-js/modules/es.array.slice.js";
 import "core-js/modules/es.object.freeze.js";
-
+import "core-js/modules/es.symbol.to-primitive.js";
+import "core-js/modules/es.date.to-primitive.js";
+import "core-js/modules/es.symbol.js";
+import "core-js/modules/es.symbol.description.js";
+import "core-js/modules/es.number.constructor.js";
+import "core-js/modules/es.symbol.iterator.js";
 var _templateObject;
-
 function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
-
-function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
-
+function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, _toPropertyKey(descriptor.key), descriptor); } }
 function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
-
+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); }
 import "core-js/modules/es.array.iterator.js";
 import "core-js/modules/es.map.js";
 import "core-js/modules/es.object.to-string.js";
@@ -16,23 +20,32 @@ import "core-js/modules/es.string.iterator.js";
 import "core-js/modules/web.dom-collections.iterator.js";
 import "core-js/modules/es.array.index-of.js";
 import "core-js/modules/es.array.splice.js";
-
 function _taggedTemplateLiteral(strings, raw) { if (!raw) { raw = strings.slice(0); } return Object.freeze(Object.defineProperties(strings, { raw: { value: Object.freeze(raw) } })); }
-
 import { arrayEach } from "./helpers/array.mjs";
 import { objectEach } from "./helpers/object.mjs";
 import { substitute } from "./helpers/string.mjs";
 import { warn } from "./helpers/console.mjs";
 import { toSingleLine } from "./helpers/templateLiteralTag.mjs";
 import { fastCall } from "./helpers/function.mjs";
+/* eslint-disable jsdoc/require-description-complete-sentence */
 /**
  * @description
+ *
+ * ::: only-for javascript
  * Handsontable events are the common interface that function in 2 ways: as __callbacks__ and as __hooks__.
+ * :::
+ *
+ * ::: only-for react
+ * This page lists all the **Handsontable hooks** – callbacks that let you react before or after an action occurs.
+ *
+ * Read more on the [Events and hooks](@/guides/getting-started/events-and-hooks.md) page.
+ * :::
  *
  * @example
  *
+ * ::: only-for javascript
  * ```js
- * // Using events as callbacks:
+ * // using events as callbacks
  * ...
  * const hot1 = new Handsontable(document.getElementById('example1'), {
  *   afterChange: function(changes, source) {
@@ -44,9 +57,27 @@ import { fastCall } from "./helpers/function.mjs";
  * });
  * ...
  * ```
+ * :::
+ *
+ * ::: only-for react
+ * ```jsx
+ * <HotTable
+ *   afterChange={(changes, source) => {
+ *     fetch('save.php', {
+ *       method: 'POST',
+ *       headers: {
+ *         'Accept': 'application/json',
+ *         'Content-Type': 'application/json'
+ *       },
+ *       body: JSON.stringify(changes)
+ *     });
+ *   }}
+ * />
+ * :::
  *
+ * ::: only-for javascript
  * ```js
- * // Using events as plugin hooks:
+ * // using events as plugin hooks
  * ...
  * const hot1 = new Handsontable(document.getElementById('example1'), {
  *   myPlugin: true
@@ -69,13 +100,46 @@ import { fastCall } from "./helpers/function.mjs";
  *   // function body - will only run in #example2
  * });
  * ```
+ * :::
+ *
+ * ::: only-for react
+ * ```jsx
+ * const hotRef1 = useRef(null);
+ * const hotRef2 = useRef(null);
+ *
+ * // Using events as plugin hooks:
+ * ...
+ *
+ * <HotTable
+ *   ref={hotRef1}
+ *   myPlugin={true}
+ * });
+ *
+ * <HotTable
+ *   ref={hotRef2}
+ *   myPlugin={false}
+ * });
+ *
+ * ...
+ *
+ * const hot2 = hotRef2.current.hotInstance;
+ * // local hook (has same effect as a callback)
+ * hot2.addHook('afterChange', function() {
+ *   // function body - will only run in #example2
+ * });
+ *
+ * // global hook
+ * Handsontable.hooks.add('afterChange', function() {
+ *   // Fired twice - for hot1 and hot2
+ *   if (this.getSettings().myPlugin) {
+ *     // function body - will only run for first instance
+ *   }
+ * });
+ * :::
  * ...
  */
 // @TODO: Move plugin description hooks to plugin?
-
-var REGISTERED_HOOKS = [
-/* eslint-disable jsdoc/require-description-complete-sentence */
-
+var 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.
  *
@@ -92,15 +156,29 @@ var REGISTERED_HOOKS = [
  * @param {Array[]} changes 2D array containing information about each of the edited cells `[[row, prop, oldVal, newVal], ...]`. `row` is a visual row index.
  * @param {string} [source] String that identifies source of hook call ([list of all available sources](@/guides/getting-started/events-and-hooks.md#definition-for-source-argument)).
  * @example
+ * ::: only-for javascript
  * ```js
  * new Handsontable(element, {
  *   afterChange: (changes) => {
- *     changes.forEach(([row, prop, oldValue, newValue]) => {
+ *     changes?.forEach(([row, prop, oldValue, newValue]) => {
  *       // Some logic...
  *     });
  *   }
  * })
  * ```
+ * :::
+ *
+ * ::: only-for react
+ * ```jsx
+ * <HotTable
+ *   afterChange={(changes, source) => {
+ *     changes?.forEach(([row, prop, oldValue, newValue]) => {
+ *       // Some logic...
+ *     });
+ *   }}
+ * />
+ * ```
+ * :::
  */
 'afterChange',
 /**
@@ -183,6 +261,7 @@ var REGISTERED_HOOKS = [
  *                          ([list of all available sources](@/guides/getting-started/events-and-hooks.md#definition-for-source-argument)).
  * @returns {*} If `false` then creating columns is cancelled.
  * @example
+ * ::: only-for javascript
  * ```js
  * // Return `false` to cancel column inserting.
  * new Handsontable(element, {
@@ -191,6 +270,18 @@ var REGISTERED_HOOKS = [
  *   }
  * });
  * ```
+ * :::
+ *
+ * ::: only-for react
+ * ```jsx
+ * // Return `false` to cancel column inserting.
+ * <HotTable
+ *   beforeCreateCol={(data, coords) => {
+ *     return false;
+ *   }}
+ * />
+ * ```
+ * :::
  */
 'beforeCreateCol',
 /**
@@ -278,6 +369,10 @@ var REGISTERED_HOOKS = [
  * @event Hooks#afterGetColHeader
  * @param {number} column Visual column index.
  * @param {HTMLTableCellElement} TH Header's TH element.
+ * @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',
 /**
@@ -477,6 +572,7 @@ var REGISTERED_HOOKS = [
  * @param {object} preventScrolling Object with `value` property where its value change will be observed.
  * @param {number} selectionLayerLevel The number which indicates what selection layer is currently modified.
  * @example
+ * ::: only-for javascript
  * ```js
  * new Handsontable(element, {
  *   afterSelection: (row, column, row2, column2, preventScrolling, selectionLayerLevel) => {
@@ -488,6 +584,21 @@ var REGISTERED_HOOKS = [
  *   }
  * })
  * ```
+ * :::
+ *
+ * ::: only-for react
+ * ```jsx
+ * <HotTable
+ *   afterSelection={(row, column, row2, column2, preventScrolling, selectionLayerLevel) => {
+ *     // If set to `false` (default): when cell selection is outside the viewport,
+ *     // Handsontable scrolls the viewport to cell selection's end corner.
+ *     // If set to `true`: when cell selection is outside the viewport,
+ *     // Handsontable doesn't scroll to cell selection's end corner.
+ *     preventScrolling.value = true;
+ *   }}
+ * />
+ * ```
+ * :::
  */
 'afterSelection',
 /**
@@ -504,6 +615,7 @@ var REGISTERED_HOOKS = [
  * @param {number} selectionLayerLevel The number which indicates what selection layer is currently modified.
  * @example
  * ```js
+ * ::: only-for javascript
  * new Handsontable(element, {
  *   afterSelectionByProp: (row, column, row2, column2, preventScrolling, selectionLayerLevel) => {
  *     // setting if prevent scrolling after selection
@@ -511,6 +623,18 @@ var REGISTERED_HOOKS = [
  *   }
  * })
  * ```
+ * :::
+ *
+ * ::: only-for react
+ * ```jsx
+ * <HotTable
+ *   afterSelectionByProp={(row, column, row2, column2, preventScrolling, selectionLayerLevel) => {
+ *     // setting if prevent scrolling after selection
+ *     preventScrolling.value = true;
+ *   }}
+ * />
+ * ```
+ * :::
  */
 'afterSelectionByProp',
 /**
@@ -672,8 +796,11 @@ var REGISTERED_HOOKS = [
  */
 'beforeCellAlignment',
 /**
- * Fired before one or more cells is changed. Its main purpose is to alter changes silently after input and before
- * table rendering.
+ * Fired before one or more cells are changed.
+ *
+ * Use this hook to silently alter the user's changes before Handsontable re-renders.
+ *
+ * To ignore the user's changes, use a nullified array or return `false`.
  *
  * @event Hooks#beforeChange
  * @param {Array[]} changes 2D array containing information about each of the edited cells `[[row, prop, oldVal, newVal], ...]`. `row` is a visual row index.
@@ -681,22 +808,27 @@ var REGISTERED_HOOKS = [
  *                          ([list of all available sources](@/guides/getting-started/events-and-hooks.md#definition-for-source-argument)).
  * @returns {undefined | boolean} If `false` all changes were cancelled, `true` otherwise.
  * @example
+ * ::: only-for javascript
  * ```js
- * // To disregard a single change, set changes[i] to null or remove it from array using changes.splice(i, 1).
+ * // to alter a single change, overwrite the value with `changes[i][3]`
  * new Handsontable(element, {
  *   beforeChange: (changes, source) => {
  *     // [[row, prop, oldVal, newVal], ...]
- *     changes[0] = null;
+ *     changes[0][3] = 10;
  *   }
  * });
- * // To alter a single change, overwrite the desired value to changes[i][3].
+ *
+ * // to ignore a single change, set `changes[i]` to `null`
+ * // or remove `changes[i]` from the array, by using `changes.splice(i, 1)`
  * new Handsontable(element, {
  *   beforeChange: (changes, source) => {
  *     // [[row, prop, oldVal, newVal], ...]
- *     changes[0][3] = 10;
+ *     changes[0] = null;
  *   }
  * });
- * // To cancel all edit, return false from the callback or set array length to 0 (changes.length = 0).
+ *
+ * // to ignore all changes, return `false`
+ * // or set the array's length to 0, by using `changes.length = 0`
  * new Handsontable(element, {
  *   beforeChange: (changes, source) => {
  *     // [[row, prop, oldVal, newVal], ...]
@@ -704,6 +836,37 @@ var REGISTERED_HOOKS = [
  *   }
  * });
  * ```
+ * :::
+ *
+ * ::: only-for react
+ * ```jsx
+ * // to alter a single change, overwrite the desired value with `changes[i][3]`
+ * <HotTable
+ *   beforeChange={(changes, source) => {
+ *     // [[row, prop, oldVal, newVal], ...]
+ *     changes[0][3] = 10;
+ *   }}
+ * />
+ *
+ * // to ignore a single change, set `changes[i]` to `null`
+ * // or remove `changes[i]` from the array, by using changes.splice(i, 1).
+ * <HotTable
+ *   beforeChange={(changes, source) => {
+ *     // [[row, prop, oldVal, newVal], ...]
+ *     changes[0] = null;
+ *   }}
+ * />
+ *
+ * // to ignore all changes, return `false`
+ * // or set the array's length to 0 (`changes.length = 0`)
+ * <HotTable
+ *   beforeChange={(changes, source) => {
+ *     // [[row, prop, oldVal, newVal], ...]
+ *     return false;
+ *   }}
+ * />
+ * ```
+ * :::
  */
 'beforeChange',
 /**
@@ -1160,7 +1323,7 @@ var REGISTERED_HOOKS = [
  */
 '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
@@ -1169,6 +1332,7 @@ var REGISTERED_HOOKS = [
  *                       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, remove it from the array using data.splice(i, 1).
  * new Handsontable(element, {
@@ -1186,6 +1350,27 @@ var REGISTERED_HOOKS = [
  *   }
  * });
  * ```
+ * :::
+ *
+ * ::: only-for react
+ * ```jsx
+ * // To disregard a single row, remove it from the array using data.splice(i, 1).
+ * <HotTable
+ *   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={(data, coords) => {
+ *     return false;
+ *   }}
+ * />
+ * ```
+ * :::
  */
 'beforeCut',
 /**
@@ -1193,21 +1378,23 @@ var REGISTERED_HOOKS = [
  * {@link Options#copyPaste} option is enabled.
  *
  * @event Hooks#afterCut
- * @param {Array[]} data An array of arrays which contains the cutted 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.
+ * 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 (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, remove it from array using data.splice(i, 1).
  * ...
@@ -1230,6 +1417,32 @@ var REGISTERED_HOOKS = [
  * });
  * ...
  * ```
+ * :::
+ *
+ * ::: only-for react
+ * ```jsx
+ * // To disregard a single row, remove it from array using data.splice(i, 1).
+ * ...
+ * <HotTable
+ *   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}]
+ *   }}
+ * />
+ * ...
+ *
+ * // To cancel copying, return false from the callback.
+ * ...
+ * <HotTable
+ *   beforeCopy={(data, coords) => {
+ *     return false;
+ *   }}
+ * />
+ * ...
+ * ```
+ * :::
  */
 'beforeCopy',
 /**
@@ -1240,6 +1453,7 @@ var REGISTERED_HOOKS = [
  * @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',
 /**
@@ -1253,6 +1467,7 @@ var REGISTERED_HOOKS = [
  * @returns {*} If returns `false` then pasting is canceled.
  * @example
  * ```js
+ * ::: only-for javascript
  * // To disregard a single row, remove it from array using data.splice(i, 1).
  * new Handsontable(example, {
  *   beforePaste: (data, coords) => {
@@ -1269,6 +1484,27 @@ var REGISTERED_HOOKS = [
  *   }
  * });
  * ```
+ * :::
+ *
+ * ::: only-for react
+ * ```jsx
+ * // To disregard a single row, remove it from array using data.splice(i, 1).
+ * <HotTable
+ *   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={(data, coords) => {
+ *     return false;
+ *   }}
+ * />
+ * ```
+ * :::
  */
 'beforePaste',
 /**
@@ -1276,7 +1512,7 @@ var REGISTERED_HOOKS = [
  * {@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.
  */
@@ -1461,13 +1697,22 @@ var REGISTERED_HOOKS = [
  */
 'beforeStretchingColumnWidth',
 /**
- * Fired by {@link Filters} plugin before applying [filtering](@/guides/columns/column-filter.md).
- * This hook is fired when {@link Options#filters} option is enabled.
+ * Fired by the [`Filters`](@/api/filters.md) plugin,
+ * before a [column filter](@/guides/columns/column-filter.md) gets applied.
+ *
+ * [`beforeFilter`](#beforefilter) takes one argument (`conditionsStack`), which is an array of objects.
+ * Each object represents one of your [column filters](@/api/filters.md#addcondition),
+ * and consists of the following properties:
+ *
+ * | Property     | Possible values                                                         | Description                                                                                                              |
+ * | ------------ | ----------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
+ * | `column`     | Number                                                                  | A visual index of the column to which the filter will be applied.                                                        |
+ * | `conditions` | Array of objects                                                        | Each object represents one condition. For details, see [`addCondition()`](@/api/filters.md#addcondition).                |
+ * | `operation`  | `'conjunction'` \| `'disjunction'` \| `'disjunctionWithExtraCondition'` | An operation to perform on your set of `conditions`. For details, see [`addCondition()`](@/api/filters.md#addcondition). |
+ *
+ * An example of the format of the `conditionsStack` argument:
  *
- * @event Hooks#beforeFilter
- * @param {object[]} conditionsStack An array of objects with added formulas.
  * ```js
- * // Example format of the conditionsStack argument:
  * [
  *   {
  *     column: 2,
@@ -1485,17 +1730,47 @@ var REGISTERED_HOOKS = [
  *   },
  * ]
  * ```
- * @returns {boolean} If hook returns `false` value then filtering won't be applied on the UI side (server-side filtering).
+ *
+ * To perform server-side filtering (i.e., to not apply filtering to Handsontable's UI),
+ * set [`beforeFilter`](#beforefilter) to return `false`:
+ *
+ * ```js
+ * new Handsontable(document.getElementById('example'), {
+ *   beforeFilter: (conditionsStack) => {
+ *     return false;
+ *   }
+ * });
+ *```
+ *
+ * Read more:
+ * - [Guides: Column filter](@/guides/columns/column-filter.md)
+ * - [Hooks: `afterFilter`](#afterfilter)
+ * - [Options: `filters`](@/api/options.md#filters)
+ * - [Plugins: `Filters`](@/api/filters.md)
+ * – [Plugin methods: `addCondition()`](@/api/filters.md#addcondition)
+ *
+ * @event Hooks#beforeFilter
+ * @param {object[]} conditionsStack An array of objects with your [column filters](@/api/filters.md#addcondition).
+ * @returns {boolean} To perform server-side filtering (i.e., to not apply filtering to Handsontable's UI), return `false`.
  */
 'beforeFilter',
 /**
- * Fired by {@link Filters} plugin after applying [filtering](@/guides/columns/column-filter.md).
- * This hook is fired when {@link Options#filters} option is enabled.
+ * Fired by the [`Filters`](@/api/filters.md) plugin,
+ * after a [column filter](@/guides/columns/column-filter.md) gets applied.
+ *
+ * [`afterFilter`](#afterfilter) takes one argument (`conditionsStack`), which is an array of objects.
+ * Each object represents one of your [column filters](@/api/filters.md#addcondition),
+ * and consists of the following properties:
+ *
+ * | Property     | Possible values                                                         | Description                                                                                                              |
+ * | ------------ | ----------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
+ * | `column`     | Number                                                                  | A visual index of the column to which the filter was applied.                                                            |
+ * | `conditions` | Array of objects                                                        | Each object represents one condition. For details, see [`addCondition()`](@/api/filters.md#addcondition).                |
+ * | `operation`  | `'conjunction'` \| `'disjunction'` \| `'disjunctionWithExtraCondition'` | An operation to perform on your set of `conditions`. For details, see [`addCondition()`](@/api/filters.md#addcondition). |
+ *
+ * An example of the format of the `conditionsStack` argument:
  *
- * @event Hooks#afterFilter
- * @param {object[]} conditionsStack An array of objects with added conditions.
  * ```js
- * // Example format of the conditionsStack argument:
  * [
  *   {
  *     column: 2,
@@ -1513,18 +1788,38 @@ var REGISTERED_HOOKS = [
  *   },
  * ]
  * ```
+ *
+ * Read more:
+ * - [Guides: Column filter](@/guides/columns/column-filter.md)
+ * - [Hooks: `beforeFilter`](#beforefilter)
+ * - [Options: `filters`](@/api/options.md#filters)
+ * - [Plugins: `Filters`](@/api/filters.md)
+ * – [Plugin methods: `addCondition()`](@/api/filters.md#addcondition)
+ *
+ * @event Hooks#afterFilter
+ * @param {object[]} conditionsStack An array of objects with your [column filters](@/api/filters.md#addcondition).
  */
 'afterFilter',
 /**
- * Called when a value is updated in the engine.
+ * Fired by the {@link Formulas} plugin, when any cell value changes.
+ *
+ * Returns an array of objects that contains:
+ * - The addresses (`sheet`, `row`, `col`) and new values (`newValue`) of the changed cells.
+ * - The addresses and new values of any cells that had to be recalculated (because their formulas depend on the cells that changed).
+ *
+ * This hook gets also fired on Handsontable's initialization, returning the addresses and values of all cells.
+ *
+ * Read more:
+ * - [Guides: Formula calculation](@/guides/formulas/formula-calculation.md)
+ * - [HyperFormula documentation: `valuesUpdated`](https://hyperformula.handsontable.com/api/interfaces/listeners.html#valuesupdated)
  *
  * @since 9.0.0
  * @event Hooks#afterFormulasValuesUpdate
- * @param {Array} changes The values and location of applied changes.
+ * @param {Array} changes The addresses and new values of all the changed and recalculated cells.
  */
 'afterFormulasValuesUpdate',
 /**
- * Called when a named expression is added to the Formulas' engine instance.
+ * Fired when a named expression is added to the Formulas' engine instance.
  *
  * @since 9.0.0
  * @event Hooks#afterNamedExpressionAdded
@@ -1533,7 +1828,7 @@ var REGISTERED_HOOKS = [
  */
 'afterNamedExpressionAdded',
 /**
- * Called when a named expression is removed from the Formulas' engine instance.
+ * Fired when a named expression is removed from the Formulas' engine instance.
  *
  * @since 9.0.0
  * @event Hooks#afterNamedExpressionRemoved
@@ -1542,7 +1837,7 @@ var REGISTERED_HOOKS = [
  */
 'afterNamedExpressionRemoved',
 /**
- * Called when a new sheet is added to the Formulas' engine instance.
+ * Fired when a new sheet is added to the Formulas' engine instance.
  *
  * @since 9.0.0
  * @event Hooks#afterSheetAdded
@@ -1550,7 +1845,7 @@ var REGISTERED_HOOKS = [
  */
 'afterSheetAdded',
 /**
- * Called when a sheet in the Formulas' engine instance is renamed.
+ * Fired when a sheet in the Formulas' engine instance is renamed.
  *
  * @since 9.0.0
  * @event Hooks#afterSheetRenamed
@@ -1559,7 +1854,7 @@ var REGISTERED_HOOKS = [
  */
 'afterSheetRenamed',
 /**
- * Called when a sheet is removed from the Formulas' engine instance.
+ * Fired when a sheet is removed from the Formulas' engine instance.
  *
  * @since 9.0.0
  * @event Hooks#afterSheetRemoved
@@ -1573,6 +1868,20 @@ var REGISTERED_HOOKS = [
  * @event Hooks#modifyColumnHeaderHeight
  */
 'modifyColumnHeaderHeight',
+/**
+ * Fired while retrieving a column header's value.
+ *
+ * @since 12.3.0
+ * @event Hooks#modifyColumnHeaderValue
+ * @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} The column header value to be updated.
+ */
+'modifyColumnHeaderValue',
 /**
  * Fired by {@link UndoRedo} plugin before the undo action. Contains information about the action that is being undone.
  * This hook is fired when {@link Options#undo} option is enabled.
@@ -1973,7 +2282,7 @@ var REGISTERED_HOOKS = [
  */
 'afterUnlisten',
 /**
- * Fired after the window was resized.
+ * Fired after the window was resized or the size of the Handsontable root element was changed.
  *
  * @event Hooks#afterRefreshDimensions
  * @param {object} previousDimensions Previous dimensions of the container.
@@ -1982,7 +2291,8 @@ var REGISTERED_HOOKS = [
  */
 'afterRefreshDimensions',
 /**
- * Cancellable hook, called after resizing a window, but before redrawing a table.
+ * Cancellable hook, called after resizing a window or after detecting size change of the
+ * Handsontable root element, but before redrawing a table.
  *
  * @event Hooks#beforeRefreshDimensions
  * @param {object} previousDimensions Previous dimensions of the container.
@@ -2045,13 +2355,14 @@ var REGISTERED_HOOKS = [
  * @param {*} cellValue Value of the cell.
  */
 'modifyAutoColumnSizeSeed'];
+
 /**
  * Template warning message for removed hooks.
  *
  * @type {string}
  */
-
 var REMOVED_MESSAGE = toSingleLine(_templateObject || (_templateObject = _taggedTemplateLiteral(["The plugin hook \"[hookName]\" was removed in Handsontable [removedInVersion]. \n  Please consult release notes https://github.com/handsontable/handsontable/releases/tag/[removedInVersion] to \n  learn about the migration path."], ["The plugin hook \"[hookName]\" was removed in Handsontable [removedInVersion].\\x20\n  Please consult release notes https://github.com/handsontable/handsontable/releases/tag/[removedInVersion] to\\x20\n  learn about the migration path."])));
+
 /**
  * The list of the hooks which are removed from the API. The warning message is printed out in
  * the developer console when the hook is used.
@@ -2061,10 +2372,9 @@ var REMOVED_MESSAGE = toSingleLine(_templateObject || (_templateObject = _tagged
  *
  * @type {Map<string, string>}
  */
-
 var REMOVED_HOOKS = new Map([['modifyRow', '8.0.0'], ['modifyCol', '8.0.0'], ['unmodifyRow', '8.0.0'], ['unmodifyCol', '8.0.0'], ['skipLengthCache', '8.0.0'], ['hiddenColumn', '8.0.0'], ['hiddenRow', '8.0.0']]);
-/* eslint-disable jsdoc/require-description-complete-sentence */
 
+/* eslint-disable jsdoc/require-description-complete-sentence */
 /**
  * The list of the hooks which are deprecated. The warning message is printed out in
  * the developer console when the hook is used.
@@ -2084,20 +2394,17 @@ var REMOVED_HOOKS = new Map([['modifyRow', '8.0.0'], ['modifyCol', '8.0.0'], ['u
  *
  * @type {Map<string, string>}
  */
-
 /* eslint-enable jsdoc/require-description-complete-sentence */
-
 var DEPRECATED_HOOKS = new Map([['beforeAutofillInsidePopulate', 'The plugin hook "beforeAutofillInsidePopulate" is deprecated and will be removed in the next major release.']]);
-
 var Hooks = /*#__PURE__*/function () {
   /**
    *
    */
   function Hooks() {
     _classCallCheck(this, Hooks);
-
     this.globalBucket = this.createEmptyBucket();
   }
+
   /**
    * Returns a new object with empty handlers related to every registered hook name.
    *
@@ -2116,40 +2423,37 @@ var Hooks = /*#__PURE__*/function () {
    * }
    * ```
    */
-
-
   _createClass(Hooks, [{
     key: "createEmptyBucket",
     value: function createEmptyBucket() {
-      var bucket = Object.create(null); // eslint-disable-next-line no-return-assign
+      var bucket = Object.create(null);
 
+      // eslint-disable-next-line no-return-assign
       arrayEach(REGISTERED_HOOKS, function (hook) {
         return bucket[hook] = [];
       });
       return bucket;
     }
+
     /**
      * Get hook bucket based on the context of the object or if argument is `undefined`, get the global hook bucket.
      *
      * @param {object} [context=null] A Handsontable instance.
      * @returns {object} Returns a global or Handsontable instance bucket.
      */
-
   }, {
     key: "getBucket",
     value: function getBucket() {
       var context = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : null;
-
       if (context) {
         if (!context.pluginHookBucket) {
           context.pluginHookBucket = this.createEmptyBucket();
         }
-
         return context.pluginHookBucket;
       }
-
       return this.globalBucket;
     }
+
     /**
      * Adds a listener (globally or locally) to a specified hook name.
      * If the `context` parameter is provided, the hook will be added only to the instance it references.
@@ -2178,14 +2482,11 @@ var Hooks = /*#__PURE__*/function () {
      * Handsontable.hooks.add('beforeInit', [myCallback, anotherCallback]);
      * ```
      */
-
   }, {
     key: "add",
     value: function add(key, callback) {
       var _this = this;
-
       var context = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : null;
-
       if (Array.isArray(callback)) {
         arrayEach(callback, function (c) {
           return _this.add(key, c, context);
@@ -2197,24 +2498,18 @@ var Hooks = /*#__PURE__*/function () {
             removedInVersion: REMOVED_HOOKS.get(key)
           }));
         }
-
         if (DEPRECATED_HOOKS.has(key)) {
           warn(DEPRECATED_HOOKS.get(key));
         }
-
         var bucket = this.getBucket(context);
-
         if (typeof bucket[key] === 'undefined') {
           this.register(key);
           bucket[key] = [];
         }
-
         callback.skip = false;
-
         if (bucket[key].indexOf(callback) === -1) {
           // only add a hook if it has not already been added (adding the same hook twice is now silently ignored)
           var foundInitialHook = false;
-
           if (callback.initialHook) {
             arrayEach(bucket[key], function (cb, i) {
               if (cb.initialHook) {
@@ -2224,15 +2519,14 @@ var Hooks = /*#__PURE__*/function () {
               }
             });
           }
-
           if (!foundInitialHook) {
             bucket[key].push(callback);
           }
         }
       }
-
       return this;
     }
+
     /**
      * Adds a listener to a specified hook. After the hook runs this listener will be automatically removed from the bucket.
      *
@@ -2246,14 +2540,11 @@ var Hooks = /*#__PURE__*/function () {
      * Handsontable.hooks.once('beforeInit', myCallback, hotInstance);
      * ```
      */
-
   }, {
     key: "once",
     value: function once(key, callback) {
       var _this2 = this;
-
       var context = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : null;
-
       if (Array.isArray(callback)) {
         arrayEach(callback, function (c) {
           return _this2.once(key, c, context);
@@ -2263,6 +2554,7 @@ var Hooks = /*#__PURE__*/function () {
         this.add(key, callback, context);
       }
     }
+
     /**
      * Removes a listener from a hook with a given name. If the `context` argument is provided, it removes a listener from a local hook assigned to the given Handsontable instance.
      *
@@ -2277,22 +2569,20 @@ var Hooks = /*#__PURE__*/function () {
      * Handsontable.hooks.remove('beforeInit', myCallback);
      * ```
      */
-
   }, {
     key: "remove",
     value: function remove(key, callback) {
       var context = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : null;
       var bucket = this.getBucket(context);
-
       if (typeof bucket[key] !== 'undefined') {
         if (bucket[key].indexOf(callback) >= 0) {
           callback.skip = true;
           return true;
         }
       }
-
       return false;
     }
+
     /**
      * Checks whether there are any registered listeners for the provided hook name.
      * If the `context` parameter is provided, it only checks for listeners assigned to the given Handsontable instance.
@@ -2301,7 +2591,6 @@ var Hooks = /*#__PURE__*/function () {
      * @param {object} [context=null] A Handsontable instance.
      * @returns {boolean} `true` for success, `false` otherwise.
      */
-
   }, {
     key: "has",
     value: function has(key) {
@@ -2309,6 +2598,7 @@ var Hooks = /*#__PURE__*/function () {
       var bucket = this.getBucket(context);
       return !!(bucket[key] !== void 0 && bucket[key].length);
     }
+
     /**
      * Runs all local and global callbacks assigned to the hook identified by the `key` parameter.
      * It returns either a return value from the last called callback or the first parameter (`p1`) passed to the `run` function.
@@ -2329,7 +2619,6 @@ var Hooks = /*#__PURE__*/function () {
      * Handsontable.hooks.run(hot, 'beforeInit');
      * ```
      */
-
   }, {
     key: "run",
     value: function run(context, key, p1, p2, p3, p4, p5, p6) {
@@ -2337,66 +2626,53 @@ var Hooks = /*#__PURE__*/function () {
         var globalHandlers = this.globalBucket[key];
         var length = globalHandlers ? globalHandlers.length : 0;
         var index = 0;
-
         if (length) {
           // Do not optimise this loop with arrayEach or arrow function! If you do You'll decrease perf because of GC.
           while (index < length) {
             if (!globalHandlers[index] || globalHandlers[index].skip) {
               index += 1;
               /* eslint-disable no-continue */
-
               continue;
             }
-
             var res = fastCall(globalHandlers[index], context, p1, p2, p3, p4, p5, p6);
-
             if (res !== void 0) {
               // eslint-disable-next-line no-param-reassign
               p1 = res;
             }
-
             if (globalHandlers[index] && globalHandlers[index].runOnce) {
               this.remove(key, globalHandlers[index]);
             }
-
             index += 1;
           }
         }
       }
       {
         var localHandlers = this.getBucket(context)[key];
-
         var _length = localHandlers ? localHandlers.length : 0;
-
         var _index = 0;
-
         if (_length) {
           // Do not optimise this loop with arrayEach or arrow function! If you do You'll decrease perf because of GC.
           while (_index < _length) {
             if (!localHandlers[_index] || localHandlers[_index].skip) {
               _index += 1;
               /* eslint-disable no-continue */
-
               continue;
             }
-
             var _res = fastCall(localHandlers[_index], context, p1, p2, p3, p4, p5, p6);
-
             if (_res !== void 0) {
               // eslint-disable-next-line no-param-reassign
               p1 = _res;
             }
-
             if (localHandlers[_index] && localHandlers[_index].runOnce) {
               this.remove(key, localHandlers[_index], context);
             }
-
             _index += 1;
           }
         }
       }
       return p1;
     }
+
     /**
      * Destroy all listeners connected to the context. If no context is provided, the global listeners will be destroyed.
      *
@@ -2410,7 +2686,6 @@ var Hooks = /*#__PURE__*/function () {
      * Handsontable.hooks.destroy(hotInstance);
      * ```
      */
-
   }, {
     key: "destroy",
     value: function destroy() {
@@ -2420,6 +2695,7 @@ var Hooks = /*#__PURE__*/function () {
         return bucket[key].length = 0;
       });
     }
+
     /**
      * Registers a hook name (adds it to the list of the known hook names). Used by plugins.
      * It is not necessary to call register, but if you use it, your plugin hook will be used returned by
@@ -2432,7 +2708,6 @@ var Hooks = /*#__PURE__*/function () {
      * Handsontable.hooks.register('myHook');
      * ```
      */
-
   }, {
     key: "register",
     value: function register(key) {
@@ -2440,6 +2715,7 @@ var Hooks = /*#__PURE__*/function () {
         REGISTERED_HOOKS.push(key);
       }
     }
+
     /**
      * Deregisters a hook name (removes it from the list of known hook names).
      *
@@ -2450,7 +2726,6 @@ var Hooks = /*#__PURE__*/function () {
      * Handsontable.hooks.deregister('myHook');
      * ```
      */
-
   }, {
     key: "deregister",
     value: function deregister(key) {
@@ -2458,6 +2733,7 @@ var Hooks = /*#__PURE__*/function () {
         REGISTERED_HOOKS.splice(REGISTERED_HOOKS.indexOf(key), 1);
       }
     }
+
     /**
      * Returns a boolean value depending on if a hook by such name has been removed or deprecated.
      *
@@ -2472,12 +2748,12 @@ var Hooks = /*#__PURE__*/function () {
      * true
      * ```
      */
-
   }, {
     key: "isDeprecated",
     value: function isDeprecated(hookName) {
       return DEPRECATED_HOOKS.has(hookName) || REMOVED_HOOKS.has(hookName);
     }
+
     /**
      * Returns a boolean depending on if a hook by such name has been registered.
      *
@@ -2491,12 +2767,12 @@ var Hooks = /*#__PURE__*/function () {
      * true
      * ```
      */
-
   }, {
     key: "isRegistered",
     value: function isRegistered(hookName) {
       return REGISTERED_HOOKS.indexOf(hookName) >= 0;
     }
+
     /**
      * Returns an array of registered hooks.
      *
@@ -2518,7 +2794,6 @@ var Hooks = /*#__PURE__*/function () {
      * ]
      * ```
      */
-
   }, {
     key: "getRegistered",
     value: function getRegistered() {
@@ -2530,17 +2805,14 @@ var Hooks = /*#__PURE__*/function () {
       return getGlobalSingleton();
     }
   }]);
-
   return Hooks;
 }();
-
 var globalSingleton = new Hooks();
+
 /**
  * @returns {Hooks}
  */
-
 function getGlobalSingleton() {
   return globalSingleton;
 }
-
 export default Hooks;