@mui/x-data-grid 5.8.0 → 5.11.0

package/models/events/gridEvents.d.ts

@@ -1,333 +1,85 @@
 import { GridEventLookup } from './gridEventLookup';
 declare enum GridEvents {
-    /**
-     * Fired when the grid is resized.
-     */
     resize = "resize",
-    /**
-     * Fired when the grid is resized with a debounced time of 60ms.
-     */
     debouncedResize = "debouncedResize",
-    /**
-     * Fired when the inner size of the viewport changes. Called with an [[ElementSize]] object.
-     */
     viewportInnerSizeChange = "viewportInnerSizeChange",
-    /**
-     * Fired when an exception is thrown in the grid.
-     */
     componentError = "componentError",
-    /**
-     * Fired when the grid is unmounted.
-     */
     unmount = "unmount",
-    /**
-     * Fired when the mode of a cell changes.
-     * @ignore - do not document
-     */
     cellModeChange = "cellModeChange",
-    /**
-     * Fired when a cell is clicked.
-     */
     cellClick = "cellClick",
-    /**
-     * Fired when a cell is double-clicked.
-     */
     cellDoubleClick = "cellDoubleClick",
-    /**
-     * Fired when a `mousedown` event happens in a cell.
-     */
     cellMouseDown = "cellMouseDown",
-    /**
-     * Fired when a `mouseup` event happens in a cell.
-     */
     cellMouseUp = "cellMouseUp",
-    /**
-     * Fired when a `keydown` event happens in a cell.
-     */
     cellKeyDown = "cellKeyDown",
-    /**
-     * Fired when a cell gains focus.
-     */
     cellFocusIn = "cellFocusIn",
-    /**
-     * Fired when a cell loses focus.
-     */
     cellFocusOut = "cellFocusOut",
-    /**
-     * Fired when the dragged cell enters a valid drop target. It's mapped to the `dragend` DOM event.
-     * @ignore - do not document.
-     */
     cellDragEnter = "cellDragEnter",
-    /**
-     * Fired while an element or text selection is dragged over the cell.
-     * It's mapped to the `dragover` DOM event.
-     * @ignore - do not document.
-     */
     cellDragOver = "cellDragOver",
-    /**
-     * Fired when the props of the edit cell changes.
-     */
     editCellPropsChange = "editCellPropsChange",
-    /**
-     * Fired when the props of the edit input are committed.
-     */
     cellEditCommit = "cellEditCommit",
-    /**
-     * Fired when the cell turns to edit mode.
-     */
     cellEditStart = "cellEditStart",
-    /**
-     * Fired when the cell turns back to view mode.
-     */
     cellEditStop = "cellEditStop",
-    /**
-     * Fired when the row turns to edit mode.
-     */
+    cellModesModelChange = "cellModesModelChange",
+    rowModesModelChange = "rowModesModelChange",
     rowEditStart = "rowEditStart",
-    /**
-     * Fired when the row turns back to view mode.
-     */
     rowEditStop = "rowEditStop",
-    /**
-     * Fired when the props of the edit input are committed.
-     */
     rowEditCommit = "rowEditCommit",
-    /**
-     * Fired when a [navigation key](/components/data-grid/accessibility#keyboard-navigation) is pressed in a cell.
-     * @ignore - do not document.
-     */
     cellNavigationKeyDown = "cellNavigationKeyDown",
-    /**
-     * Fired when a row is clicked.
-     * Not fired if the cell clicked is from an interactive column (actions, checkbox, etc).
-     */
     rowClick = "rowClick",
-    /**
-     * Fired when a row is double-clicked.
-     */
     rowDoubleClick = "rowDoubleClick",
-    /**
-     * Fired when the mouse enters the row. Called with a [[GridRowParams]] object.
-     */
     rowMouseEnter = "rowMouseEnter",
-    /**
-     * Fired when the mouse leaves the row. Called with a [[GridRowParams]] object.
-     */
     rowMouseLeave = "rowMouseLeave",
-    /**
-     * Fired when the row editing model changes.
-     */
     editRowsModelChange = "editRowsModelChange",
-    /**
-     * Fired when a column header loses focus.
-     * @ignore - do not document.
-     */
+    rowDragStart = "rowDragStart",
+    rowDragOver = "rowDragOver",
+    rowDragEnd = "rowDragEnd",
     columnHeaderBlur = "columnHeaderBlur",
-    /**
-     * Fired when a column header gains focus.
-     * @ignore - do not document.
-     */
     columnHeaderFocus = "columnHeaderFocus",
-    /**
-     * Fired when a [navigation key](/components/data-grid/accessibility#keyboard-navigation) is pressed in a column header.
-     * @ignore - do not document.
-     */
     columnHeaderNavigationKeyDown = "columnHeaderNavigationKeyDown",
-    /**
-     * Fired when a key is pressed in a column header. It's mapped do the `keydown` DOM event.
-     */
     columnHeaderKeyDown = "columnHeaderKeyDown",
-    /**
-     * Fired when a column header is clicked
-     */
     columnHeaderClick = "columnHeaderClick",
-    /**
-     * Fired when a column header is double-clicked.
-     */
     columnHeaderDoubleClick = "columnHeaderDoubleClick",
-    /**
-     * Fired when a `mouseover` event happens in a column header.
-     * @ignore - do not document.
-     */
     columnHeaderOver = "columnHeaderOver",
-    /**
-     * Fired when a `mouseout` event happens in a column header.
-     * @ignore - do not document.
-     */
     columnHeaderOut = "columnHeaderOut",
-    /**
-     * Fired when a `mouseenter` event happens in a column header.
-     * @ignore - do not document.
-     */
     columnHeaderEnter = "columnHeaderEnter",
-    /**
-     * Fired when a `mouseleave` event happens in a column header.
-     * @ignore - do not document.*
-     */
     columnHeaderLeave = "columnHeaderLeave",
-    /**
-     * Fired when the user starts dragging a column header. It's mapped to the `dragstart` DOM event.
-     * @ignore - do not document.
-     */
     columnHeaderDragStart = "columnHeaderDragStart",
-    /**
-     * Fired while an element or text selection is dragged over the column header.
-     * It's mapped to the `dragover` DOM event.
-     * @ignore - do not document.
-     */
     columnHeaderDragOver = "columnHeaderDragOver",
-    /**
-     * Fired when the dragged column header enters a valid drop target.
-     * It's mapped to the `dragend` DOM event.
-     * @ignore - do not document.
-     */
     columnHeaderDragEnter = "columnHeaderDragEnter",
-    /**
-     * Fired when the dragging of a column header ends.
-     * @ignore - do not document.
-     */
     columnHeaderDragEnd = "columnHeaderDragEnd",
-    /**
-     * Fired when the selection state of one or multiple rows changes.
-     */
     selectionChange = "selectionChange",
-    /**
-     * Fired when the value of the selection checkbox of the header is changed
-     */
     headerSelectionCheckboxChange = "headerSelectionCheckboxChange",
-    /**
-     * Fired when the value of the selection checkbox of a row is changed
-     */
     rowSelectionCheckboxChange = "rowSelectionCheckboxChange",
-    /**
-     * Fired when the page changes.
-     */
     pageChange = "pageChange",
-    /**
-     * Fired when the page size changes.
-     */
     pageSizeChange = "pageSizeChange",
-    /**
-     * Fired when the row grouping model changes.
-     */
     rowGroupingModelChange = "rowGroupingModelChange",
-    /**
-     * Fired during the scroll of the grid viewport.
-     */
     rowsScroll = "rowsScroll",
-    /**
-     * Fired when scrolling to the bottom of the grid viewport.
-     */
     rowsScrollEnd = "rowsScrollEnd",
-    /**
-     * Fired when a `mousedown` DOM event happens in the column header separator.
-     * @ignore - do not document.
-     */
     columnSeparatorMouseDown = "columnSeparatorMouseDown",
-    /**
-     * Fired during the resizing of a column.
-     */
     columnResize = "columnResize",
-    /**
-     * Fired when the width of a column is changed.
-     */
     columnWidthChange = "columnWidthChange",
-    /**
-     * Fired when the user starts resizing a column.
-     */
     columnResizeStart = "columnResizeStart",
-    /**
-     * Fired when the user stops resizing a column.
-     */
     columnResizeStop = "columnResizeStop",
-    /**
-     * Fired when the user ends reordering a column.
-     */
     columnOrderChange = "columnOrderChange",
-    /**
-     * Fired when the rows are updated.
-     * @ignore - do not document.
-     */
+    rowOrderChange = "rowOrderChange",
     rowsSet = "rowsSet",
-    /**
-     * Fired when the expansion of a row is changed. Called with a [[GridRowTreeNodeConfig]] object.
-     * @ignore - do not document.
-     */
     rowExpansionChange = "rowExpansionChange",
-    /**
-     * Fired when the visible rows are updated
-     * @ignore - do not document.
-     */
-    visibleRowsSet = "visibleRowsSet",
-    /**
-     * Fired when the columns state is changed.
-     */
+    sortedRowsSet = "sortedRowsSet",
+    filteredRowsSet = "filteredRowsSet",
     columnsChange = "columnsChange",
-    /**
-     * Fired when the open detail panels are changed.
-     * @ignore - do not document.
-     */
     detailPanelsExpandedRowIdsChange = "detailPanelsExpandedRowIdsChange",
-    /**
-     * Fired when the pinned columns is changed.
-     * @ignore - do not document.
-     */
     pinnedColumnsChange = "pinnedColumnsChange",
-    /**
-     * Fired when a pre-processor is registered.
-     * @ignore - do not document.
-     */
-    pipeProcessorRegister = "pipeProcessorRegister",
-    /**
-     * Fired when a pre-processor is unregistered.
-     * @ignore - do not document.
-     */
-    pipeProcessorUnregister = "pipeProcessorUnregister",
-    /**
-     * Fired when a processor of the active strategy changes.
-     * @ignore - do not document.
-     */
     activeStrategyProcessorChange = "activeStrategyProcessorChange",
-    /**
-     * Fired when the callback to decide if a strategy is available or not changes.
-     * @ignore - do not document.
-     */
     strategyAvailabilityChange = "strategyAvailabilityChange",
-    /**
-     * Fired when the sort model changes.
-     */
     sortModelChange = "sortModelChange",
-    /**
-     * Fired when the filter model changes.
-     */
     filterModelChange = "filterModelChange",
-    /**
-     * Fired when the column visibility model changes.
-     */
     columnVisibilityModelChange = "columnVisibilityModelChange",
-    /**
-     * Fired when the state of the grid is updated.
-     */
     stateChange = "stateChange",
-    /**
-     * Fired when a column visibility changes.
-     * It is not fired when the `columnVisibilityModel` is controlled or initialized.
-     * It is not fired when toggling all column's visibility at once.
-     * @deprecated Use `GridEvents.columnVisibilityModelChange` instead.
-     */
     columnVisibilityChange = "columnVisibilityChange",
-    /**
-     * Fired when the content size used by the `GridVirtualScroller` changes.
-     * @ignore - do not document.
-     */
     virtualScrollerContentSizeChange = "virtualScrollerContentSizeChange",
-    /**
-     * Fired when the preferences panel is closed.
-     */
+    virtualScrollerWheel = "virtualScrollerWheel",
+    virtualScrollerTouchMove = "virtualScrollerTouchMove",
     preferencePanelClose = "preferencePanelClose",
-    /**
-     * Fired when the preferences panel is opened.
-     */
     preferencePanelOpen = "preferencePanelOpen"
 }
 export declare type GridEventsStr = keyof GridEventLookup;

