@revolist/revogrid 4.22.0 → 4.23.0

package/dist/types/plugins/sorting/sorting.types.d.ts

@@ -1,14 +1,59 @@
-import type { CellCompareFunc, ColumnProp, Order } from "../../types/index";
+import type { CellCompareFunc, ColumnProp, ColumnRegular, Order } from "../../types/index";
+/**
+ * Current sorting order per column property.
+ */
 export type SortingOrder = Record<ColumnProp, Order>;
+/**
+ * Comparator functions indexed by column property.
+ *
+ * Undefined comparator entries are treated as inactive sorting entries.
+ */
 export type SortingOrderFunction = Record<ColumnProp, CellCompareFunc | undefined>;
+/**
+ * Column metadata indexed by column property.
+ *
+ * This is an internal companion map for `SortingOrderFunction`. It lets the
+ * sorting helper detect the default comparer path without mutating
+ * `CellCompareFunc` instances or changing the public comparator contract.
+ */
+export type SortingColumnMap = Record<ColumnProp, Partial<ColumnRegular> | undefined>;
+/**
+ * Active sorting priority in click/config insertion order.
+ *
+ * This is stored separately from `SortingOrder` because JavaScript object keys
+ * that look like integers are enumerated in numeric order, not insertion order.
+ */
+export type SortingColumnOrder = ColumnProp[];
+/**
+ * Header metadata used to display additive sort priority.
+ */
+export type SortingColumnRender = {
+    /**
+     * One-based additive sorting rank.
+     */
+    sortIndex?: number;
+};
+/**
+ * Sorting information emitted after columns are set.
+ */
 export type ColumnSetEvent = {
     order: SortingOrder;
 };
+/**
+ * External sorting configuration.
+ */
 export type SortingConfig = {
+    /**
+     * Columns to sort by.
+     */
     columns?: {
         prop: ColumnProp;
         order: Order;
         cellCompare?: CellCompareFunc;
     }[];
+    /**
+     * If true, merge provided columns with the current sorting state.
+     * If false or omitted, replace current sorting state.
+     */
     additive?: boolean;
 };

package/dist/types/services/local.scroll.service.d.ts

@@ -1,4 +1,5 @@
 import type { DimensionType, ViewPortScrollEvent } from "../types/index";
+import { type ScrollDimension } from './scroll.dimension.helpers';
 interface Config {
     skipAnimationFrame?: boolean;
     runScroll(e: ViewPortScrollEvent): void;
@@ -10,6 +11,8 @@ type Params = {
     clientSize: number;
     virtualSize: number;
     maxSize?: number;
+    maxScrollSize?: number;
+    scrollDimension?: ScrollDimension;
 };
 /**
  * Based on content size, client size and virtual size
@@ -20,17 +23,22 @@ export default class LocalScrollService {
     private cfg;
     private preventArtificialScroll;
     private previousScroll;
+    private previousLogicalScroll;
     private params;
     constructor(cfg: Config);
     setParams(params: Params, dimension: DimensionType): void;
     setScroll(e: ViewPortScrollEvent): Promise<void>;
+    setScrollByDelta(e: ViewPortScrollEvent, currentPhysicalCoordinate: number): Promise<ViewPortScrollEvent>;
     /**
      * On scroll event started
      */
     scroll(coordinate: number, dimension: DimensionType, force?: boolean, delta?: number, outside?: boolean): void;
     private getParams;
-    private wrapCoordinate;
+    private wrapPhysicalCoordinate;
+    private wrapLogicalCoordinate;
     private cancelScroll;
-    private convert;
+    private toLogicalScrollCoordinate;
+    private toPhysicalCoordinate;
+    private toLogicalCoordinate;
 }
 export {};

package/dist/types/services/scroll.dimension.helpers.d.ts

@@ -0,0 +1,20 @@
+export type ScrollDimensionInput = {
+    contentSize: number;
+    clientSize: number;
+    virtualSize?: number;
+    maxScrollSize?: number;
+};
+export type ScrollDimension = {
+    contentSize: number;
+    clientSize: number;
+    viewportSize: number;
+    physicalContentSize: number;
+    logicalScrollSize: number;
+    physicalScrollSize: number;
+    isCompressed: boolean;
+    toLogicalCoordinate(coordinate: number): number;
+    toPhysicalCoordinate(coordinate: number): number;
+    getRenderOffset(coordinate: number): number;
+};
+export declare function getMaxScrollSize(doc?: Document | undefined): number;
+export declare function getScrollDimension({ contentSize, clientSize, virtualSize, maxScrollSize, }: ScrollDimensionInput): ScrollDimension;

