@mui/x-data-grid 5.10.0 → 5.12.0

package/models/api/gridLocaleTextApi.d.ts

@@ -19,10 +19,14 @@ export interface GridLocaleText {
     toolbarFiltersTooltipHide: React.ReactNode;
     toolbarFiltersTooltipShow: React.ReactNode;
     toolbarFiltersTooltipActive: (count: number) => React.ReactNode;
+    toolbarQuickFilterPlaceholder: string;
+    toolbarQuickFilterLabel: string;
+    toolbarQuickFilterDeleteIconLabel: string;
     toolbarExport: React.ReactNode;
     toolbarExportLabel: string;
     toolbarExportCSV: React.ReactNode;
     toolbarExportPrint: React.ReactNode;
+    toolbarExportExcel: string;
     columnsPanelTextFieldLabel: string;
     columnsPanelTextFieldPlaceholder: string;
     columnsPanelDragIconLabel: string;

package/models/api/gridRowApi.d.ts

@@ -1,4 +1,25 @@
 import { GridRowModel, GridRowId, GridRowModelUpdate, GridRowTreeNodeConfig, GridValidRowModel } from '../gridRows';
+export interface GridRowGroupChildrenGetterParams {
+    /**
+     * The row id of the group
+     */
+    groupId: GridRowId;
+    /**
+     * If `true`, the method will not return the generated rows generated by the grid (aggregation footers, groups, ...)
+     * @default true
+     */
+    skipAutoGeneratedRows?: boolean;
+    /**
+     * If `true`, the method will only return the rows that are matching the current filters
+     * @default false
+     */
+    applyFiltering?: boolean;
+    /**
+     * If `true`, the method will order the returned rows according to the current sorting rules
+     * @default false
+     */
+    applySorting?: boolean;
+}
 /**
  * The Row API interface that is available in the grid `apiRef`.
  */
@@ -58,4 +79,11 @@ export interface GridRowApi {
      * @returns {number} The index of the row.
      */
     getRowIndexRelativeToVisibleRows: (id: GridRowId) => number;
+    /**
+     * Gets the rows of a grouping criteria.
+     * Only contains the rows provided to the grid, not the rows automatically generated by it.
+     * @param {GridRowGroupChildrenParams} params Object containing parameters for the getter.
+     * @returns {GridRowId[]} The id of each row in the grouping criteria.
+     */
+    getRowGroupChildren: (params: GridRowGroupChildrenGetterParams) => GridRowId[];
 }

package/models/api/gridRowsMetaApi.d.ts

@@ -24,4 +24,28 @@ export interface GridRowsMetaApi {
      * @ignore - do not document.
      */
     unstable_setRowHeight: (id: GridRowId, height: number) => void;
+    /**
+     * Stores the row height measurement and triggers an hydration, if needed.
+     * @param {GridRowId} id The id of the row.
+     * @param {number} height The new height.
+     * @ignore - do not document.
+     */
+    unstable_storeRowHeightMeasurement: (id: GridRowId, height: number) => void;
+    /**
+     * Determines if the height of a row is "auto".
+     * @ignore - do not document.
+     */
+    unstable_rowHasAutoHeight: (id: GridRowId) => boolean;
+    /**
+     * Returns the index of the last row measured.
+     * The value considers only the rows reachable by scroll, e.g. first row has index=0 in all pages.
+     * @ignore - do not document.
+     */
+    unstable_getLastMeasuredRowIndex: () => number;
+    /**
+     * Updates the index of the last row measured.
+     * @param {number} index The row index.
+     * @ignore - do not document.
+     */
+    unstable_setLastMeasuredRowIndex: (index: number) => void;
 }

package/models/api/index.d.ts

@@ -21,5 +21,5 @@ export * from './gridCallbackDetails';
 export * from './gridScrollApi';
 export * from './gridVirtualScrollerApi';
 export * from './gridApiCommon';
-export type { GridEditingApi, GridOldEditingApi, GridNewEditingApi } from './gridEditingApi';
+export type { GridEditingApi, GridOldEditingApi, GridNewEditingApi, GridCellModesModel, GridRowModesModel, } from './gridEditingApi';
 export declare type GridEditRowApi = GridEditingApi;

package/models/colDef/gridColDef.d.ts

@@ -11,6 +11,7 @@ import { GridValueOptionsParams } from '../params/gridValueOptionsParams';
 import { GridActionsCellItemProps } from '../../components/cell/GridActionsCellItem';
 import { GridEditCellProps } from '../gridEditRowModel';
 import type { GridValidRowModel } from '../gridRows';
+import { GridApiCommunity } from '../api/gridApiCommunity';
 /**
  * Alignment used in position elements in Cells.
  */
@@ -90,12 +91,15 @@ export interface GridColDef<R extends GridValidRowModel = any, V = any, F = V> {
     editable?: boolean;
     /**
      * If `true`, the rows can be grouped based on this column values (pro-plan only).
+     * Only available in DataGridPremium.
+     * TODO: Use module augmentation to move it to `@mui/x-data-grid-premium` (need to modify how we handle column types default values).
      * @default true
      */
     groupable?: boolean;
     /**
      * If `false`, the menu items for column pinning menu will not be rendered.
      * Only available in DataGridPro.
+     * TODO: Use module augmentation to move it to `@mui/x-data-grid-pro` (need to modify how we handle column types default values).
      * @default true
      */
     pinnable?: boolean;
@@ -204,6 +208,15 @@ export interface GridColDef<R extends GridValidRowModel = any, V = any, F = V> {
      * Allows setting the filter operators for this column.
      */
     filterOperators?: GridFilterOperator<R, V, F>[];
+    /**
+     * The callback that generates a filtering function for a given quick filter value.
+     * This function can return `null` to skip filtering for this value and column.
+     * @param {any} value The value with which we want to filter the column.
+     * @param {GridStateColDef} colDef The column from which we want to filter the rows.
+     * @param {React.MutableRefObject<GridApiCommunity>} apiRef Deprecated: The API of the grid.
+     * @returns {null | ((params: GridCellParams) => boolean)} The function to call to check if a row pass this filter value or not.
+     */
+    getApplyQuickFilterFn?: (value: any, colDef: GridStateColDef, apiRef: React.MutableRefObject<GridApiCommunity>) => null | ((params: GridCellParams<V, R, F>) => boolean);
     /**
      * If `true`, this column cannot be reordered.
      * @default false
@@ -220,7 +233,7 @@ export interface GridColDef<R extends GridValidRowModel = any, V = any, F = V> {
      */
     colSpan?: number | ((params: GridCellParams<V, R, F>) => number | undefined);
 }
-export interface GridActionsColDef extends GridColDef {
+export interface GridActionsColDef<R extends GridValidRowModel = any, V = any, F = V> extends GridColDef<R, V, F> {
     /**
      * Type allows to merge this object with a default definition [[GridColDef]].
      * @default 'actions'
@@ -231,9 +244,9 @@ export interface GridActionsColDef extends GridColDef {
      * @param {GridRowParams} params The params for each row.
      * @returns {React.ReactElement<GridActionsCellItemProps>[]} An array of [[GridActionsCell]] elements.
      */
-    getActions: (params: GridRowParams) => React.ReactElement<GridActionsCellItemProps>[];
+    getActions: (params: GridRowParams<R>) => React.ReactElement<GridActionsCellItemProps>[];
 }
-export declare type GridEnrichedColDef<R extends GridValidRowModel = any, V = any, F = V> = GridColDef<R, V, F> | GridActionsColDef;
+export declare type GridEnrichedColDef<R extends GridValidRowModel = any, V = any, F = V> = GridColDef<R, V, F> | GridActionsColDef<R, V, F>;
 export declare type GridColumns<R extends GridValidRowModel = any> = GridEnrichedColDef<R>[];
 export declare type GridColTypeDef<V = any, F = V> = Omit<GridColDef<V, any, F>, 'field'> & {
     extendType?: GridNativeColTypes;