package/models/events/gridEvents.js

@@ -20,6 +20,8 @@ var GridEvents;
   GridEvents["cellEditCommit"] = "cellEditCommit";
   GridEvents["cellEditStart"] = "cellEditStart";
   GridEvents["cellEditStop"] = "cellEditStop";
+  GridEvents["cellModesModelChange"] = "cellModesModelChange";
+  GridEvents["rowModesModelChange"] = "rowModesModelChange";
   GridEvents["rowEditStart"] = "rowEditStart";
   GridEvents["rowEditStop"] = "rowEditStop";
   GridEvents["rowEditCommit"] = "rowEditCommit";
@@ -29,6 +31,9 @@ var GridEvents;
   GridEvents["rowMouseEnter"] = "rowMouseEnter";
   GridEvents["rowMouseLeave"] = "rowMouseLeave";
   GridEvents["editRowsModelChange"] = "editRowsModelChange";
+  GridEvents["rowDragStart"] = "rowDragStart";
+  GridEvents["rowDragOver"] = "rowDragOver";
+  GridEvents["rowDragEnd"] = "rowDragEnd";
   GridEvents["columnHeaderBlur"] = "columnHeaderBlur";
   GridEvents["columnHeaderFocus"] = "columnHeaderFocus";
   GridEvents["columnHeaderNavigationKeyDown"] = "columnHeaderNavigationKeyDown";