package/dist/types/store/vp/viewport.helpers.d.ts

@@ -1,6 +1,8 @@
 import type { DimensionSettingsState, PositionItem, ViewSettingSizeProp, ViewportStateItems, VirtualPositionItem, Range } from "../../types/index";
 export type DimensionDataViewport = Pick<DimensionSettingsState, 'indexes' | 'positionIndexes' | 'positionIndexToItem' | 'sizes' | 'originItemSize' | 'realSize'>;
 export type ItemsToUpdate = Pick<ViewportStateItems, 'items' | 'start' | 'end'>;
+export declare function getViewportMaxCoordinate(dimension: Pick<DimensionSettingsState, 'realSize' | 'originItemSize'>, viewportSize: number, frameOffset?: number): number;
+export declare function clampViewportCoordinate(coordinate: number, dimension: Pick<DimensionSettingsState, 'realSize' | 'originItemSize'>, viewportSize: number, frameOffset?: number): number;
 /**
  * Update items based on new scroll position
  * If viewport wasn't changed fully simple recombination of positions

package/dist/types/types/events.d.ts

@@ -1,2 +1,2 @@
-export type RevogridEvents = 'contentsizechanged' | 'beforeedit' | 'beforerangeedit' | 'afteredit' | 'beforeautofill' | 'beforerange' | 'afterfocus' | 'roworderchanged' | 'beforesorting' | 'beforesourcesortingapply' | 'beforesortingapply' | 'rowdragstart' | 'headerclick' | 'beforecellfocus' | 'beforefocuslost' | 'beforesourceset' | 'beforeanysource' | 'aftersourceset' | 'afteranysource' | 'beforecolumnsgather' | 'beforecolumnsset' | 'beforecolumnapplied' | 'aftercolumnsset' | 'beforefilterapply' | 'beforefiltertrimmed' | 'beforetrimmed' | 'aftertrimmed' | 'viewportscroll' | 'beforeexport' | 'beforeeditstart' | 'aftercolumnresize' | 'beforerowdefinition' | 'filterconfigchanged' | 'sortingconfigchanged' | 'rowheaderschanged' | 'beforegridrender' | 'aftergridrender' | 'aftergridinit' | 'additionaldatachanged' | 'afterthemechanged' | 'created' | 'beforepaste' | 'beforepasteapply' | 'pasteregion' | 'afterpasteapply' | 'beforecut' | 'clearregion' | 'beforecopy' | 'beforecopyapply' | 'copyregion' | 'beforerowrender' | 'afterrender' | 'beforecellrender' | 'beforedatarender' | 'dragstartcell' | 'celleditinit' | 'closeedit' | 'filterChange' | 'resetChange' | 'beforefocusrender' | 'beforescrollintoview' | 'afterfocus' | 'beforeheaderclick' | 'headerresize' | 'beforeheaderresize' | 'headerdblclick' | 'beforeheaderrender' | 'beforegroupheaderrender' | 'afterheaderrender' | 'rowdragstartinit' | 'rowdragendinit' | 'rowdragmoveinit' | 'rowdragmousemove' | 'rowdropinit' | 'roworderchange' | 'beforecopyregion' | 'beforepasteregion' | 'celleditapply' | 'beforecellfocusinit' | 'beforenextvpfocus' | 'setedit' | 'beforeapplyrange' | 'beforesetrange' | 'setrange' | 'beforeeditrender' | 'selectall' | 'canceledit' | 'settemprange' | 'beforesettemprange' | 'applyfocus' | 'focuscell' | 'beforerangedataapply' | 'selectionchangeinit' | 'beforerangecopyapply' | 'rangeeditapply' | 'clipboardrangecopy' | 'clipboardrangepaste' | 'beforekeydown' | 'beforekeyup' | 'beforecellsave' | 'celledit' | 'scrollview' | 'ref' | 'scrollvirtual' | 'scrollviewport' | 'resizeviewport' | 'scrollchange' | 'scrollviewportsilent' | 'html';
+export type RevogridEvents = 'contentsizechanged' | 'beforeedit' | 'beforerangeedit' | 'afteredit' | 'beforeautofill' | 'beforerange' | 'afterfocus' | 'roworderchanged' | 'beforesorting' | 'beforesourcesortingapply' | 'beforesortingapply' | 'rowdragstart' | 'headerclick' | 'beforecellfocus' | 'beforefocuslost' | 'beforesourceset' | 'beforeanysource' | 'aftersourceset' | 'afteranysource' | 'beforecolumnsgather' | 'beforecolumnsset' | 'beforecolumnapplied' | 'aftercolumnsset' | 'beforefilterapply' | 'beforefiltertrimmed' | 'beforetrimmed' | 'aftertrimmed' | 'viewportscroll' | 'beforeexport' | 'beforeeditstart' | 'aftercolumnresize' | 'beforerowdefinition' | 'filterconfigchanged' | 'sortingconfigchanged' | 'rowheaderschanged' | 'beforegridrender' | 'aftergridrender' | 'aftergridinit' | 'additionaldatachanged' | 'afterthemechanged' | 'created' | 'beforepaste' | 'beforepasteapply' | 'pasteregion' | 'afterpasteapply' | 'beforecut' | 'clearregion' | 'beforecopy' | 'beforecopyapply' | 'copyregion' | 'beforerowrender' | 'afterrender' | 'beforecellrender' | 'beforedatarender' | 'dragstartcell' | 'celleditinit' | 'closeedit' | 'filterChange' | 'resetChange' | 'beforefocusrender' | 'beforescrollintoview' | 'afterfocus' | 'beforeheaderclick' | 'headerresize' | 'beforeheaderresize' | 'headerdblclick' | 'beforeheaderrender' | 'beforegroupheaderrender' | 'afterheaderrender' | 'columndragstart' | 'columndragmousemove' | 'beforecolumndragend' | 'columndragend' | 'rowdragstartinit' | 'rowdragendinit' | 'rowdragmoveinit' | 'rowdragmousemove' | 'rowdropinit' | 'roworderchange' | 'beforecopyregion' | 'beforepasteregion' | 'celleditapply' | 'beforecellfocusinit' | 'beforenextvpfocus' | 'setedit' | 'beforeapplyrange' | 'beforesetrange' | 'setrange' | 'beforeeditrender' | 'selectall' | 'canceledit' | 'settemprange' | 'beforesettemprange' | 'applyfocus' | 'focuscell' | 'beforerangedataapply' | 'selectionchangeinit' | 'beforerangecopyapply' | 'rangeeditapply' | 'clipboardrangecopy' | 'clipboardrangepaste' | 'beforekeydown' | 'beforekeyup' | 'beforecellsave' | 'celledit' | 'scrollview' | 'ref' | 'scrollvirtual' | 'scrollviewport' | 'resizeviewport' | 'scrollchange' | 'scrollviewportsilent' | 'html';
 export declare const REVOGRID_EVENTS: Map<RevogridEvents, RevogridEvents>;

package/dist/types/types/interfaces.d.ts

@@ -509,6 +509,12 @@ export interface ViewportState extends ViewportStateItems {
      * Until virtualization is not disabled.
      */
     clientSize: number;
