handsontable 18.0.0 → 18.1.0-rc7

package/3rdparty/walkontable/src/settings/defaults.mjs

@@ -0,0 +1,225 @@
+import { fastInnerText } from '../../../../helpers/dom/element.mjs';
+/**
+ * @todo Describe options.
+ * @typedef SettingsPure
+ *
+ * @property {Option} facade @todo desc.
+ * @property {Option} ariaTags Option `ariaTags`.
+ * @property {Option} cellRenderer Option `cellRenderer`.
+ * @property {Option} columnHeaders Option `columnHeaders`.
+ * @property {Option} columnWidth Option `columnWidth`.
+ * @property {Option} currentRowClassName Option `currentRowClassName`.
+ * @property {Option} data Option `data`.
+ * @property {Option} defaultColumnWidth Option `defaultColumnWidth`.
+ * @property {Option} externalRowCalculator Option `externalRowCalculator`.
+ * @property {Option} singlePassLayout Option `singlePassLayout`.
+ * @property {Option} fixedColumnsStart Option `fixedColumnsStart`.
+ * @property {Option} fixedRowsBottom Option `fixedRowsBottom`.
+ * @property {Option} fixedRowsTop Option `fixedRowsTop`.
+ * @property {Option} groups Option `groups`.
+ * @property {Option} hideBorderOnMouseDownOver Option `hideBorderOnMouseDownOver`.
+ * @property {Option} isRtl Option `isRtl`.
+ * @property {Option} isDataViewInstance Option `isDataViewInstance`.
+ * @property {Option} minSpareRows Option `minSpareRows`.
+ * @property {Option} onBeforeHighlightingColumnHeader Option `onBeforeHighlightingColumnHeader`.
+ * @property {Option} onBeforeHighlightingRowHeader Option `onBeforeHighlightingRowHeader`.
+ * @property {Option} onBeforeRemoveCellClassNames Option `onBeforeRemoveCellClassNames`.
+ * @property {Option} preventOverflow Option `preventOverflow`.
+ * @property {Option} preventWheel Option `preventWheel`.
+ * @property {Option} renderAllColumns Option `renderAllColumns`.
+ * @property {Option} renderAllRows Option `renderAllRows`.
+ * @property {Option} rowHeaders Option `rowHeaders`.
+ * @property {Option} rowHeightOption `rowHeight`.
+ * @property {Option} rowHeightByOverlayName Option `rowHeightByOverlayName`.
+ * @property {Option} shouldRenderBottomOverlay Option `shouldRenderBottomOverlay`.
+ * @property {Option} shouldRenderInlineStartOverlay Option `shouldRenderInlineStartOverlay`.
+ * @property {Option} shouldRenderTopOverlay Option `shouldRenderTopOverlay`.
+ * @property {Option} table Option `table`.
+ * @property {Option} totalColumns Option `totalColumns`.
+ * @property {Option} totalRows Option `totalRows`.
+ * @property {?Option} beforeDraw Option `beforeDraw`.
+ * @property {?Option} columnHeaderHeight Option `columnHeaderHeight`.
+ * @property {?Option} currentColumnClassName Option `currentColumnClassName`.
+ * @property {?Option} headerClassName Option `headerClassName`.
+ * @property {?Option} onAfterDrawSelection Option `onAfterDrawSelection`.
+ * @property {?Option} onAfterMomentumScroll Option `onAfterMomentumScroll`.
+ * @property {?Option} onBeforeDrawBorders Option `onBeforeDrawBorders`.
+ * @property {?Option} onBeforeTouchScroll Option `onBeforeTouchScroll`.
+ * @property {?Option} onCellContextMenu Option `onCellContextMenu`.
+ * @property {?Option} onCellCornerDblClick Option `onCellCornerDblClick`.
+ * @property {?Option} onCellCornerMouseDown Option `onCellCornerMouseDown`.
+ * @property {?Option} onSelectionHandleMouseDown Option `onSelectionHandleMouseDown`.
+ * @property {?Option} onSelectionEdgeMouseDown Option `onSelectionEdgeMouseDown`.
+ * @property {?Option} onCellDblClick Option `onCellDblClick`.
+ * @property {?Option} onCellMouseDown Option `onCellMouseDown`.
+ * @property {?Option} onCellMouseOut Option `onCellMouseOut`.
+ * @property {?Option} onCellMouseOver Option `onCellMouseOver`.
+ * @property {?Option} onCellMouseOverOutside Option `onCellMouseOverOutside`.
+ * @property {?Option} onCellMouseUp Option `onCellMouseUp`.
+ * @property {?Option} onDraw Option `onDraw`.
+ * @property {?Option} onModifyGetCellCoords Option `onModifyGetCellCoords`.
+ * @property {?Option} onModifyGetCoordsElement Option `onModifyGetCoordsElement`.
+ * @property {?Option} onModifyGetCoords Option `onModifyGetCoords`.
+ * @property {?Option} onModifyRowHeaderWidth Option `onModifyRowHeaderWidth`.
+ * @property {?Option} onBeforeViewportScrollHorizontally Option `onBeforeViewportScrollHorizontally`.
+ * @property {?Option} onBeforeViewportScrollVertically Option `onBeforeViewportScrollVertically`.
+ * @property {?Option} onScrollHorizontally Option `onScrollHorizontally`.
+ * @property {?Option} onScrollVertically Option `onScrollVertically`.
+ * @property {?Option} onWindowResize Option `onWindowResize`.
+ * @property {?Option} rowHeaderWidth Option `rowHeaderWidth`.
+ * @property {?Option} selections Option `selections`.
+ * @property {?Option} viewportColumnCalculatorOverride Option `viewportColumnCalculatorOverride`.
+ * @property {?Option} viewportRowCalculatorOverride Option `viewportRowCalculatorOverride`.
+ * @property {?Option} viewportColumnRenderingThreshold Option `viewportColumnRenderingThreshold`.
+ * @property {?Option} viewportRowRenderingThreshold Option `viewportRowRenderingThreshold`.
+ * @property {?Option} viewportColumnRenderingOffsetIsAuto Option `viewportColumnRenderingOffsetIsAuto`.
+ * @property {?Option} viewportRowRenderingOffsetIsAuto Option `viewportRowRenderingOffsetIsAuto`.
+ * @property {?Option} stylesHandler Option `stylesHandler`.
+ */ /**
+ * @template TValue.
+ * @typedef { TValue | Array.<TValue> | (function(...*): TValue) } Option
+ */ /**
+ * Generate the default settings for a Walkontable instance.
+ * Void 0 means it is required, null means it can be empty.
+ *
+ * The `settings` argument is the owning `Settings` instance; the default options defined as functions
+ * (the overlay-render predicates and the cell renderer) read other settings back through it, so they
+ * stay bound to the same instance exactly as when they lived on the class.
+ *
+ * @param {SettingsPort} settings The Settings instance the function-valued defaults read through.
+ * @returns {SettingsPure}
+ */ export function getDefaults(settings) {
+    return {
+        facade: undefined,
+        table: undefined,
+        // Determines whether the Walkontable instance is used as dataset viewer. When its instance is used as
+        // a context menu, autocomplete list, etc, the returned value is `false`.
+        isDataViewInstance: true,
+        // presentation mode
+        externalRowCalculator: false,
+        // Escape hatch for the single-pass (predicted) layout. When `false`, the viewport's
+        // scrollbar/size queries measure the rendered DOM (the legacy, multi-pass path) instead of
+        // reading the predicted layout snapshot. Plugins whose rendering is incompatible with a
+        // predicted single pass (e.g. `mergeCells`, whose virtualized merged-cell height depends on the
+        // viewport it is trying to compute) opt out through this flag, wired in `TableView`.
+        singlePassLayout: true,
+        currentRowClassName: null,
+        currentColumnClassName: null,
+        preventOverflow () {
+            return false;
+        },
+        preventWheel: false,
+        // data source
+        data: undefined,
+        // Number of renderable columns for the left overlay.
+        fixedColumnsStart: 0,
+        // Number of renderable rows for the top overlay.
+        fixedRowsTop: 0,
+        // Number of renderable rows for the bottom overlay.
+        fixedRowsBottom: 0,
+        // Enable the inline start overlay when conditions are met (left for LTR and right for RTL document mode).
+        shouldRenderInlineStartOverlay: ()=>{
+            return settings.getSetting('fixedColumnsStart') > 0 || settings.getSetting('rowHeaders').length > 0;
+        },
+        // Enable the top overlay when conditions are met.
+        shouldRenderTopOverlay: ()=>{
+            return settings.getSetting('fixedRowsTop') > 0 || settings.getSetting('columnHeaders').length > 0;
+        },
+        // Enable the bottom overlay when conditions are met.
+        shouldRenderBottomOverlay: ()=>{
+            return settings.getSetting('fixedRowsBottom') > 0;
+        },
+        minSpareRows: 0,
+        // this must be array of functions: [function (row, TH) {}]
+        rowHeaders () {
+            return [];
+        },
+        // this must be array of functions: [function (column, TH) {}]
+        columnHeaders () {
+            return [];
+        },
+        totalRows: undefined,
+        totalColumns: undefined,
+        cellRenderer: (row, column, TD)=>{
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+            const cellData = settings.getSetting('data', row, column);
+            fastInnerText(TD, cellData === undefined || cellData === null ? '' : cellData);
+        },
+        // columnWidth: 50,
+        columnWidth () {
+        // return undefined means use default size for the rendered cell content
+        },
+        rowHeight () {
+        // return undefined means use default size for the rendered cell content
+        },
+        rowHeightByOverlayName () {
+        // return undefined means use default size for the rendered cell content
+        },
+        rowHeightsUniform () {
+            // return true only when every row is guaranteed the default height (enables the
+            // PositionCache arithmetic fast path). Conservative default: false.
+            return false;
+        },
+        columnWidthsUniform () {
+            // return true only when every column is guaranteed the default width.
+            return false;
+        },
+        defaultColumnWidth: 50,
+        selections: null,
+        hideBorderOnMouseDownOver: false,
+        viewportRowCalculatorOverride: null,
+        viewportColumnCalculatorOverride: null,
+        viewportRowRenderingThreshold: null,
+        viewportColumnRenderingThreshold: null,
+        // Whether the corresponding `viewport*RenderingOffset` grid option is in its 'auto' (dynamic
+        // overscan) mode. An explicit numeric offset is an exact user choice — the directional
+        // scroll-overscan then stays off (see `viewport/calculatorFactory.ts`). Engine-level default is
+        // `true`: a raw Walkontable consumer with no offset override gets the overscan.
+        viewportRowRenderingOffsetIsAuto: true,
+        viewportColumnRenderingOffsetIsAuto: true,
+        // callbacks
+        onCellMouseDown: null,
+        onCellContextMenu: null,
+        onCellMouseOver: null,
+        onCellMouseOverOutside: null,
+        onCellMouseOut: null,
+        onCellMouseUp: null,
+        // onCellMouseOut: null,
+        onCellDblClick: null,
+        onCellCornerMouseDown: null,
+        onCellCornerDblClick: null,
+        onSelectionHandleMouseDown: null,
+        onSelectionEdgeMouseDown: null,
+        beforeDraw: null,
+        onDraw: null,
+        onBeforeRemoveCellClassNames: null,
+        onAfterDrawSelection: null,
+        onBeforeDrawBorders: null,
+        // viewport scroll hooks
+        onBeforeViewportScrollHorizontally: (column)=>column,
+        onBeforeViewportScrollVertically: (row)=>row,
+        // native scroll hooks
+        onScrollHorizontally: null,
+        onScrollVertically: null,
+        //
+        onBeforeTouchScroll: null,
+        onAfterMomentumScroll: null,
+        onModifyRowHeaderWidth: null,
+        onModifyGetCellCoords: null,
+        onModifyGetCoordsElement: null,
+        onModifyGetCoords: null,
+        onBeforeHighlightingRowHeader: (sourceRow)=>sourceRow,
+        onBeforeHighlightingColumnHeader: (sourceCol)=>sourceCol,
+        onWindowResize: null,
+        onContainerElementResize: null,
+        renderAllColumns: false,
+        renderAllRows: false,
+        groups: false,
+        rowHeaderWidth: null,
+        columnHeaderHeight: null,
+        headerClassName: null,
+        rtlMode: false,
+        ariaTags: true,
+        stylesHandler: null
+    };
+}