@@ -57,14 +62,14 @@ var GridEvents;
   GridEvents["columnResizeStart"] = "columnResizeStart";
   GridEvents["columnResizeStop"] = "columnResizeStop";
   GridEvents["columnOrderChange"] = "columnOrderChange";
+  GridEvents["rowOrderChange"] = "rowOrderChange";
   GridEvents["rowsSet"] = "rowsSet";
   GridEvents["rowExpansionChange"] = "rowExpansionChange";
-  GridEvents["visibleRowsSet"] = "visibleRowsSet";
+  GridEvents["sortedRowsSet"] = "sortedRowsSet";
+  GridEvents["filteredRowsSet"] = "filteredRowsSet";
   GridEvents["columnsChange"] = "columnsChange";
   GridEvents["detailPanelsExpandedRowIdsChange"] = "detailPanelsExpandedRowIdsChange";
   GridEvents["pinnedColumnsChange"] = "pinnedColumnsChange";
-  GridEvents["pipeProcessorRegister"] = "pipeProcessorRegister";
-  GridEvents["pipeProcessorUnregister"] = "pipeProcessorUnregister";
   GridEvents["activeStrategyProcessorChange"] = "activeStrategyProcessorChange";
   GridEvents["strategyAvailabilityChange"] = "strategyAvailabilityChange";
   GridEvents["sortModelChange"] = "sortModelChange";
