@opencorestack/opengridx 1.2.3 → 2.0.0

package/CHANGELOG.md

@@ -5,6 +5,63 @@
 
 ---
 
+## [2.0.0] — 2026-09-08
+
+### Breaking
+
+- **Removed dead public API:** `onPinnedRowsChange` and `onRowGroupingModelChange` are removed from
+  `DataGridProps`. Both props accepted callbacks that were never invoked — no pin/unpin-row UI and no
+  drag-to-group UI exist. Callers that passed these callbacks should simply remove them; grid
+  behavior is unchanged.
+
+### Added
+
+- **`density` wired** — `density?: 'compact' | 'standard' | 'comfortable'` now sets the
+  `--ogx-row-height` CSS variable (compact = 32 px, standard = `rowHeight`, comfortable = 72 px).
+  Previously accepted but silently discarded.
+- **`disableRowSelectionOnClick`** — clicking a row no longer triggers selection when this prop is
+  `true`. Previously wired to internal state only; `onRowSelectionModelChange` is now also fired.
+- **`disableMultipleRowSelection`** — clicking a row while this prop is `true` caps selection to
+  that single row (deselects others). Clicking an already-selected row deselects it.
+- **`groupingColDef` implemented** — passing `groupingColDef` when `rowGroupingModel` is active now
+  creates a dedicated `__group__` column at position 0, auto-pinned left. Previously the prop was
+  accepted but had no runtime effect.
+- **`groupable: false` honored** — columns with `groupable: false` are now skipped when building the
+  grouping tree in `useRowGrouping`. Previously this flag was silently ignored.
+- **`groupingValueFormatter` on `GridColDef`** — new optional field
+  `groupingValueFormatter?: (params: { field: string; value: unknown }) => string` customizes the
+  label shown for group-header rows at that level. The formatted string flows through
+  `GridRowMeta.groupLabel`. Falls back to `"${field}: ${value}"` when omitted.
+- **`availableAggregationFunctions` honored** — per-column `availableAggregationFunctions?: string[]`
+  now gates which aggregation functions are computed in `useAggregation`. Functions not in the
+  allowed list are skipped for that field.
+- **`multiSort` prop** — new `multiSort?: boolean` on `DataGrid`. When `true`, every click on a
+  sortable column header appends/cycles that column in the sort model instead of replacing it — no
+  Shift key required. Shift+click continues to work as an append gesture regardless of this prop.
+- **Multi-sort shift-click** — shift-clicking a column header appends the column to `sortModel`
+  rather than replacing it. A numbered priority badge appears next to the sort arrow when more than
+  one sort key is active. Plain click still replaces with a single-key sort (unless `multiSort` is set).
+- **`description` tooltip** — `description?: string` on `GridColDef` now renders as the native
+  `title` attribute on the header cell, providing a browser tooltip on hover.
+
+---
+
+## [1.3.0] — 2026-09-08
+
+### Added
+- **Grouped export** — all five export functions (`exportToCsv`, `exportToExcel`, `exportToJson`,
+  `printGrid`, `exportToPdf`) now accept an optional `groupedRows?: GridGroupedExportRow[]` option.
+  When provided, the export preserves the row-grouping structure: group-header rows, indented leaf
+  rows, per-group subtotals, and a grand total footer. Flat behavior is unchanged when the option
+  is absent, making this a fully backward-compatible addition.
+- **`GridApi.getGroupedExportRows()`** — new method that returns a flat ordered list of
+  `GridGroupedExportRow` entries (types: `group-header | leaf | group-subtotal | grand-total`)
+  by traversing the active row-grouping tree. Returns `null` when row grouping is not active.
+- **`GridGroupedExportRow` type** — new public interface describing each entry in the grouped
+  export list (`type`, `depth`, `groupField?`, `groupValue?`, `aggregatedValues?`, `row?`).
+
+---
+
 ## [1.2.3] — 2026-09-08
 
 ### Fixed

package/dist/index.d.ts