package/3rdparty/walkontable/src/settings/index.d.mts

@@ -0,0 +1 @@
+export * from './index.js';

package/3rdparty/walkontable/src/settings/index.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Barrel for the settings slice. Keeps every `'./settings'` / `'../settings'` import resolving to the
+ * `Settings` class after the file was split into the accessor engine (`accessor.ts`) and the defaults
+ * data (`defaults.ts`).
+ */
+export { default } from './accessor';

package/3rdparty/walkontable/src/settings/index.js

@@ -0,0 +1,20 @@
+/**
+ * Barrel for the settings slice. Keeps every `'./settings'` / `'../settings'` import resolving to the
+ * `Settings` class after the file was split into the accessor engine (`accessor.ts`) and the defaults
+ * data (`defaults.ts`).
+ */ "use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "default", {
+    enumerable: true,
+    get: function() {
+        return _accessor.default;
+    }
+});
+const _accessor = /*#__PURE__*/ _interop_require_default(require("./accessor"));
+function _interop_require_default(obj) {
+    return obj && obj.__esModule ? obj : {
+        default: obj
+    };
+}

package/3rdparty/walkontable/src/settings/index.mjs

@@ -0,0 +1,5 @@
+/**
+ * Barrel for the settings slice. Keeps every `'./settings'` / `'../settings'` import resolving to the
+ * `Settings` class after the file was split into the accessor engine (`accessor.ts`) and the defaults
+ * data (`defaults.ts`).
+ */ export { default } from './accessor.mjs';

