@reforgium/data-grid 2.1.1 → 2.2.0

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "2.1.1",
+  "version": "2.2.0",
   "name": "@reforgium/data-grid",
   "description": "reforgium DataGrid component",
   "author": "rtommievich",

package/types/reforgium-data-grid.d.ts

@@ -122,7 +122,7 @@ type GridTooltipContext<Data extends AnyDict = AnyDict> = {
     index: number;
     value: AnyType;
 };
-type GridColumnTooltip<Data extends AnyDict = AnyDict> = string | ((row: Data) => string) | TemplateRef<GridTooltipContext<AnyDict>>;
+type GridColumnTooltip<Data extends AnyDict = AnyDict> = true | string | ((row: Data) => string) | TemplateRef<GridTooltipContext>;
 /**
  * Sticky column side.
  *
@@ -536,6 +536,13 @@ type GridPinnedPosition = 'top' | 'bottom';
  * - `'none'` - Disable row selection
  */
 type GridSelectMode = 'single' | 'multi' | 'none';
+/**
+ * Sorting mode for grid columns.
+ *
+ * - `'single'` - Only one column can be sorted at a time
+ * - `'multi'` - Multiple columns can be sorted simultaneously
+ */
+type GridSortMode = 'single' | 'multi';
 /**
  * Sort direction for grid columns.
  *
@@ -641,6 +648,8 @@ type DataGridConfigProvider = {
     selection: GridSelection;
     /** Number of items to display per page. */
     pageSize: number;
+    /** Sorting mode for grid columns. */
+    sortMode: GridSortMode;
     /** Height of each data row in pixels. */
     rowHeight: number;
     /** Height of the header row in pixels. */
@@ -715,6 +724,26 @@ type GridSortEvent<Data = AnyDict> = {
     key: DataKey<Data>;
     order?: GridSortOrder;
 };
+/**
+ * Single sort item used for multi-column sorting.
+ *
+ * @template Data - Type of data objects in the grid
+ */
+type GridSortItem<Data = AnyDict> = {
+    key: DataKey<Data>;
+    order: GridSortOrder;
+};
+/**
+ * Event emitted when multi-column sorting changes in the data grid.
+ *
+ * Contains an ordered list of sort items, where the order reflects
+ * the priority of sorting (first item has highest priority).
+ *
+ * @template Data - Type of data objects in the grid
+ */
+type GridMultiSortEvent<Data = AnyDict> = {
+    sorts: ReadonlyArray<GridSortItem<Data>>;
+};
 /**
  * Event emitted when row selection changes in the data grid.
  *
@@ -1036,6 +1065,7 @@ declare class Selector<Data extends AnyDict> {
      * Defaults to an empty array.
      */
     selectedKeys: _angular_core.WritableSignal<DataKey<Data>[]>;
+    private selectedKeySet;
     /**
      * Computed signal indicating the overall selection state of all rows.
      *
@@ -1082,13 +1112,13 @@ declare class Selector<Data extends AnyDict> {
      * @returns The updated array of selected keys after the operation.
      * @throws {Error} If selection mode is `'none'`.
      */
