@mui/x-data-grid 8.28.6 → 8.29.0

package/models/gridApiCaches.d.mts

@@ -0,0 +1,12 @@
+import type { GridRowsInternalCache } from "../hooks/features/rows/gridRowsInterfaces.mjs";
+import type { GridRowsMetaInternalCache } from "../hooks/features/rows/gridRowsMetaInterfaces.mjs";
+import type { GridColumnGroupingInternalCache } from "../hooks/features/columnGrouping/gridColumnGroupsInterfaces.mjs";
+import type { GridColDef } from "./colDef/index.mjs";
+export interface GridApiCaches {
+  columns: {
+    lastColumnsProp: readonly GridColDef[];
+  };
+  columnGrouping: GridColumnGroupingInternalCache;
+  rows: GridRowsInternalCache;
+  rowsMeta: GridRowsMetaInternalCache;
+}

package/models/gridCell.d.mts

@@ -0,0 +1,30 @@
+import type { GridColDef } from "./colDef/index.mjs";
+import type { GridRowId } from "./gridRows.mjs";
+/**
+ * The mode of the cell.
+ */
+export type GridCellMode = 'edit' | 'view';
+/**
+ * The mode of the row.
+ */
+export type GridRowMode = 'edit' | 'view';
+/**
+ * The coordinates of cell represented by their row and column indexes.
+ */
+export interface GridCellIndexCoordinates {
+  colIndex: number;
+  rowIndex: number;
+}
+/**
+ * The coordinates of a cell represented by their row ID and column field.
+ */
+export interface GridCellCoordinates {
+  id: GridRowId;
+  field: GridColDef['field'];
+}
+/**
+ * The coordinates of column header represented by their row and column indexes.
+ */
+export interface GridColumnHeaderIndexCoordinates {
+  colIndex: number;
+}

package/models/gridCellClass.d.mts

@@ -0,0 +1,12 @@
+import type { GridValidRowModel } from "./gridRows.mjs";
+import type { GridCellParams } from "./params/gridCellParams.mjs";
+/**
+ * A function used to process cellClassName params.
+ * @param {GridCellParams<R, V>} params The parameters of the cell.
+ * @returns {string} The class name to be added to the cell.
+ */
+export type GridCellClassFn<R extends GridValidRowModel = any, V = unknown> = (params: GridCellParams<R, V>) => string;
+/**
+ * The union type representing the [[GridColDef]] cell class type.
+ */
+export type GridCellClassNamePropType<R extends GridValidRowModel = any, V = unknown> = string | GridCellClassFn<R, V>;

package/models/gridColumnGrouping.d.mts

@@ -0,0 +1,43 @@
+import type { GridColDef } from "./colDef/index.mjs";
+import type { GridColumnGroupHeaderParams } from "./params/gridColumnGroupHeaderParams.mjs";
+export interface GridLeafColumn {
+  field: GridColDef['field'];
+}
+export type GridColumnNode = GridColumnGroup | GridLeafColumn;
+export declare function isLeaf(node: GridColumnNode): node is GridLeafColumn;
+/**
+ * A function used to process headerClassName params.
+ * @param {GridColumnGroupHeaderParams} params The parameters of the column group header.
+ * @returns {string} The class name to be added to the column group header cell.
+ */
+export type GridColumnGroupHeaderClassFn = (params: GridColumnGroupHeaderParams) => string;
+/**
+ * The union type representing the [[GridColDef]] column header class type.
+ */
+export type GridColumnGroupHeaderClassNamePropType = string | GridColumnGroupHeaderClassFn;
+export interface GridColumnGroup extends Pick<GridColDef, 'headerName' | 'description' | 'headerAlign'> {
+  /**
+   * A unique string identifying the group.
+   */
+  groupId: string;
+  /**
+   * The groups and columns included in this group.
+   */
+  children: GridColumnNode[];
+  /**
+   * If `true`, allows reordering columns outside of the group.
+   * @default false
+   */
+  freeReordering?: boolean;
+  /**
+   * Allows to render a component in the column group header cell.
+   * @param {GridColumnGroupHeaderParams} params Object containing parameters for the renderer.
+   * @returns {React.ReactNode} The element to be rendered.
+   */
+  renderHeaderGroup?: (params: GridColumnGroupHeaderParams) => React.ReactNode;
+  /**
+   * Class name that will be added in the column group header cell.
+   */
+  headerClassName?: GridColumnGroupHeaderClassNamePropType;
+}
+export type GridColumnGroupingModel = GridColumnGroup[];