@@ -73,6 +78,8 @@ var GridEvents;
   GridEvents["stateChange"] = "stateChange";
   GridEvents["columnVisibilityChange"] = "columnVisibilityChange";
   GridEvents["virtualScrollerContentSizeChange"] = "virtualScrollerContentSizeChange";
+  GridEvents["virtualScrollerWheel"] = "virtualScrollerWheel";
+  GridEvents["virtualScrollerTouchMove"] = "virtualScrollerTouchMove";
   GridEvents["preferencePanelClose"] = "preferencePanelClose";
   GridEvents["preferencePanelOpen"] = "preferencePanelOpen";
 })(GridEvents || (GridEvents = {}));

package/models/gridColumnSpanning.d.ts

@@ -0,0 +1,12 @@
+export declare type GridColumnIndex = number;
+export declare type GridCellColSpanInfo = {
+    spannedByColSpan: true;
+    rightVisibleCellIndex: GridColumnIndex;
+    leftVisibleCellIndex: GridColumnIndex;
+} | {
+    spannedByColSpan: false;
+    cellProps: {
+        colSpan: number;
+        width: number;
+    };
+};

package/models/gridColumnSpanning.js

@@ -0,0 +1 @@
+export {};

package/models/gridEditRowModel.d.ts

@@ -1,5 +1,5 @@
 export interface GridEditCellProps<V = any> {
-    value: V | undefined;
+    value?: V | undefined;
     isValidating?: boolean;
     isProcessingProps?: boolean;
     [prop: string]: any;

package/models/gridExport.d.ts

@@ -17,16 +17,39 @@ export interface GridExportOptions {
      */
     allColumns?: boolean;
 }
-export interface GridCsvGetRowsToExportParams<Api extends GridApiCommon = GridApiCommunity> {
+/**
+ * The options applicable to any document export format (CSV and Excel).
+ */
+export interface GridFileExportOptions<Api extends GridApiCommon = GridApiCommunity> extends GridExportOptions {
+    /**
+     * The string used as the file name.
+     * @default `document.title`
+     */
+    fileName?: string;
+    /**
+     * If `true`, the first row of the file will include the headers of the grid.
+     * @default true
+     */
+    includeHeaders?: boolean;
+    /**
+     * Function that returns the id of the rows to export on the order they should be exported.
+     * @param {GridGetRowsToExportParams} params With all properties from [[GridGetRowsToExportParams]].
+     * @returns {GridRowId[]} The id of the rows to export.
+     */
+    getRowsToExport?: (params: GridGetRowsToExportParams<Api>) => GridRowId[];
+}
+export interface GridGetRowsToExportParams<Api extends GridApiCommon = GridApiCommunity> {
     /**
      * The API of the grid.
      */
     apiRef: React.MutableRefObject<Api>;
 }
+export interface GridCsvGetRowsToExportParams<Api extends GridApiCommon = GridApiCommunity> extends GridGetRowsToExportParams<Api> {
+}
 /**
  * The options to apply on the CSV export.
  */
-export interface GridCsvExportOptions extends GridExportOptions {
+export interface GridCsvExportOptions extends GridFileExportOptions {
     /**
      * The character used to separate fields.
      * @default ','
@@ -93,3 +116,7 @@ export interface GridPrintExportOptions extends GridExportOptions {
  * Available export formats.
  */
 export declare type GridExportFormat = 'csv' | 'print';
+/**
+ * Available export extensions.
+ */
+export declare type GridExportExtension = 'csv';

package/models/gridFilterModel.d.ts

@@ -13,4 +13,15 @@ export interface GridFilterModel {
      * @default `GridLinkOperator.Or`
      */
     linkOperator?: GridLinkOperator;
+    /**
+     * values used to quick filter rows
+     * @default `[]`
+     */
+    quickFilterValues?: any[];
+    /**
+     * - `GridLinkOperator.And`: the row must pass all the values.
+     * - `GridLinkOperator.Or`: the row must pass at least one value.
+     * @default `GridLinkOperator.And`
+     */
+    quickFilterLogicOperator?: GridLinkOperator;
 }

package/models/gridFilterOperator.d.ts

@@ -24,7 +24,7 @@ export interface GridFilterOperator<R extends GridValidRowModel = any, V = any,
      * This function can return `null` to skip filtering for this item and column.
      * @param {GridFilterItem} filterItem The filter item with which we want to filter the column.
      * @param {GridStateColDef} column The column from which we want to filter the rows.
-     * @returns {null | ((params: GridCellParams) => boolean)} The function to call to check if a row poss this filter item or not.
+     * @returns {null | ((params: GridCellParams) => boolean)} The function to call to check if a row pass this filter item or not.
      */
     getApplyFilterFn: (filterItem: GridFilterItem, column: GridStateColDef<R, V, F>) => null | ((params: GridCellParams<V, R, F>) => boolean);
     /**

package/models/gridIconSlotsComponent.d.ts

@@ -114,4 +114,9 @@ export interface GridIconSlotsComponent {
      * @default GridCloseIcon
      */
     FilterPanelDeleteIcon: React.JSXElementConstructor<any>;
+    /**
+     * Icon displayed on the `reorder` column type to reorder a row.
+     * @default GridDragIcon
+     */
+    RowReorderIcon: React.JSXElementConstructor<any>;
 }

package/models/gridStateCommunity.d.ts

@@ -1,6 +1,5 @@
 import type { GridColumnMenuState, GridColumnsInitialState, GridColumnsState, GridDensityState, GridFilterInitialState, GridFilterState, GridFocusState, GridPaginationInitialState, GridPaginationState, GridPreferencePanelInitialState, GridPreferencePanelState, GridRowsState, GridSortingInitialState, GridSortingState, GridTabIndexState } from '../hooks';
 import type { GridRowsMetaState } from '../hooks/features/rows/gridRowsMetaState';
-import type { GridRowsInternalCache } from '../hooks/features/rows/gridRowsState';
 import type { GridEditRowsModel } from './gridEditRowModel';
 import type { GridSelectionModel } from './gridSelectionModel';
 /**
@@ -8,7 +7,6 @@ import type { GridSelectionModel } from './gridSelectionModel';
  */
 export interface GridStateCommunity {
     rows: GridRowsState;
-    rowsCache: GridRowsInternalCache;
     rowsMeta: GridRowsMetaState;
     editRows: GridEditRowsModel;
     pagination: GridPaginationState;

package/models/index.d.ts

@@ -18,9 +18,9 @@ export * from './gridIconSlotsComponent';
 export * from './gridSlotsComponent';
 export * from './gridSlotsComponentsProps';
 export * from './gridDensity';
-export * from './gridExport';
 export * from './logger';
 export * from './muiEvent';
 export * from './events';
 export * from './gridSortModel';
+export type { GridExportOptions, GridFileExportOptions, GridGetRowsToExportParams, GridCsvGetRowsToExportParams, GridCsvExportOptions, GridPrintExportOptions, } from './gridExport';
 export * from './gridFilterOperator';

package/models/index.js

@@ -18,9 +18,10 @@ export * from './gridIconSlotsComponent';
 export * from './gridSlotsComponent';
 export * from './gridSlotsComponentsProps';
 export * from './gridDensity';
-export * from './gridExport';
 export * from './logger';
 export * from './muiEvent';
 export * from './events';
-export * from './gridSortModel';
-export * from './gridFilterOperator';
+export * from './gridSortModel'; // Do not export GridExportFormat and GridExportExtension which are override in pro package
+
+export * from './gridFilterOperator';
+export {};

package/models/params/gridCellParams.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="react" />
 import { GridCellMode } from '../gridCell';
 import { GridRowId, GridRowModel, GridRowTreeNodeConfig, GridValidRowModel } from '../gridRows';
 import type { GridStateColDef } from '../colDef/gridColDef';
@@ -17,11 +18,11 @@ export interface GridCellParams<V = any, R extends GridValidRowModel = any, F =
     /**
      * The cell value, but if the column has valueGetter, use getValue.
      */
-    value: V | undefined;
+    value?: V | undefined;
     /**
      * The cell value formatted with the column valueFormatter.
      */
-    formattedValue: F;
+    formattedValue?: F | undefined;
     /**
      * The row model of the row that the current cell belongs to.
      */
@@ -59,6 +60,9 @@ export interface GridCellParams<V = any, R extends GridValidRowModel = any, F =
      */
     getValue: (id: GridRowId, field: string) => any;
 }
+export interface FocusElement {
+    focus(): void;
+}
 /**
  * GridCellParams containing api.
  */
@@ -68,6 +72,12 @@ export interface GridRenderCellParams<V = any, R extends GridValidRowModel = any
      * @deprecated Use the `apiRef` returned by `useGridApiContext` or `useGridApiRef` (only available in `@mui/x-data-grid-pro`)
      */
     api: any;
+    /**
+     * A ref allowing to set imperative focus.
+     * It can be passed to the element that should receive focus.
+     * @ignore - do not document.
+     */
+    focusElementRef?: React.Ref<FocusElement>;
 }
 /**
  * GridEditCellProps containing api.

package/models/params/gridRowParams.d.ts

@@ -34,6 +34,11 @@ interface GridRowVisibilityParams {
      * Whether this row is the last visible or not.
      */
     isLastVisible: boolean;
+    /**
+     * Index of the row in the current page.
+     * If the pagination is disabled, it will be the index relative to all filtered rows.
+     */
+    indexRelativeToCurrentPage: number;
 }
 /**
  * Object passed as parameter in the row `getRowClassName` callback prop.