+    /**
+     * Difference between logical coordinate and browser-safe rendered coordinate.
+     * Internal scroll virtualization offset used when content exceeds browser
+     * native scroll size limits.
+     */
+    renderOffset?: number;
 }
 /**
  * `ViewSettingSizeProp` is a record that maps column or row indexes to their
@@ -625,6 +631,11 @@ export interface DimensionSettingsState extends DimensionCalc {
      * Represents the origin item size of the dimension.
      */
     originItemSize: number;
+    /**
+     * Internal render offset applied when logical scroll space is compressed into
+     * a browser-safe physical scroll range.
+     */
+    renderOffset?: number;
 }
 /**
  * Represents the mapping of dimension types to their corresponding observable stores.

package/dist/types/utils/key.utils.d.ts

@@ -10,3 +10,11 @@ export declare function isCut(event: KeyboardEvent): boolean;
 export declare function isCopy(event: KeyboardEvent): boolean;
 export declare function isPaste(event: KeyboardEvent): boolean;
 export declare function isAll(event: KeyboardEvent): boolean;
+/**
+ * Returns true when a keyboard event represents a shortcut modifier that
+ * should not start cell editing from printable `event.key` input.
+ *
+ * AltGr is intentionally excluded because many Windows/Linux layouts expose
+ * printable AltGr characters as Ctrl+Alt key events.
+ */
+export declare function isShortcutModifier(event: KeyboardEvent): boolean;