package/models/gridColumnHeaderClass.d.mts

@@ -0,0 +1,11 @@
+import type { GridColumnHeaderParams } from "./params/gridColumnHeaderParams.mjs";
+/**
+ * A function used to process headerClassName params.
+ * @param {GridColumnHeaderParams} params The parameters of the column header.
+ * @returns {string} The class name to be added to the column header cell.
+ */
+export type GridColumnHeaderClassFn = (params: GridColumnHeaderParams) => string;
+/**
+ * The union type representing the [[GridColDef]] column header class type.
+ */
+export type GridColumnHeaderClassNamePropType = string | GridColumnHeaderClassFn;

package/models/gridDataSource.d.mts

@@ -0,0 +1,83 @@
+import type { GridSortModel, GridFilterModel, GridRowModel, GridPaginationModel, GridRowId } from "./index.mjs";
+export interface GridGetRowsParams {
+  sortModel: GridSortModel;
+  filterModel: GridFilterModel;
+  /**
+   * Alternate to `start` and `end`, maps to `GridPaginationModel` interface.
+   */
+  paginationModel?: GridPaginationModel;
+  /**
+   * First row index to fetch (number) or cursor information (number | string).
+   */
+  start: number | string;
+  /**
+   * Last row index to fetch.
+   */
+  end: number;
+}
+export interface GridGetRowsOptions {
+  /**
+   * If `true`, bypasses the cache and forces a refetch of the rows from the server.
+   * The response will be used to refresh the cache.
+   */
+  skipCache?: boolean;
+  /**
+   * By default, the grid tries to keep the children expanded and attached to the parent with the same ID after the data is re-fetched.
+   * If `keepChildrenExpanded` is `false`, the children of the parent with the `parentId` (all children for the root level data fetch) will be collapsed and removed from the tree.
+   * @default true
+   */
+  keepChildrenExpanded?: boolean;
+}
+export interface GridUpdateRowParams {
+  rowId: GridRowId;
+  updatedRow: GridRowModel;
+  previousRow: GridRowModel;
+}
+export interface GridGetRowsResponse {
+  rows: GridRowModel[];
+  /**
+   * To reflect updates in total `rowCount` (optional).
+   * Useful when the `rowCount` is inaccurate (for example when filtering) or not available upfront.
+   */
+  rowCount?: number;
+  /**
+   * Additional `pageInfo` for advanced use-cases.
+   * `hasNextPage`: When row count is unknown/estimated, `hasNextPage` will be used to check if more records are available on server.
+   */
+  pageInfo?: {
+    hasNextPage?: boolean;
+    nextCursor?: string;
+  };
+}
+export interface GridDataSource {
+  /**
+   * This method will be called when the grid needs to fetch some rows.
+   * @param {GridGetRowsParams} params The parameters required to fetch the rows.
+   * @returns {Promise<GridGetRowsResponse>} A promise that resolves to the data of type [GridGetRowsResponse].
+   */
+  getRows(params: GridGetRowsParams): Promise<GridGetRowsResponse>;
+  /**
+   * This method will be called when the user updates a row.
+   * @param {GridUpdateRowParams} params The parameters required to update the row.
+   * @returns {Promise<any>} If resolved (synced on the backend), the grid will update the row and mutate the cache.
+   */
+  updateRow?(params: GridUpdateRowParams): Promise<any>;
+}
+export interface GridDataSourceCache {
+  /**
+   * Set the cache entry for the given key.
+   * @param {GridGetRowsParams} key The key of type `GridGetRowsParams`.
+   * @param {GridGetRowsResponse} value The value to be stored in the cache.
+   */
+  set: (key: GridGetRowsParams, value: GridGetRowsResponse) => void;
+  /**
+   * Get the cache entry for the given key.
+   * @param {GridGetRowsParams} key The key of type `GridGetRowsParams`.
+   * @returns {GridGetRowsResponse} The value stored in the cache.
+   */
+  get: (key: GridGetRowsParams) => GridGetRowsResponse | undefined;
+  /**
+   * Clear the cache.
+   */
+  clear: () => void;
+}

package/models/gridEditRowModel.d.mts

