handsontable 0.0.0-next-ff10728-20250410 → 0.0.0-next-d9b3885-20250415

package/core/hooks/constants.js

@@ -49,6 +49,22 @@ exports.__esModule = true;
  * />
  * :::
  *
+ * ::: only-for angular
+ * ```ts
+ * settings = {
+ *   afterChange: (changes, source) => {
+ *     changes?.forEach(([row, prop, oldValue, newValue]) => {
+ *       // Some logic...
+ *     });
+ *   },
+ * };
+ * ```
+ *
+ * ```html
+ * <hot-table [settings]="settings" />
+ * ```
+ * :::
+ *
  * ::: only-for javascript
  * ```js
  * // using events as plugin hooks
@@ -153,6 +169,22 @@ const REGISTERED_HOOKS = exports.REGISTERED_HOOKS = [/* eslint-disable jsdoc/req
  * />
  * ```
  * :::
+ *
+ * ::: only-for angular
+ * ```ts
+ * settings = {
+ *   afterChange: (changes, source) => {
+ *     changes?.forEach(([row, prop, oldValue, newValue]) => {
+ *       // Some logic...
+ *     });
+ *   },
+ * };
+ * ```
+ *
+ * ```html
+ * <hot-table [settings]="settings"></hot-table>
+ * ```
+ * :::
  */
 'afterChange',
 /**
@@ -256,6 +288,21 @@ const REGISTERED_HOOKS = exports.REGISTERED_HOOKS = [/* eslint-disable jsdoc/req
  * />
  * ```
  * :::
+ *
+ * ::: only-for angular
+ * ```ts
+ * settings = {
+ *   beforeCreateCol: (data, coords) => {
+ *     // Return `false` to cancel column inserting.
+ *     return false;
+ *   },
+ * };
+ * ```
+ *
+ * ```html
+ * <hot-table [settings]="settings"></hot-table>
+ * ```
+ * :::
  */
 'beforeCreateCol',
 /**
@@ -336,6 +383,14 @@ const REGISTERED_HOOKS = exports.REGISTERED_HOOKS = [/* eslint-disable jsdoc/req
  * @returns {string[]|undefined} Can return an `Array` of `String`s. Each of these strings will act like class names to be removed from all the cells in the table.
  */
 'beforeRemoveCellClassNames',
+/**
+ * Hook fired after `compositionstart` event is handled.
+ *
+ * @event Hooks#beforeCompositionStart
+ * @since 15.3.0
+ * @param {Event} event A native `composition` event object.
+ */
+'beforeCompositionStart',
 /**
  * Fired after getting the cell settings.
  *
@@ -631,6 +686,31 @@ const REGISTERED_HOOKS = exports.REGISTERED_HOOKS = [/* eslint-disable jsdoc/req
  *   }}
  * />
  * ```
+ * :::
+ *
+ * ::: only-for angular
+ * ```ts
+* settings = {
+*   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;
+*   },
+* };
+* ```
+*
+* ```html
+* <hot-table [settings]="settings"></hot-table>
+* ```
  * :::
  */
 'afterSelection',