-    select(row: Data): (string | Data[DataKey<Data>])[];
+    select(row: Data): (string | (Data[DataKey<Data>] & {}))[];
 }
 
 type TooltipState = {
     text?: string;
-    tpl?: TemplateRef<GridTooltipContext<AnyDict>>;
-    ctx?: GridTooltipContext<AnyDict>;
+    tpl?: TemplateRef<GridTooltipContext>;
+    ctx?: GridTooltipContext;
     x: number;
     y: number;
     visible: boolean;
@@ -1152,6 +1182,7 @@ declare class DataGrid<Data extends AnyDict> {
      * of the scroll area as the user scrolls.
      */
     isRowSticky: _angular_core.InputSignal<((row: Data, index: number) => boolean) | undefined>;
+    isRowDisabled: _angular_core.InputSignal<((row: Data, index: number) => boolean) | undefined>;
     /**
      * Function to choose a custom template for a row.
      *
@@ -1260,6 +1291,7 @@ declare class DataGrid<Data extends AnyDict> {
      * Default is true (0-based indexing).
      */
     pageStartFromZero: _angular_core.InputSignalWithTransform<boolean, string | boolean | undefined>;
+    sortMode: _angular_core.InputSignal<GridSortMode>;
     /**
      * Event emitted when requesting data for a new page.
      *
@@ -1288,6 +1320,7 @@ declare class DataGrid<Data extends AnyDict> {
      * ```
      */
     sortChange: _angular_core.OutputEmitterRef<GridSortEvent<Data>>;
+    multiSortChange: _angular_core.OutputEmitterRef<GridMultiSortEvent<Data>>;
     /**
      * Event emitted when selected rows change.
      *
@@ -1333,6 +1366,28 @@ declare class DataGrid<Data extends AnyDict> {
     cellDoubleClick: _angular_core.OutputEmitterRef<GridCellDoubleClickEvent<Data>>;
     vm: DataGridVm<Data>;
     selector: Selector<Data>;
+    private sortFeature;
+    private rowInteractionsFeature;
+    private headerGroupsFeature;
+    private infinityPageRequestFeature;
+    private expanderFeature;
+    private selectionReconcileFeature;
+    private gridApiFeature;
+    private tooltipAdapterFeature;
+    private virtualScrollFeature;
+    private resizeObserverFeature;
+    private scrollLoopFeature;
+    private lifecycleInitFeature;
+    private stickyOrchestrationFeature;
+    private headerMeasureFeature;
+    private selectionFeatureRef?;
+    private selectionFeaturePromise?;
+    private tooltipFeatureRef?;
+    private tooltipFeaturePromise?;
+    private overlayScrollFeatureRef?;
+    private overlayScrollFeaturePromise?;
+    private stickyFeatureRef?;
+    private stickyFeaturePromise?;
     private rootEl;
     private scrollEl;
     private headerEl;
@@ -1368,25 +1423,31 @@ declare class DataGrid<Data extends AnyDict> {
     protected expanderMap: _angular_core.WritableSignal<Map<DataKey<Data>, boolean>>;
     protected declarativeColumns: _angular_core.Signal<DeclarativeColumnsResult<Data>>;
     protected sourceColumns: _angular_core.Signal<GridColumn<Data>[]>;
+    private slotsFeature;
     protected extendedColumns: _angular_core.Signal<GridColumn<Data>[]>;
     /**
      * Computed CSS height value based on height setting.
      */
     styleHeight: _angular_core.Signal<string>;
     private hideSbTimeout?;
-    private scrollRafId;
     private scrollbarRafId;
     private stickyRafId;
-    private lastInfinityPageRequested;
-    private lastInfinityTotal;
     currentSortField?: string;
     currentSortOrder: GridSortOrder;
+    currentSorts: GridSortItem<Data>[];
+    private currentSortMap;
     private subscription;
-    private observer;
-    private resizeSubject;
-    private lastResizeWidth;
-    private lastResizeHeight;
     constructor();
+    /** Clears current selection and emits `selectChange`. */
+    clearSelection(): void;
+    /** Selects all currently loaded rows (multi mode only) and emits `selectChange`. */
+    selectAllLoaded(): void;
+    /** Resets sorting state and emits sort events. */
+    resetSort(): void;
+    /** Sets a single-column sorting state and emits sort events. */
+    setSort(sort: GridSortEvent<Data>): void;
+    /** Sets multi-column sorting state and emits sort events. */
+    setMultiSort(sorts: ReadonlyArray<GridSortItem<Data>>): void;
     protected resolvePinnedData(pr: GridPinnedRow): Partial<Data>;
     /**
      * Handles column header click for sorting.
@@ -1410,8 +1471,15 @@ declare class DataGrid<Data extends AnyDict> {
      * @param event
      */
     protected onCellClick(row: Data, col: GridColumn<Data>, index: number, event: Event): void;
+    protected onSelectAll(event?: Event): void;
+    protected onCheckboxToggle(row: Data, index: number, event?: Event): void;
+    protected onSelectAllKeydown(event: Event): void;
+    protected onCheckboxKeydown(row: Data, index: number, event: Event): void;
     protected onCellContext(row: Data, col: GridColumn<Data>, index: number, event: MouseEvent): void;
     protected onCellDoubleClick(row: Data, col: GridColumn<Data>, index: number, event: MouseEvent): void;
+    protected onRowClick(row: Data, index: number, event: Event): void;
+    protected onRowContext(row: Data, index: number, event: MouseEvent): void;
+    protected onRowDoubleClick(row: Data, index: number, event: MouseEvent): void;
     protected isExpandable(column: GridColumn<Data>): boolean;
     /**
      * Handles column expand/collapse toggle.
@@ -1446,9 +1514,11 @@ declare class DataGrid<Data extends AnyDict> {
     protected showScrollbar(): void;
     protected hideScrollbarSoon(delay?: number): void;
     protected trackPinnedRow: (row: GridPinnedRow) => number | undefined;
+    protected isDisabledRow(row: Data, index: number): boolean;
     protected cellClass(col: GridColumn<Data>, row: Data): string | undefined;
     protected ariaSort(col: GridColumn<Data>): 'ascending' | 'descending' | 'none';
-    protected resolveTooltip(row: Data, col: GridColumn<Data>): string | TemplateRef<GridTooltipContext<AnyDict>> | null;
+    protected sortOrderFor(col: GridColumn<Data>): GridSortOrder | undefined;
+    protected isActiveSort(col: GridColumn<Data>): boolean;
     protected showTooltip(event: MouseEvent, row: Data, col: GridColumn<Data>, index: number): void;
     protected hideTooltip(): void;
     protected isStickyRowIndex(index: number): boolean;
@@ -1457,26 +1527,27 @@ declare class DataGrid<Data extends AnyDict> {
     private initSelector;
     private initRefs;
     private initSort;
-    private initHeader;
     private initScroll;
     private initObserver;
     private initExpander;
+    private setCurrentSorts;
+    private loadSelectionFeature;
+    private loadTooltipFeature;
+    private loadOverlayScrollFeature;
+    private loadStickyFeature;
     private positionTooltip;
     private scheduleScrollbarUpdate;
     private finalizeScroll;
-    private scheduleScrollTick;
     private clearScrollRaf;
-    private ensureRenderSlots;
     private clearScrollbarRaf;
     private scheduleStickyUpdate;
     private clearStickyRaf;
     private updateStickyRow;
     private updateStickyFromScroll;
-    private findStickyIndexBefore;
     static ɵfac: _angular_core.ɵɵFactoryDeclaration<DataGrid<any>, never>;
-    static ɵcmp: _angular_core.ɵɵComponentDeclaration<DataGrid<any>, "re-data-grid", never, { "data": { "alias": "data"; "required": false; "isSignal": true; }; "columns": { "alias": "columns"; "required": false; "isSignal": true; }; "mode": { "alias": "mode"; "required": false; "isSignal": true; }; "pinnedRows": { "alias": "pinnedRows"; "required": false; "isSignal": true; }; "isRowSticky": { "alias": "isRowSticky"; "required": false; "isSignal": true; }; "getRowTemplate": { "alias": "getRowTemplate"; "required": false; "isSignal": true; }; "hasIndexColumn": { "alias": "hasIndexColumn"; "required": false; "isSignal": true; }; "selection": { "alias": "selection"; "required": false; "isSignal": true; }; "pageSize": { "alias": "pageSize"; "required": false; "isSignal": true; }; "rowHeight": { "alias": "rowHeight"; "required": false; "isSignal": true; }; "height": { "alias": "height"; "required": false; "isSignal": true; }; "virtualBuffer": { "alias": "virtualBuffer"; "required": false; "isSignal": true; }; "lockVerticalScroll": { "alias": "lockVerticalScroll"; "required": false; "isSignal": true; }; "headerGroups": { "alias": "headerGroups"; "required": false; "isSignal": true; }; "loading": { "alias": "loading"; "required": false; "isSignal": true; }; "loadingMode": { "alias": "loadingMode"; "required": false; "isSignal": true; }; "deferContent": { "alias": "deferContent"; "required": false; "isSignal": true; }; "deferHeader": { "alias": "deferHeader"; "required": false; "isSignal": true; }; "deferPinned": { "alias": "deferPinned"; "required": false; "isSignal": true; }; "deferCells": { "alias": "deferCells"; "required": false; "isSignal": true; }; "deferIcons": { "alias": "deferIcons"; "required": false; "isSignal": true; }; "deferTooltip": { "alias": "deferTooltip"; "required": false; "isSignal": true; }; "rowKey": { "alias": "rowKey"; "required": false; "isSignal": true; }; "pageStartFromZero": { "alias": "pageStartFromZero"; "required": false; "isSignal": true; }; }, { "pageChange": "pageChange"; "sortChange": "sortChange"; "selectChange": "selectChange"; "rowClick": "rowClick"; "rowContext": "rowContext"; "rowDoubleClick": "rowDoubleClick"; "cellClick": "cellClick"; "cellContext": "cellContext"; "cellDoubleClick": "cellDoubleClick"; }, ["cellTypedSlotRefs", "cellDataSlotRefs", "declarativeColumnRefs", "headerSlotRefs", "emptySlotRefs", "loadingSlotRefs", "sortIcSlotRefs", "expanderIcSlotRefs", "stickyRowSlotRefs", "rowSlotRefs"], never, true, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<DataGrid<any>, "re-data-grid", never, { "data": { "alias": "data"; "required": false; "isSignal": true; }; "columns": { "alias": "columns"; "required": false; "isSignal": true; }; "mode": { "alias": "mode"; "required": false; "isSignal": true; }; "pinnedRows": { "alias": "pinnedRows"; "required": false; "isSignal": true; }; "isRowSticky": { "alias": "isRowSticky"; "required": false; "isSignal": true; }; "isRowDisabled": { "alias": "isRowDisabled"; "required": false; "isSignal": true; }; "getRowTemplate": { "alias": "getRowTemplate"; "required": false; "isSignal": true; }; "hasIndexColumn": { "alias": "hasIndexColumn"; "required": false; "isSignal": true; }; "selection": { "alias": "selection"; "required": false; "isSignal": true; }; "pageSize": { "alias": "pageSize"; "required": false; "isSignal": true; }; "rowHeight": { "alias": "rowHeight"; "required": false; "isSignal": true; }; "height": { "alias": "height"; "required": false; "isSignal": true; }; "virtualBuffer": { "alias": "virtualBuffer"; "required": false; "isSignal": true; }; "lockVerticalScroll": { "alias": "lockVerticalScroll"; "required": false; "isSignal": true; }; "headerGroups": { "alias": "headerGroups"; "required": false; "isSignal": true; }; "loading": { "alias": "loading"; "required": false; "isSignal": true; }; "loadingMode": { "alias": "loadingMode"; "required": false; "isSignal": true; }; "deferContent": { "alias": "deferContent"; "required": false; "isSignal": true; }; "deferHeader": { "alias": "deferHeader"; "required": false; "isSignal": true; }; "deferPinned": { "alias": "deferPinned"; "required": false; "isSignal": true; }; "deferCells": { "alias": "deferCells"; "required": false; "isSignal": true; }; "deferIcons": { "alias": "deferIcons"; "required": false; "isSignal": true; }; "deferTooltip": { "alias": "deferTooltip"; "required": false; "isSignal": true; }; "rowKey": { "alias": "rowKey"; "required": false; "isSignal": true; }; "pageStartFromZero": { "alias": "pageStartFromZero"; "required": false; "isSignal": true; }; "sortMode": { "alias": "sortMode"; "required": false; "isSignal": true; }; }, { "pageChange": "pageChange"; "sortChange": "sortChange"; "multiSortChange": "multiSortChange"; "selectChange": "selectChange"; "rowClick": "rowClick"; "rowContext": "rowContext"; "rowDoubleClick": "rowDoubleClick"; "cellClick": "cellClick"; "cellContext": "cellContext"; "cellDoubleClick": "cellDoubleClick"; }, ["cellTypedSlotRefs", "cellDataSlotRefs", "declarativeColumnRefs", "headerSlotRefs", "emptySlotRefs", "loadingSlotRefs", "sortIcSlotRefs", "expanderIcSlotRefs", "stickyRowSlotRefs", "rowSlotRefs"], never, true, never>;
 }
 
 export { DATA_GRID_CONFIG, DEFAULT_DATA_GRID_DEFAULTS, DataGrid, DataGridCellEmptyDirective, DataGridCellLoadingDirective, DataGridCellTemplateDirective, DataGridDeclarativeCellDirective, DataGridDeclarativeColumn, DataGridDeclarativeHeaderDirective, DataGridExpanderIconDirective, DataGridHeaderTemplateDirective, DataGridRowDirective, DataGridSortIconDirective, DataGridStickyRowDirective, DataGridTypeCellTemplateDirective, provideDataGridDefaults };
-export type { BaseGridColumn, DataGridConfigProvider, DataGridRowTemplateContext, DataGridStickyRowTemplateContext, DeclarativeColumnDef, GridCellAlign, GridCellClickEvent, GridCellContextEvent, GridCellDoubleClickEvent, GridCellRenderer, GridCellRendererType, GridColumn, GridColumnTooltip, GridColumns, GridHeaderGroup, GridPageChangeEvent, GridPaginationMode, GridPinnedPosition, GridPinnedRow, GridPinnedRows, GridRowClickEvent, GridRowContextEvent, GridRowDoubleClickEvent, GridSelectEvent, GridSelectMode, GridSelection, GridSortEvent, GridSortOrder, GridStickySide, GridTooltipContext, HeaderTemplateData, RenderTemplateData };
+export type { BaseGridColumn, DataGridConfigProvider, DataGridRowTemplateContext, DataGridStickyRowTemplateContext, DeclarativeColumnDef, GridCellAlign, GridCellClickEvent, GridCellContextEvent, GridCellDoubleClickEvent, GridCellRenderer, GridCellRendererType, GridColumn, GridColumnTooltip, GridColumns, GridHeaderGroup, GridMultiSortEvent, GridPageChangeEvent, GridPaginationMode, GridPinnedPosition, GridPinnedRow, GridPinnedRows, GridRowClickEvent, GridRowContextEvent, GridRowDoubleClickEvent, GridSelectEvent, GridSelectMode, GridSelection, GridSortEvent, GridSortItem, GridSortMode, GridSortOrder, GridStickySide, GridTooltipContext, HeaderTemplateData, RenderTemplateData };
 //# sourceMappingURL=reforgium-data-grid.d.ts.map