@@ -0,0 +1,28 @@
+import type { GridEditCellMeta } from "./api/gridEditingApi.mjs";
+export interface GridEditCellProps<V = any> {
+  value?: V | undefined;
+  isValidating?: boolean;
+  isProcessingProps?: boolean;
+  changeReason?: GridEditCellMeta['changeReason'];
+  [prop: string]: any;
+}
+export type GridEditRowProps = {
+  [field: string]: GridEditCellProps;
+};
+export type GridEditingState = {
+  [rowId: string]: GridEditRowProps;
+};
+export type GridEditMode = 'cell' | 'row';
+declare enum GridEditModes {
+  Cell = "cell",
+  Row = "row",
+}
+declare enum GridCellModes {
+  Edit = "edit",
+  View = "view",
+}
+declare enum GridRowModes {
+  Edit = "edit",
+  View = "view",
+}
+export { GridEditModes, GridCellModes, GridRowModes };

package/models/gridExport.d.mts

@@ -0,0 +1,157 @@
+import type { RefObject } from '@mui/x-internals/types';
+import type { GridRowId } from "./gridRows.mjs";
+import type { GridApiCommon } from "./api/index.mjs";
+import type { GridApiCommunity } from "./api/gridApiCommunity.mjs";
+/**
+ * The options applicable to any export format.
+ */
+export interface GridExportOptions {
+  /**
+   * The columns exported.
+   * This should only be used if you want to restrict the columns exports.
+   */
+  fields?: string[];
+  /**
+   * If `true`, the hidden columns will also be exported.
+   * @default false
+   */
+  allColumns?: boolean;
+}
+/**
+ * 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 list of row ids to export on the order they should be exported.
+   * @param {GridGetRowsToExportParams} params With all properties from [[GridGetRowsToExportParams]].
+   * @returns {GridRowId[]} The list of row ids to export.
+   */
+  getRowsToExport?: (params: GridGetRowsToExportParams<Api>) => GridRowId[];
+  /**
+   * If `false`, the formulas in the cells will not be escaped.
+   * It is not recommended to disable this option as it exposes the user to potential CSV injection attacks.
+   * See https://owasp.org/www-community/attacks/CSV_Injection for more information.
+   * @default true
+   */
+  escapeFormulas?: boolean;
+}
+export interface GridGetRowsToExportParams<Api extends GridApiCommon = GridApiCommunity> {
+  /**
+   * The API of the grid.
+   */
+  apiRef: RefObject<Api>;
+}
+export interface GridCsvGetRowsToExportParams<Api extends GridApiCommon = GridApiCommunity> extends GridGetRowsToExportParams<Api> {}
+export interface GridPrintGetRowsToExportParams<Api extends GridApiCommon = GridApiCommunity> extends GridGetRowsToExportParams<Api> {}
+/**
+ * The options to apply on the CSV export.
+ * @demos
+ *   - [CSV export](/x/react-data-grid/export/#csv-export)
+ */
+export interface GridCsvExportOptions extends GridFileExportOptions {
+  /**
+   * The character used to separate fields.
+   * @default ','
+   */
+  delimiter?: string;
+  /**
+   * The string used as the file name.
+   * @default document.title
+   */
+  fileName?: string;
+  /**
+   * If `true`, the UTF-8 Byte Order Mark (BOM) prefixes the exported file.
+   * This can allow Excel to automatically detect file encoding as UTF-8.
+   * @default false
+   */
+  utf8WithBom?: boolean;
+  /**
+   * If `true`, the CSV will include the column headers and column groups.
+   * Use `includeColumnGroupsHeaders` to control whether the column groups are included.
+   * @default true
+   */
+  includeHeaders?: boolean;
+  /**
+   * If `true`, the CSV will include the column groups.
+   * @see See {@link https://mui.com/x/react-data-grid/column-groups/ column groups docs} for more details.
+   * @default true
+   */
+  includeColumnGroupsHeaders?: boolean;
+  /**
+   * Function that returns the list of row ids to export on the order they should be exported.
+   * @param {GridCsvGetRowsToExportParams} params With all properties from [[GridCsvGetRowsToExportParams]].
+   * @returns {GridRowId[]} The list of row ids to export.
+   */
+  getRowsToExport?: (params: GridCsvGetRowsToExportParams) => GridRowId[];
+  /**
+   * @ignore
+   * If `false`, the quotes will not be appended to the cell value.
+   * @default true
+   */
+  shouldAppendQuotes?: boolean;
+}
+/**
+ * The options to apply on the Print export.
+ * @demos
+ *   - [Print export](/x/react-data-grid/export/#print-export)
+ */
+export interface GridPrintExportOptions extends GridExportOptions {
+  /**
+   * The value to be used as the print window title.
+   * @default The title of the page.
+   */
+  fileName?: string;
+  /**
+   * If `true`, the toolbar is removed for when printing.
+   * @default false
+   */
+  hideToolbar?: boolean;
+  /**
+   * If `true`, the footer is removed for when printing.
+   * @default false
+   */
+  hideFooter?: boolean;
+  /**
+   * If `true`, the selection checkboxes will be included when printing.
+   * @default false
+   */
+  includeCheckboxes?: boolean;
+  /**
+   * If `false`, all <style> and <link type="stylesheet" /> tags from the <head> will not be copied
+   * to the print window.
+   * @default true
+   */
+  copyStyles?: boolean;
+  /**
+   * One or more classes passed to the print window.
+   */
+  bodyClassName?: string;
+  /**
+   * Provide Print specific styles to the print window.
+   */
+  pageStyle?: string | (() => string);
+  /**
+   * Function that returns the list of row ids to export in the order they should be exported.
+   * @param {GridPrintGetRowsToExportParams} params With all properties from [[GridPrintGetRowsToExportParams]].
+   * @returns {GridRowId[]} The list of row ids to export.
+   */
+  getRowsToExport?: (params: GridPrintGetRowsToExportParams) => GridRowId[];
+}
+/**
+ * Available export formats.
+ */
+export type GridExportFormat = 'csv' | 'print';
+/**
+ * Available export extensions.
+ */
+export type GridExportExtension = 'csv';