@@ -670,6 +750,28 @@ const REGISTERED_HOOKS = exports.REGISTERED_HOOKS = [/* eslint-disable jsdoc/req
  * />
  * ```
  * :::
+ *
+ * ::: only-for angular
+ * ```ts
+ * settings = {
+ *   afterSelectionByProp: (
+ *     row,
+ *     column,
+ *     row2,
+ *     column2,
+ *     preventScrolling,
+ *     selectionLayerLevel
+ *   ) => {
+ *     // Setting if prevent scrolling after selection
+ *     preventScrolling.value = true;
+ *   },
+ * };
+ * ```
+ *
+ * ```html
+ * <hot-table [settings]="settings"></hot-table>
+ * ```
+ * :::
  */
 'afterSelectionByProp',
 /**
@@ -734,6 +836,24 @@ const REGISTERED_HOOKS = exports.REGISTERED_HOOKS = [/* eslint-disable jsdoc/req
  * />
  * ```
  * :::
+ *
+ * ::: only-for angular
+ * ```ts
+ * settings = {
+ *   afterSelectionFocusSet: (row, column, preventScrolling) => {
+ *     // If set to `false` (default): when focused cell selection is outside the viewport,
+ *     // Handsontable scrolls the viewport to that cell.
+ *     // If set to `true`: when focused cell selection is outside the viewport,
+ *     // Handsontable doesn't scroll the viewport.
+ *     preventScrolling.value = true;
+ *   },
+ * };
+ * ```
+ *
+ * ```html
+ * <hot-table [settings]="settings"></hot-table>
+ * ```
+ * :::
  */
 'afterSelectionFocusSet',
 /**
@@ -768,6 +888,22 @@ const REGISTERED_HOOKS = exports.REGISTERED_HOOKS = [/* eslint-disable jsdoc/req
  * />
  * ```
  * :::
+ *
+ * ::: only-for angular
+ * ```ts
+ * settings = {
+ *   beforeSelectColumns: (from, to, highlight) => {
+ *     // Extend the column selection by one column left and one column right.
+ *     from.col = Math.max(from.col - 1, 0);
+ *     to.col = Math.min(to.col + 1, this.countCols() - 1);
+ *   },
+ * };
+ * ```
+ *
+ * ```html
+ * <hot-table [settings]="settings"></hot-table>
+ * ```
+ * :::
  */
 'beforeSelectColumns',
 /**
@@ -812,6 +948,22 @@ const REGISTERED_HOOKS = exports.REGISTERED_HOOKS = [/* eslint-disable jsdoc/req
  * />
  * ```
  * :::
+ *
+ * ::: only-for angular
+ * ```ts
+ * settings = {
+ *   beforeSelectRows: (from, to, highlight) => {
+ *     // Extend the row selection by one row up and one row down.
+ *     from.row = Math.max(from.row - 1, 0);
+ *     to.row = Math.min(to.row + 1, this.countRows() - 1);
+ *   },
+ * };
+ * ```
+ *
+ * ```html
+ * <hot-table [settings]="settings"></hot-table>
+ * ```
+ * :::
  */
 'beforeSelectRows',
 /**
@@ -1032,6 +1184,42 @@ const REGISTERED_HOOKS = exports.REGISTERED_HOOKS = [/* eslint-disable jsdoc/req
  * />
  * ```
  * :::
+ * ::: only-for angular
+ *```ts
+ * // To alter a single change, overwrite the desired value with `changes[i][3]`
+ * settings1 = {
+ *   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).
+ * settings2 = {
+ *   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`)
+ * settings3 = {
+ *   beforeChange: (changes, source) => {
+ *     // [[row, prop, oldVal, newVal], ...]
+ *     return false;
+ *   },
+ * };
+ * ```
+ *
+ * ```html
+ * <hot-table [settings]="settings1"></hot-table>
+ * <hot-table [settings]="settings2"></hot-table>
+ * <hot-table [settings]="settings3"></hot-table>
+ * ```
+ *
+ * :::
  */
 'beforeChange',
 /**
@@ -1642,6 +1830,32 @@ const REGISTERED_HOOKS = exports.REGISTERED_HOOKS = [/* eslint-disable jsdoc/req
  * />
  * ```
  * :::
+ *
+ * ::: only-for angular
+ *```ts
+ * // To disregard a single row, remove it from the array using data.splice(i, 1).
+ * settings1 = {
+ *   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`.
+ * settings2 = {
+ *   beforeCut: (data, coords) => {
+ *     return false;
+ *   },
+ * };
+ * ```
+ *
+ * ```html
+ * <hot-table [settings]="settings1"></hot-table>
+ * <hot-table [settings]="settings2"></hot-table>
+ * ```
+ * :::
  */
 'beforeCut',
 /**
@@ -1714,6 +1928,32 @@ const REGISTERED_HOOKS = exports.REGISTERED_HOOKS = [/* eslint-disable jsdoc/req
  * ...
  * ```
  * :::
+ *
+ * ::: only-for angular
+ * ```ts
+ * // To disregard a single row, remove it from the array using data.splice(i, 1).
+ * settings1 = {
+ *   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.
+ * settings2 = {
+ *   beforeCopy: (data, coords) => {
+ *     return false;
+ *   },
+ * };
+ * ```
+ *
+ * ```html
+ * <hot-table [settings]="settings1"></hot-table>
+ * <hot-table [settings]="settings2"></hot-table>
+ * ```
+ * :::
  */
 'beforeCopy',
 /**
@@ -1776,6 +2016,32 @@ const REGISTERED_HOOKS = exports.REGISTERED_HOOKS = [/* eslint-disable jsdoc/req
  * />
  * ```
  * :::
+ *
+ * ::: only-for angular
+ * ```ts
+ * // To disregard a single row, remove it from the array using data.splice(i, 1).
+ * settings1 = {
+ *   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.
+ * settings2 = {
+ *   beforePaste: (data, coords) => {
+ *     return false;
+ *   },
+ * };
+ * ```
+ *
+ * ```html
+ * <hot-table [settings]="settings1"></hot-table>
+ * <hot-table [settings]="settings2"></hot-table>
+ * ```
+ * :::
  */
 'beforePaste',
 /**

package/core/hooks/constants.mjs

@@ -46,6 +46,22 @@
  * />
  * :::
  *
+ * ::: only-for angular
+ * ```ts
+ * settings = {
+ *   afterChange: (changes, source) => {
+ *     changes?.forEach(([row, prop, oldValue, newValue]) => {
+ *       // Some logic...
+ *     });
+ *   },
+ * };
+ * ```
+ *
+ * ```html
+ * <hot-table [settings]="settings" />
+ * ```
+ * :::
+ *
  * ::: only-for javascript
  * ```js
  * // using events as plugin hooks
@@ -150,6 +166,22 @@ export const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-com
  * />
  * ```
  * :::
+ *
+ * ::: only-for angular
+ * ```ts
+ * settings = {
+ *   afterChange: (changes, source) => {
+ *     changes?.forEach(([row, prop, oldValue, newValue]) => {
+ *       // Some logic...
+ *     });
+ *   },
+ * };
+ * ```
+ *
+ * ```html
+ * <hot-table [settings]="settings"></hot-table>
+ * ```
+ * :::
  */
 'afterChange',
 /**
@@ -253,6 +285,21 @@ export const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-com
  * />
  * ```
  * :::
+ *
+ * ::: only-for angular
+ * ```ts
+ * settings = {
+ *   beforeCreateCol: (data, coords) => {
+ *     // Return `false` to cancel column inserting.
+ *     return false;
+ *   },
+ * };
+ * ```
+ *
+ * ```html
+ * <hot-table [settings]="settings"></hot-table>
+ * ```
+ * :::
  */
 'beforeCreateCol',
 /**
@@ -333,6 +380,14 @@ export const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-com
  * @returns {string[]|undefined} Can return an `Array` of `String`s. Each of these strings will act like class names to be removed from all the cells in the table.
  */
 'beforeRemoveCellClassNames',
+/**
+ * Hook fired after `compositionstart` event is handled.
+ *
+ * @event Hooks#beforeCompositionStart
+ * @since 15.3.0
+ * @param {Event} event A native `composition` event object.
+ */
+'beforeCompositionStart',
 /**
  * Fired after getting the cell settings.
  *
@@ -628,6 +683,31 @@ export const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-com
  *   }}
  * />
  * ```
+ * :::
+ *
+ * ::: only-for angular
+ * ```ts
+* settings = {
+*   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;
+*   },
+* };
+* ```
+*
+* ```html
+* <hot-table [settings]="settings"></hot-table>
+* ```
  * :::
  */
 'afterSelection',
@@ -667,6 +747,28 @@ export const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-com
  * />
  * ```
  * :::
+ *
+ * ::: only-for angular
+ * ```ts
+ * settings = {
+ *   afterSelectionByProp: (
+ *     row,
+ *     column,
+ *     row2,
+ *     column2,
+ *     preventScrolling,
+ *     selectionLayerLevel
+ *   ) => {
+ *     // Setting if prevent scrolling after selection
+ *     preventScrolling.value = true;
+ *   },
+ * };
+ * ```
+ *
+ * ```html
+ * <hot-table [settings]="settings"></hot-table>
+ * ```
+ * :::
  */
 'afterSelectionByProp',
 /**
@@ -731,6 +833,24 @@ export const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-com
  * />
  * ```
  * :::
+ *
+ * ::: only-for angular
+ * ```ts
+ * settings = {
+ *   afterSelectionFocusSet: (row, column, preventScrolling) => {
+ *     // If set to `false` (default): when focused cell selection is outside the viewport,
+ *     // Handsontable scrolls the viewport to that cell.
+ *     // If set to `true`: when focused cell selection is outside the viewport,
+ *     // Handsontable doesn't scroll the viewport.
+ *     preventScrolling.value = true;
+ *   },
+ * };
+ * ```
+ *
+ * ```html
+ * <hot-table [settings]="settings"></hot-table>
+ * ```
+ * :::
  */
 'afterSelectionFocusSet',
 /**
@@ -765,6 +885,22 @@ export const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-com
  * />
  * ```
  * :::
+ *
+ * ::: only-for angular
+ * ```ts
+ * settings = {
+ *   beforeSelectColumns: (from, to, highlight) => {
+ *     // Extend the column selection by one column left and one column right.
+ *     from.col = Math.max(from.col - 1, 0);
+ *     to.col = Math.min(to.col + 1, this.countCols() - 1);
+ *   },
+ * };
+ * ```
+ *
+ * ```html
+ * <hot-table [settings]="settings"></hot-table>
+ * ```
+ * :::
  */
 'beforeSelectColumns',
 /**
@@ -809,6 +945,22 @@ export const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-com
  * />
  * ```
  * :::
+ *
+ * ::: only-for angular
+ * ```ts
+ * settings = {
+ *   beforeSelectRows: (from, to, highlight) => {
+ *     // Extend the row selection by one row up and one row down.
+ *     from.row = Math.max(from.row - 1, 0);
+ *     to.row = Math.min(to.row + 1, this.countRows() - 1);
+ *   },
+ * };
+ * ```
+ *
+ * ```html
+ * <hot-table [settings]="settings"></hot-table>
+ * ```
+ * :::
  */
 'beforeSelectRows',
 /**
@@ -1029,6 +1181,42 @@ export const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-com
  * />
  * ```
  * :::
+ * ::: only-for angular
+ *```ts
+ * // To alter a single change, overwrite the desired value with `changes[i][3]`
+ * settings1 = {
+ *   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).
+ * settings2 = {
+ *   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`)
+ * settings3 = {
+ *   beforeChange: (changes, source) => {
+ *     // [[row, prop, oldVal, newVal], ...]
+ *     return false;
+ *   },
+ * };
+ * ```
+ *
+ * ```html
+ * <hot-table [settings]="settings1"></hot-table>
+ * <hot-table [settings]="settings2"></hot-table>
+ * <hot-table [settings]="settings3"></hot-table>
+ * ```
+ *
+ * :::
  */
 'beforeChange',
 /**
@@ -1639,6 +1827,32 @@ export const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-com
  * />
  * ```
  * :::
+ *
+ * ::: only-for angular
+ *```ts
+ * // To disregard a single row, remove it from the array using data.splice(i, 1).
+ * settings1 = {
+ *   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`.
+ * settings2 = {
+ *   beforeCut: (data, coords) => {
+ *     return false;
+ *   },
+ * };
+ * ```
+ *
+ * ```html
+ * <hot-table [settings]="settings1"></hot-table>
+ * <hot-table [settings]="settings2"></hot-table>
+ * ```
+ * :::
  */
 'beforeCut',
 /**
@@ -1711,6 +1925,32 @@ export const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-com
  * ...
  * ```
  * :::
+ *
+ * ::: only-for angular
+ * ```ts
+ * // To disregard a single row, remove it from the array using data.splice(i, 1).
+ * settings1 = {
+ *   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.
+ * settings2 = {
+ *   beforeCopy: (data, coords) => {
+ *     return false;
+ *   },
+ * };
+ * ```
+ *
+ * ```html
+ * <hot-table [settings]="settings1"></hot-table>
+ * <hot-table [settings]="settings2"></hot-table>
+ * ```
+ * :::
  */
 'beforeCopy',
 /**
@@ -1773,6 +2013,32 @@ export const REGISTERED_HOOKS = [/* eslint-disable jsdoc/require-description-com
  * />
  * ```
  * :::
+ *
+ * ::: only-for angular
+ * ```ts
+ * // To disregard a single row, remove it from the array using data.splice(i, 1).
+ * settings1 = {
+ *   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.
+ * settings2 = {
+ *   beforePaste: (data, coords) => {
+ *     return false;
+ *   },
+ * };
+ * ```
+ *
+ * ```html
+ * <hot-table [settings]="settings1"></hot-table>
+ * <hot-table [settings]="settings2"></hot-table>
+ * ```
+ * :::
  */
 'beforePaste',
 /**

package/core/hooks/index.d.ts

@@ -167,6 +167,7 @@ export interface Events {
   beforeColumnSort?: (currentSortConfig: ColumnSortingConfig[], destinationSortConfigs: ColumnSortingConfig[]) => void | boolean;
   beforeColumnWrap?: (isActionInterrupted: { value: boolean }, newCoords: CellCoords, isColumnFlipped: boolean) => void;
   beforeColumnUnfreeze?: (columnIndex: number, isUnfreezingPerformed: boolean) => void | boolean;
+  beforeCompositionStart?: (event: CompositionEvent) => void;
   beforeContextMenuSetItems?: (menuItems: ContextMenuMenuItemConfig[]) => void;
   beforeContextMenuShow?: (context: ContextMenu) => void;
   beforeCopy?: (data: CellValue[][], coords: RangeType[], copiedHeadersCount: { columnHeadersCount: number }) => void | boolean;

package/core.d.ts

@@ -140,7 +140,6 @@ export default class Core {
   removeCellMeta(row: number, column: number, key: (keyof CellMeta) | string): void;
   removeHook<K extends keyof Events>(key: K, callback: Events[K]): void;
   render(): void;
-  renderCall: boolean;
   resumeExecution(): void;
   resumeRender(): void;
   rootDocument: Document;