package/3rdparty/walkontable/src/table/baseTable.d.mts

@@ -0,0 +1,2 @@
+export * from './baseTable.js';
+export { default } from './baseTable.js';

package/3rdparty/walkontable/src/table/baseTable.d.ts

@@ -0,0 +1,284 @@
+import type { WalkontableInstance } from '../types';
+import type { EngineContext } from '../wire';
+import type Settings from '../settings';
+import type { RowRangeQuery, ColumnRangeQuery } from './rangeQuery/renderedRange';
+import { type CellAccess } from './cellAccess';
+import { type DomScaffold } from './domScaffold';
+import { type SizeGetters } from '../axisSizing/sizeGetters';
+import { type ViewportPredicates } from './rangeQuery/viewportPredicates';
+import type ColumnFilter from '../filter/column';
+import type RowFilter from '../filter/row';
+import { Renderer } from '../render';
+import ColumnUtils from '../axisSizing/columnUtils';
+import RowUtils from '../axisSizing/rowUtils';
+/**
+ * Assembles the Table module's dependencies from the engine composition context. Shared by the
+ * master table, every overlay clone table, and the `RowUtils`/`ColumnUtils`/range-query mixins.
+ *
+ * Everything the table once received as separate constructor arguments (facade getter, DOM roots,
+ * settings) is folded in here. The volatile viewport calculators are intentionally NOT exposed — the
+ * `calculatedRows`/`calculatedColumns` mixins read the current calculator off `getWtViewport()`, so
+ * there is no stale-reference risk across draws.
+ *
+ * @param {EngineContext} ctx The engine composition context.
+ * @returns {object} The Table dependency set.
+ */
+export declare function createTableDeps(ctx: EngineContext): {
+    wot: WalkontableInstance;
+    facadeGetter: Function;
+    wtSettings: Settings;
+    rootDocument: Document;
+    rootTable: HTMLTableElement;
+    geometryReader: import("../domMeasure/geometryReader").GeometryReader;
+    rowSizeSource: import("../axisSizing/axisSizeSource").RowSizeSource;
+    columnSizeSource: import("../axisSizing/axisSizeSource").AxisSizeSource;
+    getWtTable: () => Table;
+    getWtViewport: () => import("../viewport/viewport").default;
+    getWtOverlays: () => import("../overlay/overlays").default;
+    getSelectionManager: () => import("../selection").SelectionManager;
+    getCloneSource: () => WalkontableInstance;
+    getParentTableOffset: () => {
+        top: number;
+        left: number;
+    } | number;
+    getColumnHeaders: () => Function[];
+    getRowHeaders: () => Function[];
+    isDrawn: () => boolean;
+    setDrawn: (value: boolean) => void;
+};
+/**
+ * The Table module dependencies, inferred from `createTableDeps`.
+ */
+export type TableDeps = ReturnType<typeof createTableDeps>;
+/**
+ * @todo These mixes are never added to the class Table, however their members are used here.
+ * @todo Continue: Potentially it works only, because some of these mixes are added to every inherited class.
+ * @todo Refactoring, move code from `if(this.isMaster)` into MasterTable, and others like that.
+ * @mixes stickyColumnsStart
+ * @mixes stickyRowsBottom
+ * @mixes stickyRowsTop
+ * @mixes calculatedRows
+ * @mixes calculatedColumns
+ * @abstract
+ */
+declare class Table {
+    #private;
+    /**
+     * The walkontable settings.
+     *
+     * @protected
+     * @type {Settings}
+     */
+    wtSettings: Settings;
+    /**
+     * The table body element (TBODY).
+     *
+     * @type {HTMLTableSectionElement | null}
+     */
+    TBODY: HTMLTableSectionElement | null;
+    /**
+     * The table head element (THEAD).
+     *
+     * @type {HTMLTableSectionElement | null}
+     */
+    THEAD: HTMLTableSectionElement | null;
+    /**
+     * The column group element (COLGROUP).
+     *
+     * @type {HTMLTableColElement | null}
+     */
+    COLGROUP: HTMLTableColElement | null;
+    /**
+     * Indicates if the table has height bigger than 0px.
+     *
+     * @type {boolean}
+     */
+    hasTableHeight: boolean;
+    /**
+     * Indicates if the table has width bigger than 0px.
+     *
+     * @type {boolean}
+     */
+    hasTableWidth: boolean;
+    /**
+     * Indicates if the table is visible. By visible, it means that the holder
+     * element has CSS 'display' property different than 'none'.
+     *
+     * @type {boolean}
+     */
+    isTableVisible: boolean;
+    /**
+     * The offset of the table element.
+     *
+     * @type {number | { top: number; left: number }}
+     */
+    tableOffset: number | {
+        top: number;
+        left: number;
+    };
+    /**
+     * The offset of the holder element.
+     *
+     * @type {number | { top: number; left: number }}
+     */
+    holderOffset: number | {
+        top: number;
+        left: number;
+    };
+    /**
+     * The borders holder element.
+     *
+     * @type {HTMLElement}
+     */
+    bordersHolder?: HTMLElement;
+    /**
+     * Indicates if this instance is of type MasterTable (i.e. it is NOT an overlay).
+     *
+     * @type {boolean}
+     */
+    isMaster: boolean;
+    /**
+     * The name of the table (overlay name or 'master').
+     *
+     * @type {string}
+     */
+    name: string;
+    /**
+     * Read-only access to the dependencies, for the range-query mixins (`calculatedRows`/
+     * `calculatedColumns`/`stickyRows*`/`stickyColumns*`) and `RowUtils`/`ColumnUtils`, which are
+     * defined outside this class and so cannot reach the private `#deps`.
+     *
+     * @returns {TableDeps}
+     */
+    get deps(): TableDeps;
+    /**
+     * Function which returns the proper facade.
+     *
+     * @type {Function}
+     */
+    facadeGetter: Function;
+    /**
+     * The Walkontable instance (legacy alias for instance).
+     *
+     * @type {WalkontableInstance}
+     */
+    wot: WalkontableInstance;
+    /**
+     * The table element.
+     *
+     * @type {HTMLTableElement}
+     */
+    TABLE: HTMLTableElement;
+    /**
+     * The spreader element.
+     *
+     * @type {HTMLElement}
+     */
+    spreader: HTMLElement;
+    /**
+     * The hider element.
+     *
+     * @type {HTMLElement}
+     */
+    hider: HTMLElement;
+    /**
+     * The holder element.
+     *
+     * @type {HTMLElement}
+     */
+    holder: HTMLElement;
+    /**
+     * The root element.
+     *
+     * @type {HTMLElement}
+     */
+    wtRootElement: HTMLElement;
+    /**
+     * The row filter.
+     *
+     * @type {RowFilter | null}
+     */
+    rowFilter: RowFilter | null;
+    /**
+     * The column filter.
+     *
+     * @type {ColumnFilter | null}
+     */
+    columnFilter: ColumnFilter | null;
+    /**
+     * Indicates if the header width should be corrected.
+     *
+     * @type {boolean}
+     */
+    correctHeaderWidth: boolean;
+    /**
+     * The row utilities.
+     *
+     * @type {RowUtils}
+     */
+    rowUtils: RowUtils;
+    /**
+     * The column utilities.
+     *
+     * @type {ColumnUtils}
+     */
+    columnUtils: ColumnUtils;
+    /**
+     * The table renderer.
+     *
+     * @type {Renderer}
+     */
+    tableRenderer: Renderer;
+    /**
+     * Aligns overlays with the trimming container.
+     *
+     * @returns {void}
+     */
+    alignOverlaysWithTrimmingContainer(): void;
+    /**
+     *
+     * @abstract
+     * @param {TableDeps} deps The table module dependencies.
+     * @param {'master'|CLONE_TYPES_ENUM} name Overlay name.
+     */
+    constructor(deps: TableDeps, name: string);
+    /**
+     * Returns a boolean that is true if this Table represents a specific overlay, identified by the overlay name.
+     * For MasterTable, it returns false.
+     *
+     * @param {string} overlayTypeName The overlay type.
+     * @returns {boolean}
+     */
+    is(overlayTypeName: string): boolean;
+    /**
+     * Redraws the table.
+     *
+     * @param {boolean} [fastDraw=false] If TRUE, will try to avoid full redraw and only update the border positions.
+     *                                   If FALSE or UNDEFINED, will perform a full redraw.
+     * @returns {Table}
+     */
+    draw(fastDraw?: boolean): this;
+    /**
+     * Modify row header widths provided by user in class contructor.
+     *
+     * @private
+     * @param {Function | number | null} rowHeaderWidthFactory The function which can provide default width values for rows..
+     * @returns {number}
+     */
+    _modifyRowHeaderWidth(rowHeaderWidthFactory: ((...args: unknown[]) => number | number[]) | number | null): number | number[];
+    /**
+     * Correct row header width if necessary.
+     *
+     * @private
+     * @param {number | null} width The width to process.
+     * @returns {number}
+     */
+    _correctRowHeaderWidth(width: number | null): number;
+    /**
+     * Destroys the table instance. Overridden by MasterTable to release DOM resources.
+     */
+    destroy(): void;
+}
+interface Table extends RowRangeQuery, ColumnRangeQuery, CellAccess, DomScaffold, SizeGetters, ViewportPredicates {
+}
+export default Table;