package/models/gridFilterInputComponent.d.mts

@@ -0,0 +1,32 @@
+import type * as React from 'react';
+import type { RefObject } from '@mui/x-internals/types';
+import type { GridFilterItem } from "./gridFilterItem.mjs";
+import type { GridApiCommon } from "./api/gridApiCommon.mjs";
+import type { GridApiCommunity } from "./api/gridApiCommunity.mjs";
+export type GridFilterInputSlotProps = {
+  size?: 'small' | 'medium';
+  label?: React.ReactNode;
+  placeholder?: string;
+};
+export type GridFilterInputValueProps<T extends GridFilterInputSlotProps = GridFilterInputSlotProps, Api extends GridApiCommon = GridApiCommunity> = {
+  item: GridFilterItem;
+  applyValue: (value: GridFilterItem) => void;
+  apiRef: RefObject<Api>;
+  inputRef?: React.Ref<HTMLElement | null>;
+  focusElementRef?: React.Ref<any>;
+  headerFilterMenu?: React.ReactNode;
+  clearButton?: React.ReactNode | null;
+  /**
+   * It is `true` if the filter either has a value or an operator with no value
+   * required is selected (for example `isEmpty`)
+   */
+  isFilterActive?: boolean;
+  onFocus?: React.FocusEventHandler;
+  onBlur?: React.FocusEventHandler;
+  tabIndex?: number;
+  disabled?: boolean;
+  className?: string;
+  slotProps?: {
+    root: T;
+  };
+};

package/models/gridFilterItem.d.mts

@@ -0,0 +1,32 @@
+import type { GridBaseColDef } from "./colDef/gridColDef.mjs";
+/**
+ * Filter item definition interface.
+ * @demos
+ *   - [Custom filter operator](/x/react-data-grid/filtering/customization/#create-a-custom-operator)
+ */
+export interface GridFilterItem {
+  /**
+   * Must be unique.
+   * Only useful when the model contains several items.
+   */
+  id?: number | string;
+  /**
+   * The column from which we want to filter the rows.
+   */
+  field: GridBaseColDef['field'];
+  /**
+   * The filtering value.
+   * The operator filtering function will decide for each row if the row values is correct compared to this value.
+   */
+  value?: any;
+  /**
+   * The name of the operator we want to apply.
+   * A custom operator is supported by providing any string value.
+   */
+  operator: 'contains' | 'doesNotContain' | 'equals' | 'doesNotEqual' | 'startsWith' | 'endsWith' | '=' | '!=' | '>' | '>=' | '<' | '<=' | 'is' | 'not' | 'after' | 'onOrAfter' | 'before' | 'onOrBefore' | 'isEmpty' | 'isNotEmpty' | 'isAnyOf' | (string & {});
+}
+declare enum GridLogicOperator {
+  And = "and",
+  Or = "or",
+}
+export { GridLogicOperator };

package/models/gridFilterModel.d.mts

