@highcharts/grid-pro 2.0.0 → 2.1.0

package/es-modules/Grid/Core/Table/Table.d.ts

@@ -135,7 +135,7 @@ declare class Table {
      * @returns
      * The viewport state metadata.
      */
-    getStateMeta(): Table.ViewportStateMetadata;
+    getStateMeta(): ViewportStateMetadata;
     /**
      * Apply the metadata to the viewport state. It is used to restore the state
      * of the viewport when the data grid is re-rendered.
@@ -143,7 +143,7 @@ declare class Table {
      * @param meta
      * The viewport state metadata.
      */
-    applyStateMeta(meta: Table.ViewportStateMetadata): void;
+    applyStateMeta(meta: ViewportStateMetadata): void;
     /**
      * Sets the focus anchor cell.
      *
@@ -166,16 +166,14 @@ declare class Table {
      */
     getRow(id: number): TableRow | undefined;
 }
-declare namespace Table {
-    /**
-     * Represents the metadata of the viewport state. It is used to save the
-     * state of the viewport and restore it when the data grid is re-rendered.
-     */
-    interface ViewportStateMetadata {
-        scrollTop: number;
-        scrollLeft: number;
-        columnResizing: ColumnResizingMode;
-        focusCursor?: [number, number];
-    }
+/**
+ * Represents the metadata of the viewport state. It is used to save the
+ * state of the viewport and restore it when the data grid is re-rendered.
+ */
+export interface ViewportStateMetadata {
+    scrollTop: number;
+    scrollLeft: number;
+    columnResizing: ColumnResizingMode;
+    focusCursor?: [number, number];
 }
 export default Table;

package/es-modules/Grid/Core/Table/Table.js

@@ -165,10 +165,10 @@ class Table {
         // instead of the original data table row count.
         const rowCount = Number(grid.dataTable?.rowCount);
         const threshold = rows?.virtualizationThreshold ?? 50;
-        const paginationPageSize = grid.pagination?.currentPageSize;
-        return paginationPageSize ?
-            paginationPageSize >= threshold :
-            rowCount >= threshold;
+        if (grid.pagination) {
+            return grid.querying.pagination.currentPageSize >= threshold;
+        }
+        return rowCount >= threshold;
     }
     /**
      * Loads the columns of the table.
@@ -194,7 +194,7 @@ class Table {
         if (vp.focusCursor) {
             focusedRowId = vp.dataTable.getOriginalRowIndex(vp.focusCursor[0]);
         }
-        vp.grid.pagination?.clampCurrentPage();
+        vp.grid.querying.pagination.clampPage();
         // Update data
         const oldRowsCount = (vp.rows[vp.rows.length - 1]?.index ?? -1) + 1;
         await vp.grid.querying.proceed();
@@ -238,11 +238,14 @@ class Table {
                 });
             }
         }
+        vp.grid.dirtyFlags.delete('rows');
     }
     /**
      * Reflows the table's content dimensions.
      */
     reflow() {
+        // TODO: More `needsReflow` logic can be added in the future to avoid
+        // unnecessary reflows of the table parts.
         this.columnResizing.reflow();
         // Reflow the head
         this.header?.reflow();
@@ -254,6 +257,7 @@ class Table {
         this.grid.popups.forEach((popup) => {
             popup.reflow();
         });
+        this.grid.dirtyFlags.delete('reflow');
     }
     /**
      * Scrolls the table to the specified row.

package/es-modules/Grid/Core/UI/Button.d.ts

@@ -4,7 +4,7 @@ import type Popup from './Popup.js';
  * `Toolbar`.
  * @private
  */
-interface Button {
+export interface Button {
     /**
      * Focuses the button.
      */

package/es-modules/Grid/Core/UI/ContextMenu.d.ts

@@ -3,7 +3,7 @@ import ContextMenuButton from './ContextMenuButton.js';
 /**
  * The context menu.
  */
-declare abstract class ContextMenu extends Popup {
+export declare abstract class ContextMenu extends Popup {
     /**
      * The array of buttons in the context menu.
      */

package/es-modules/Grid/Core/UI/ContextMenu.js

@@ -30,7 +30,7 @@ const { makeHTMLElement } = GridUtils;
 /**
  * The context menu.
  */
-class ContextMenu extends Popup {
+export class ContextMenu extends Popup {
     constructor() {
         /* *
          *

package/es-modules/Grid/Core/UI/ContextMenuButton.d.ts

@@ -1,9 +1,9 @@
 import type ContextMenu from './ContextMenu';
 import type Button from './Button';
 import type Popup from './Popup';
-import SvgIcons from './SvgIcons.js';
-import Globals from '../Globals.js';
-declare class ContextMenuButton implements Button {
+import { GridIconName } from './SvgIcons.js';
+import { ClassNameKey } from '../Globals.js';
+export declare class ContextMenuButton implements Button {
     /**
      * The wrapper `<li>` element for the button.
      */
@@ -24,7 +24,7 @@ declare class ContextMenuButton implements Button {
     /**
      * The options for the context menu button.
      */
-    protected options: ContextMenuButton.Options;
+    protected options: ContextMenuButtonOptions;
     /**
      * The container for the icon element.
      */
@@ -41,7 +41,7 @@ declare class ContextMenuButton implements Button {
      * The span element for the label.
      */
     private spanEl?;
-    constructor(options: ContextMenuButton.Options);
+    constructor(options: ContextMenuButtonOptions);
     /**
      * Adds the button to the context menu.
      *
@@ -57,7 +57,7 @@ declare class ContextMenuButton implements Button {
      * @param icon
      * The icon to set.
      */
-    setIcon(icon?: SvgIcons.GridIconName): void;
+    setIcon(icon?: GridIconName): void;
     setActive(active: boolean): void;
     setHighlighted(highlighted: boolean): void;
     /**
@@ -84,43 +84,38 @@ declare class ContextMenuButton implements Button {
      */
     private removeEventListeners;
 }
-declare namespace ContextMenuButton {
-    /**
-     * Options for the context menu button.
-     */
-    interface Options {
-        /**
-         * The label for the button.
-         */
-        label?: string;
-        /**
-         * The icon for the button.
-         */
-        icon?: SvgIcons.GridIconName;
-        /**
-         * A class name key applied to the `<li>` wrapper of the button.
-         */
-        classNameKey?: Globals.ClassNameKey;
-        /**
-         * The icon for the active state of the button.
-         */
-        activeIcon?: SvgIcons.GridIconName;
-        /**
-         * The icon for the highlighted state of the button.
-         */
-        highlightedIcon?: SvgIcons.GridIconName;
-        /**
-         * The tooltip string for the button.
-         */
-        tooltip?: string;
-        /**
-         * If the chevron icon should be rendered.
-         */
-        chevron?: boolean;
-        /**
-         * The click handler for the button.
-         */
-        onClick?: (event: MouseEvent, button: ContextMenuButton) => void;
-    }
+export interface ContextMenuButtonOptions {
+    /**
+     * The label for the button.
+     */
+    label?: string;
+    /**
+     * The icon for the button.
+     */
+    icon?: GridIconName;
+    /**
+     * A class name key applied to the `<li>` wrapper of the button.
+     */
+    classNameKey?: ClassNameKey;
+    /**
+     * The icon for the active state of the button.
+     */
+    activeIcon?: GridIconName;
+    /**
+     * The icon for the highlighted state of the button.
+     */
+    highlightedIcon?: GridIconName;
+    /**
+     * The tooltip string for the button.
+     */
+    tooltip?: string;
+    /**
+     * If the chevron icon should be rendered.
+     */
+    chevron?: boolean;
+    /**
+     * The click handler for the button.
+     */
+    onClick?: (event: MouseEvent, button: ContextMenuButton) => void;
 }
 export default ContextMenuButton;

package/es-modules/Grid/Core/UI/ContextMenuButton.js

@@ -13,7 +13,7 @@
  *
  * */
 'use strict';
-import SvgIcons from './SvgIcons.js';
+import { createGridIcon } from './SvgIcons.js';
 import Globals from '../Globals.js';
 import GridUtils from '../GridUtils.js';
 const { makeHTMLElement } = GridUtils;
@@ -22,7 +22,7 @@ const { makeHTMLElement } = GridUtils;
  *  Class
  *
  * */
-class ContextMenuButton {
+export class ContextMenuButton {
     /* *
      *
      *  Constructor
@@ -80,7 +80,7 @@ class ContextMenuButton {
         buttonEl.setAttribute('tabindex', '-1');
         this.refreshState();
         if (cfg.chevron) {
-            chevronEl.appendChild(SvgIcons.createGridIcon('chevronRight'));
+            chevronEl.appendChild(createGridIcon('chevronRight'));
         }
         if (cfg.icon) {
             this.setIcon(cfg.icon);
@@ -111,7 +111,7 @@ class ContextMenuButton {
         if (!icon) {
             return;
         }
-        this.icon = SvgIcons.createGridIcon(icon);
+        this.icon = createGridIcon(icon);
         this.iconWrapper?.appendChild(this.icon);
     }
     setActive(active) {

package/es-modules/Grid/Core/UI/Popup.d.ts

@@ -3,7 +3,7 @@ import type Button from './Button';
 /**
  * Abstract base class for for Grid popups.
  */
-declare abstract class Popup {
+export declare abstract class Popup {
     /**
      * The popup container element.
      */
@@ -48,7 +48,7 @@ declare abstract class Popup {
      * @param options
      * Popup options.
      */
-    constructor(grid: Grid, button?: Button, options?: Popup.Options);
+    constructor(grid: Grid, button?: Button, options?: PopupOptions);
     /**
      * Renders the popup content.
      *
@@ -124,26 +124,24 @@ declare abstract class Popup {
      */
     private removeEventListeners;
 }
-declare namespace Popup {
-    interface Options {
+export interface PopupOptions {
+    /**
+     * Whether to position the popup next to the anchor element (`true`), or
+     * directly below it (`false`). Defaults to `false`.
+     */
+    nextToAnchor?: boolean;
+    /**
+     * The header of the popup.
+     */
+    header?: {
         /**
-         * Whether to position the popup next to the anchor element (`true`), or
-         * directly below it (`false`). Defaults to `false`.
+         * The prefix of the header label, placed before the label.
          */
-        nextToAnchor?: boolean;
+        category?: string;
         /**
-         * The header of the popup.
+         * The label of the header.
          */
-        header?: {
-            /**
-             * The prefix of the header label, placed before the label.
-             */
-            category?: string;
-            /**
-             * The label of the header.
-             */
-            label: string;
-        };
-    }
+        label: string;
+    };
 }
 export default Popup;

package/es-modules/Grid/Core/UI/Popup.js

@@ -26,7 +26,7 @@ const { fireEvent } = U;
 /**
  * Abstract base class for for Grid popups.
  */
-class Popup {
+export class Popup {
     /* *
      *
      *  Constructor
@@ -96,6 +96,7 @@ class Popup {
         if (!this.container) {
             return;
         }
+        fireEvent(this, 'beforeHide');
         this.grid.popups.delete(this);
         this.isVisible = false;
         // Remove event listeners

package/es-modules/Grid/Core/UI/SvgIcons.d.ts

@@ -1,53 +1,52 @@
 /**
- * Registry of all Grid Svg icons with their SVG path data.
- * Icons are designed for a 24x24 viewBox and use stroke-based rendering.
+ * The name of the icon from SvgIcons registry
  */
-declare namespace SvgIcons {
-    /**
-     * The name of the icon from SvgIcons registry
-     */
-    type GridIconName = ('filter' | 'menu' | 'chevronRight' | 'checkmark' | 'upDownArrows' | 'sortAsc' | 'sortDesc');
-    /**
-     * The registry of all Grid Svg icons with their SVG path data.
-     */
-    const icons: Record<GridIconName, SVGDefinition>;
-    /**
-     * The default path definitions for the Grid Svg icons.
-     */
-    const pathDefaults: Partial<PathDefinition>;
-    /**
-     * The definition of a path for a Grid Svg icon.
-     */
-    interface PathDefinition {
-        d: string;
-        stroke?: string;
-        'stroke-width'?: number;
-        'stroke-linecap'?: string;
-        'stroke-linejoin'?: string;
-        opacity?: number;
-    }
-    /**
-     * The definition of an SVG for a Grid Svg icon.
-     */
-    interface SVGDefinition {
-        width?: number;
-        height?: number;
-        viewBox?: string;
-        fill?: string;
-        children?: PathDefinition[];
-    }
-    /**
-     * Creates an SVG icon element from the SvgIcons registry.
-     *
-     * @param name
-     * The name of the icon from SvgIcons registry
-     *
-     * @param className
-     * CSS class name for the SVG element (default: 'hcg-icon')
-     *
-     * @returns
-     * SVG element with the specified icon
-     */
-    function createGridIcon(name: GridIconName, className?: string): SVGElement;
+export type GridIconName = ('filter' | 'menu' | 'chevronRight' | 'checkmark' | 'upDownArrows' | 'sortAsc' | 'sortDesc');
+/**
+ * The registry of all Grid Svg icons with their SVG path data.
+ */
+export declare const icons: Record<GridIconName, SVGDefinition>;
+/**
+ * The default path definitions for the Grid Svg icons.
+ */
+export declare const pathDefaults: Partial<PathDefinition>;
+/**
+ * The definition of a path for a Grid Svg icon.
+ */
+export interface PathDefinition {
+    d: string;
+    stroke?: string;
+    'stroke-width'?: number;
+    'stroke-linecap'?: string;
+    'stroke-linejoin'?: string;
+    opacity?: number;
 }
-export default SvgIcons;
+/**
+ * The definition of an SVG for a Grid Svg icon.
+ */
+export interface SVGDefinition {
+    width?: number;
+    height?: number;
+    viewBox?: string;
+    fill?: string;
+    children?: PathDefinition[];
+}
+/**
+ * Creates an SVG icon element from the SvgIcons registry.
+ *
+ * @param name
+ * The name of the icon from SvgIcons registry
+ *
+ * @param className
+ * CSS class name for the SVG element (default: 'hcg-icon')
+ *
+ * @returns
+ * SVG element with the specified icon
+ */
+export declare function createGridIcon(name: GridIconName, className?: string): SVGElement;
+declare const _default: {
+    readonly createGridIcon: typeof createGridIcon;
+    readonly icons: Record<GridIconName, SVGDefinition>;
+    readonly pathDefaults: Partial<PathDefinition>;
+};
+export default _default;