@@ -78,6 +78,8 @@ export declare interface CsvExportOptions {
     selectedRows?: (string | number)[];
     aggregationResult?: Record<string, unknown> | null;
     aggregationModel?: GridAggregationModel | null;
+    /** When provided, emits group headers, leaf rows, subtotals, and a grand total instead of a flat row list. */
+    groupedRows?: GridGroupedExportRow[];
 }
 
 export declare const darkTheme: GridTheme;
@@ -106,6 +108,13 @@ export declare interface DataGridProps<R extends GridRowModel = GridRowModel> {
     sortModel?: GridSortItem[];
     /** Callback fired when the sorting model changes. */
     onSortModelChange?: (model: GridSortItem[]) => void;
+    /**
+     * When true, clicking any sortable column header appends/cycles that column in the
+     * sort model instead of replacing it — no Shift key required. Plain click still
+     * cycles asc → desc → removed for that column while all other active sort keys stay.
+     * Shift+click continues to work regardless of this prop.
+     */
+    multiSort?: boolean;
     /** Filtering mode: 'client' (default) or 'server'. */
     filterMode?: 'client' | 'server';
     /** The current filter model. */
@@ -134,8 +143,6 @@ export declare interface DataGridProps<R extends GridRowModel = GridRowModel> {
     onColumnVisibilityModelChange?: (model: GridColumnVisibilityModel) => void;
     /** Defines which rows are pinned to the top or bottom. */
     pinnedRows?: GridRowPinning;
-    /** Callback fired when row pinning changes. */
-    onPinnedRowsChange?: (model: GridRowPinning) => void;
     /** If true, a column of checkboxes is added for row selection. */
     checkboxSelection?: boolean;
     /** If true, the checkbox column remains visible during horizontal scrolling. */
@@ -202,8 +209,6 @@ export declare interface DataGridProps<R extends GridRowModel = GridRowModel> {
     defaultGroupingExpansionDepth?: number;
     /** Controlled state for row grouping. */
     rowGroupingModel?: GridRowGroupingModel;
-    /** Callback fired when row grouping changes. */
-    onRowGroupingModelChange?: (model: GridRowGroupingModel) => void;
     /** Controlled state for data aggregation (e.g., { salary: 'sum' }). */
     aggregationModel?: GridAggregationModel;
     /** Callback fired when aggregation model changes. */
@@ -330,6 +335,8 @@ export declare interface ExcelExportOptions {
     selectedRows?: (string | number)[];
     aggregationResult?: Record<string, unknown> | null;
     aggregationModel?: GridAggregationModel | null;
+    /** When provided, emits group headers, leaf rows, subtotals, and a grand total instead of a flat row list. */
+    groupedRows?: GridGroupedExportRow[];
 }
 
 export declare interface ExcelSheetDefinition {
@@ -404,6 +411,13 @@ export declare interface GridApi {
     getVisibleRows: () => GridRowModel[];
     /** Returns all filtered and sorted rows, ignoring pagination. Use this for full-dataset exports. */
     getAllFilteredRows: () => GridRowModel[];
+    /**
+     * Returns an ordered flat list of `GridGroupedExportRow` entries that mirrors the
+     * on-screen grouping tree: group-headers, leaf rows, per-group subtotals, and a
+     * grand-total entry at the end. Returns `null` when no `rowGroupingModel` is active.
+     * Pass the result to export functions that accept a `groupedRows` option.
+     */
+    getGroupedExportRows: () => GridGroupedExportRow[] | null;
     /** Returns the current aggregation results. */
     getAggregationResult: () => Record<string, unknown> | null;
     /** Returns the active aggregation configuration. */
@@ -475,13 +489,22 @@ export declare interface GridColDef<R extends GridRowModel = GridRowModel> {
     field: string;
     /** Text displayed in the column header. */
     headerName?: string;
-    /** Tooltip or accessible description for the header. */
+    /** Tooltip shown on header hover — used as the column's accessibility label. */
     description?: string;
     /** If true, this column can be used as a grouping dimension. */
     groupable?: boolean;
+    /**
+     * Custom formatter for the group-header label when this column is used as a grouping field.
+     * Receives the field name and grouped value; return the string to display.
+     * Falls back to `"field: value"` when omitted.
+     */
+    groupingValueFormatter?: (params: {
+        field: string;
+        value: unknown;
+    }) => string;
     /** If true, this column can be summarized using aggregation functions. */
     aggregable?: boolean;
-    /** List of allowed aggregation functions (e.g., ['sum', 'avg']). */
+    /** Restricts which aggregation functions are offered for this column (e.g., ['sum', 'avg']). */
     availableAggregationFunctions?: string[];
     /** Width in pixels or a percentage string. Defaults to automatic calculation. */
     width?: number | string;
@@ -697,6 +720,25 @@ export declare interface GridGetRowsResponse<R extends GridRowModel = GridRowMod
     aggregationResults?: Record<string, unknown>;
 }
 
+/**
+ * A single entry in the ordered list returned by `GridApi.getGroupedExportRows()`.
+ * Traverse in array order to reproduce the on-screen grouping structure.
+ */
+declare interface GridGroupedExportRow {
+    /** Discriminator: the kind of row this entry represents. */
+    type: 'group-header' | 'leaf' | 'group-subtotal' | 'grand-total';
+    /** Nesting depth (0 = top-level group, 1 = nested group, etc.). */
+    depth: number;
+    /** The grouping field for this level (absent on 'leaf' and 'grand-total'). */
+    groupField?: string;
+    /** The raw grouping value for this level (absent on 'leaf' and 'grand-total'). */
+    groupValue?: unknown;
+    /** Per-group aggregation results (present on 'group-subtotal' and 'grand-total'). */
+    aggregatedValues?: Record<string, unknown>;
+    /** The original data row (only present when `type === 'leaf'`). */
+    row?: GridRowModel;
+}
+
 export declare type GridInitialState = GridState;
 
 /** Column definition used exclusively in List View mode. */
@@ -789,6 +831,7 @@ export declare interface GridRowMeta {
     treeDepth?: number;
     groupingField?: string;
     groupingValue?: unknown;
+    groupLabel?: string;
     descendantCount?: number;
     isExpanded?: boolean;
     isGroupRow?: boolean;
@@ -1156,6 +1199,8 @@ declare interface HeaderProps<R extends GridRowModel = GridRowModel> {
         field: string;
     } | null;
     onHeaderClick?: (field: string) => void;
+    onSortAdd?: (field: string, direction: GridSortDirection) => void;
+    multiSort?: boolean;
     onHideColumn?: (field: string) => void;
     onPinColumn?: (field: string, side: 'left' | 'right' | null) => void;
     onManageColumns?: () => void;
@@ -1176,6 +1221,8 @@ export declare interface JsonExportOptions {
     selectedRows?: (string | number)[];
     aggregationResult?: Record<string, unknown> | null;
     aggregationModel?: GridAggregationModel | null;
+    /** When provided, emits a nested grouping tree instead of a flat array. */
+    groupedRows?: GridGroupedExportRow[];
 }
 
 /**
@@ -1234,6 +1281,13 @@ export declare interface PdfExportOptions {
      * Base font size in points for table body. Default: 9
      */
     fontSize?: number;
+    /**
+     * Pre-built grouped export rows from `apiRef.current.getGroupedExportRows()`.
+     * When provided, the PDF table reflects the grouping structure (group headers,
+     * leaf rows, per-group subtotals, grand total) instead of a flat row list.
+     * Has no effect when the grid has no active `rowGroupingModel`.
+     */
+    groupedRows?: GridGroupedExportRow[];
 }
 
 /**
@@ -1246,6 +1300,8 @@ export declare interface PrintOptions {
     selectedRows?: (string | number)[];
     aggregationResult?: Record<string, unknown> | null;
     aggregationModel?: GridAggregationModel | null;
+    /** When provided, emits group headers, leaf rows, subtotals, and a grand total instead of a flat row list. */
+    groupedRows?: GridGroupedExportRow[];
 }
 
 export declare const roseTheme: GridTheme;
@@ -1339,6 +1395,7 @@ export declare function useAggregation<R extends GridRowModel>(params: UseAggreg
 
 export declare interface UseAggregationParams<R extends GridRowModel> {
     rows: R[];
+    columns?: GridColDef[];
     aggregationModel: GridAggregationModel;
     isServerSide: boolean;
     dataSource?: GridDataSource<R>;