@@ -0,0 +1,34 @@
+import type { GridFilterItem, GridLogicOperator } from "./gridFilterItem.mjs";
+/**
+ * Model describing the filters to apply to the grid.
+ * @demos
+ *   - [Pass filters to the grid](/x/react-data-grid/filtering/#pass-filters-to-the-data-grid)
+ */
+export interface GridFilterModel {
+  /**
+   * @default []
+   */
+  items: GridFilterItem[];
+  /**
+   * - `GridLogicOperator.And`: the row must pass all the filter items.
+   * - `GridLogicOperator.Or`: the row must pass at least on filter item.
+   * @default GridLogicOperator.And
+   */
+  logicOperator?: GridLogicOperator;
+  /**
+   * values used to quick filter rows
+   * @default []
+   */
+  quickFilterValues?: any[];
+  /**
+   * - `GridLogicOperator.And`: the row must pass all the values.
+   * - `GridLogicOperator.Or`: the row must pass at least one value.
+   * @default GridLogicOperator.And
+   */
+  quickFilterLogicOperator?: GridLogicOperator;
+  /**
+   * If `false`, the quick filter will also consider cell values from hidden columns.
+   * @default true
+   */
+  quickFilterExcludeHiddenColumns?: boolean;
+}

package/models/gridFilterOperator.d.mts

@@ -0,0 +1,58 @@
+import type * as React from 'react';
+import type { RefObject } from '@mui/x-internals/types';
+import type { GridFilterItem } from "./gridFilterItem.mjs";
+import type { GridColDef } from "./colDef/gridColDef.mjs";
+import type { GridValidRowModel } from "./gridRows.mjs";
+import type { GridApiCommunity } from "./api/gridApiCommunity.mjs";
+import type { GridFilterInputValueProps } from "./gridFilterInputComponent.mjs";
+type ApplyFilterFn<R extends GridValidRowModel = any, V = any, F = V> = (value: V, row: R, column: GridColDef<R, V, F>, apiRef: RefObject<GridApiCommunity>) => boolean;
+export type GetApplyFilterFn<R extends GridValidRowModel = any, V = any, F = V> = (filterItem: GridFilterItem, column: GridColDef<R, V, F>) => null | ApplyFilterFn<R, V, F>;
+/**
+ * Filter operator definition interface.
+ * @demos
+ *   - [Custom filter operator](/x/react-data-grid/filtering/customization/#create-a-custom-operator)
+ */
+export interface GridFilterOperator<R extends GridValidRowModel = any, V = any, F = V, I extends GridFilterInputValueProps<any> = GridFilterInputValueProps> {
+  /**
+   * The label of the filter operator.
+   */
+  label?: string;
+  /**
+   * The label of the filter shown in header filter row.
+   */
+  headerLabel?: string;
+  /**
+   * The name of the filter operator.
+   * It will be matched with the `operator` property of the filter items.
+   */
+  value: GridFilterItem['operator'];
+  /**
+   * The callback that generates a filtering function for a given filter item and column.
+   * 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 {GridColDef} column The column from which we want to filter the rows.
+   * @returns {null | ApplyFilterFn} The function to call to check if a row pass this filter item or not.
+   */
+  getApplyFilterFn: GetApplyFilterFn<R, V, F>;
+  /**
+   * The input component to render in the filter panel for this filter operator.
+   */
+  InputComponent?: React.JSXElementConstructor<I>;
+  /**
+   * The props to pass to the input component in the filter panel for this filter operator.
+   */
+  InputComponentProps?: Partial<I>;
+  /**
+   * Converts the value of a filter item to a human-readable form.
+   * @param {GridFilterItem['value']} value The filter item value.
+   * @returns {string} The value formatted to be displayed in the UI of filter button tooltip.
+   */
+  getValueAsString?: (value: GridFilterItem['value']) => string;
+  /**
+   * If `false`, filter operator doesn't require user-entered value to work.
+   * Usually should be set to `false` for filter operators that don't have `InputComponent` (for example `isEmpty`)
+   * @default true
+   */
+  requiresFilterValue?: boolean;
+}
+export {};

package/models/gridHeaderFilteringModel.d.mts

@@ -0,0 +1,6 @@
+import type { GridColDef } from "./colDef/index.mjs";
+export type GridHeaderFilteringState = {
+  enabled: boolean;
+  editing: GridColDef['field'] | null;
+  menuOpen: GridColDef['field'] | null;
+};