@mui/x-data-grid 5.5.1 → 5.7.0

package/models/gridRows.d.ts

@@ -0,0 +1,96 @@
+import type { GridKeyValue } from './colDef/gridColDef';
+export declare type GridRowsProp = Readonly<GridRowModel[]>;
+/**
+ * @deprecated prefer GridRowModel.
+ */
+export declare type GridRowData<T = {
+    [key: string]: any;
+}> = T;
+/**
+ * The key value object representing the data of a row.
+ */
+export declare type GridRowModel<T = {
+    [key: string]: any;
+}> = T;
+export declare type GridUpdateAction = 'delete';
+export interface GridRowModelUpdate extends GridRowModel {
+    _action?: GridUpdateAction;
+}
+export interface GridRowTreeNodeConfig {
+    /**
+     * The grid row id.
+     */
+    id: GridRowId;
+    /**
+     * The id of the row children.
+     * @default []
+     */
+    children?: GridRowId[];
+    /**
+     * The row id of the parent (null if this row is a top level row).
+     */
+    parent: GridRowId | null;
+    /**
+     * Current expansion status of the row.
+     * @default false
+     */
+    childrenExpanded?: boolean;
+    /**
+     * 0-based depth of the row in the tree.
+     */
+    depth: number;
+    /**
+     * The key used to group the children of this row.
+     */
+    groupingKey: GridKeyValue;
+    /**
+     * The field used to group the children of this row.
+     * Is `null` if no field has been used to group the children of this row.
+     */
+    groupingField: string | null;
+    /**
+     * If `true`, this node has been automatically added to fill a gap in the tree structure.
+     * @default false
+     */
+    isAutoGenerated?: boolean;
+}
+/**
+ * The grid rows total height and row positions.
+ */
+export interface GridRowsMeta {
+    /**
+     * The sum of all grid rows.
+     */
+    totalHeight: number;
+    /**
+     * The grid rows positions.
+     */
+    positions: number[];
+}
+export declare type GridRowTreeConfig = Record<GridRowId, GridRowTreeNodeConfig>;
+export declare type GridRowsLookup = Record<GridRowId, GridRowModel>;
+/**
+ * The type of Id supported by the grid.
+ */
+export declare type GridRowId = string | number;
+export interface GridRowEntry {
+    /**
+     * The row id.
+     */
+    id: GridRowId;
+    /**
+     * The row model.
+     */
+    model: GridRowModel;
+}
+/**
+ * The function to retrieve the id of a [[GridRowModel]].
+ */
+export declare type GridRowIdGetter = (row: GridRowModel) => GridRowId;
+/**
+ * An helper function to check if the id provided is valid.
+ * @param {GridRowId} id Id as [[GridRowId]].
+ * @param {GridRowModel | Partial<GridRowModel>} row Row as [[GridRowModel]].
+ * @param {string} detailErrorMessage A custom error message to display for invalid IDs
+ */
+export declare function checkGridRowIdIsValid(id: GridRowId, row: GridRowModel | Partial<GridRowModel>, detailErrorMessage?: string): void;

package/models/gridRows.js

@@ -0,0 +1,31 @@
+/**
+ * @deprecated prefer GridRowModel.
+ */
+
+/**
+ * The key value object representing the data of a row.
+ */
+
+/**
+ * The grid rows total height and row positions.
+ */
+
+/**
+ * The type of Id supported by the grid.
+ */
+
+/**
+ * The function to retrieve the id of a [[GridRowModel]].
+ */
+
+/**
+ * An helper function to check if the id provided is valid.
+ * @param {GridRowId} id Id as [[GridRowId]].
+ * @param {GridRowModel | Partial<GridRowModel>} row Row as [[GridRowModel]].
+ * @param {string} detailErrorMessage A custom error message to display for invalid IDs
+ */
+export function checkGridRowIdIsValid(id, row, detailErrorMessage = 'A row was provided without id in the rows prop:') {
+  if (id == null) {
+    throw new Error(['MUI: The data grid component requires all rows to have a unique `id` property.', 'Alternatively, you can use the `getRowId` prop to specify a custom id for each row.', detailErrorMessage, JSON.stringify(row)].join('\n'));
+  }
+}

package/models/gridSelectionModel.d.ts

@@ -0,0 +1,3 @@
+import { GridRowId } from './gridRows';
+export declare type GridInputSelectionModel = GridRowId[] | GridRowId;
+export declare type GridSelectionModel = GridRowId[];

package/models/gridSelectionModel.js

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

package/models/gridSlotsComponent.d.ts

@@ -0,0 +1,124 @@
+import * as React from 'react';
+import { GridIconSlotsComponent } from './gridIconSlotsComponent';
+/**
+ * Grid components React prop interface containing all the overridable components.
+ * TODO: Differentiate community and pro interface
+ */
+export interface GridSlotsComponent extends GridIconSlotsComponent {
+    /**
+     * The custom Checkbox component used in the grid for both header and cells.
+     * @default Checkbox
+     */
+    BaseCheckbox: React.JSXElementConstructor<any>;
+    /**
+     * The custom TextField component used in the grid.
+     * @default TextField
+     */
+    BaseTextField: React.JSXElementConstructor<any>;
+    /**
+     * The custom FormControl component used in the grid.
+     * @default FormControl
+     */
+    BaseFormControl: React.JSXElementConstructor<any>;
+    /**
+     * The custom Select component used in the grid.
+     * @default Select
+     */
+    BaseSelect: React.JSXElementConstructor<any>;
+    /**
+     * The custom Switch component used in the grid.
+     * @default Switch
+     */
+    BaseSwitch: React.JSXElementConstructor<any>;
+    /**
+     * The custom Button component used in the grid.
+     * @default Button
+     */
+    BaseButton: React.JSXElementConstructor<any>;
+    /**
+     * The custom Tooltip component used in the grid.
+     * @default Tooltip
+     */
+    BaseTooltip: React.JSXElementConstructor<any>;
+    /**
+     * The custom Popper component used in the grid.
+     * @default Popper
+     */
+    BasePopper: React.JSXElementConstructor<any>;
+    /**
+     * Component rendered for each cell.
+     * @default GridCell
+     */
+    Cell: React.JSXElementConstructor<any>;
+    /**
+     * Column menu component rendered by clicking on the 3 dots "kebab" icon in column headers.
+     * @default GridColumnMenu
+     */
+    ColumnMenu: React.JSXElementConstructor<any>;
+    /**
+     * Error overlay component rendered above the grid when an error is caught.
+     * @default ErrorOverlay
+     */
+    ErrorOverlay: React.JSXElementConstructor<any>;
+    /**
+     * Footer component rendered at the bottom of the grid viewport.
+     * @default GridFooter
+     */
+    Footer: React.JSXElementConstructor<any>;
+    /**
+     * Header component rendered above the grid column header bar.
+     * Prefer using the `Toolbar` slot. You should never need to use this slot.
+     * @default GridHeader
+     */
+    Header: React.JSXElementConstructor<any>;
+    /**
+     * Toolbar component rendered inside the Header component.
+     * @default null
+     */
+    Toolbar: React.JSXElementConstructor<any> | null;
+    /**
+     * PreferencesPanel component rendered inside the Header component.
+     * @default GridPreferencesPanel
+     */
+    PreferencesPanel: React.JSXElementConstructor<any>;
+    /**
+     * Loading overlay component rendered when the grid is in a loading state.
+     * @default GridLoadingOverlay
+     */
+    LoadingOverlay: React.JSXElementConstructor<any>;
+    /**
+     * No results overlay component rendered when the grid has no results after filtering.
+     * @default GridNoResultsOverlay
+     */
+    NoResultsOverlay: React.JSXElementConstructor<any>;
+    /**
+     * No rows overlay component rendered when the grid has no rows.
+     * @default GridNoRowsOverlay
+     */
+    NoRowsOverlay: React.JSXElementConstructor<any>;
+    /**
+     * Pagination component rendered in the grid footer by default.
+     * @default Pagination
+     */
+    Pagination: React.JSXElementConstructor<any> | null;
+    /**
+     * Filter panel component rendered when clicking the filter button.
+     * @default GridFilterPanel
+     */
+    FilterPanel: React.JSXElementConstructor<any>;
+    /**
+     * GridColumns panel component rendered when clicking the columns button.
+     * @default GridColumnsPanel
+     */
+    ColumnsPanel: React.JSXElementConstructor<any>;
+    /**
+     * Panel component wrapping the filters and columns panels.
+     * @default GridPanel
+     */
+    Panel: React.JSXElementConstructor<any>;
+    /**
+     * Component rendered for each row.
+     * @default GridRow
+     */
+    Row: React.JSXElementConstructor<any>;
+}

package/models/gridSlotsComponent.js

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

package/models/gridSlotsComponentsProps.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Overrideable components props dynamically passed to the component at rendering.
+ */
+export interface GridSlotsComponentsProps {
+    baseCheckbox?: any;
+    baseTextField?: any;
+    baseFormControl?: any;
+    baseSelect?: any;
+    baseSwitch?: any;
+    baseButton?: any;
+    basePopper?: any;
+    baseTooltip?: any;
+    cell?: any;
+    columnMenu?: any;
+    columnsPanel?: any;
+    errorOverlay?: any;
+    filterPanel?: any;
+    footer?: any;
+    header?: any;
+    loadingOverlay?: any;
+    noResultsOverlay?: any;
+    noRowsOverlay?: any;
+    pagination?: any;
+    panel?: any;
+    preferencesPanel?: any;
+    row?: any;
+    toolbar?: any;
+}

package/models/gridSlotsComponentsProps.js

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

package/models/gridSortModel.d.ts

@@ -0,0 +1,34 @@
+import { GridCellValue } from './gridCell';
+import { GridRowId, GridRowTreeNodeConfig } from './gridRows';
+export declare type GridSortDirection = 'asc' | 'desc' | null | undefined;
+export interface GridSortCellParams {
+    id: GridRowId;
+    field: string;
+    value: GridCellValue;
+    rowNode: GridRowTreeNodeConfig;
+    /**
+     * @deprecated Use the `apiRef` returned by `useGridApiContext` or `useGridApiRef` (only available in `@mui/x-data-grid-pro`)
+     */
+    api: any;
+}
+/**
+ * The type of the sort comparison function.
+ */
+export declare type GridComparatorFn = (v1: GridCellValue, v2: GridCellValue, cellParams1: GridSortCellParams, cellParams2: GridSortCellParams) => number;
+/**
+ * Object that represents the column sorted data, part of the [[GridSortModel]].
+ */
+export interface GridSortItem {
+    /**
+     * The column field identifier.
+     */
+    field: string;
+    /**
+     * The direction of the column that the grid should sort.
+     */
+    sort: GridSortDirection;
+}
+/**
+ * The model used for sorting the grid.
+ */
+export declare type GridSortModel = GridSortItem[];

package/models/gridSortModel.js

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

package/models/gridStateCommunity.d.ts

@@ -0,0 +1,35 @@
+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';
+/**
+ * The state of `DataGrid`.
+ */
+export interface GridStateCommunity {
+    rows: GridRowsState;
+    rowsCache: GridRowsInternalCache;
+    rowsMeta: GridRowsMetaState;
+    editRows: GridEditRowsModel;
+    pagination: GridPaginationState;
+    columns: GridColumnsState;
+    columnMenu: GridColumnMenuState;
+    sorting: GridSortingState;
+    focus: GridFocusState;
+    tabIndex: GridTabIndexState;
+    selection: GridSelectionModel;
+    filter: GridFilterState;
+    preferencePanel: GridPreferencePanelState;
+    density: GridDensityState;
+    error?: any;
+}
+/**
+ * The initial state of `DataGrid`.
+ */
+export interface GridInitialStateCommunity {
+    pagination?: GridPaginationInitialState;
+    sorting?: GridSortingInitialState;
+    filter?: GridFilterInitialState;
+    columns?: GridColumnsInitialState;
+    preferencePanel?: GridPreferencePanelInitialState;
+}

package/models/gridStateCommunity.js

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

package/models/index.d.ts

@@ -0,0 +1,26 @@
+export * from './colDef';
+export * from './cursorCoordinates';
+export * from './elementSize';
+export * from './gridEditRowModel';
+export * from './gridFeatureMode';
+export * from './gridFilterItem';
+export * from './gridFilterModel';
+export * from './gridFilterOperator';
+export * from './gridRootContainerRef';
+export * from './gridRenderContextProps';
+export * from './gridRows';
+export * from './gridSelectionModel';
+export * from './params';
+export * from './gridCellClass';
+export * from './gridCell';
+export * from './gridColumnHeaderClass';
+export * from './api';
+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';

package/models/index.js

@@ -0,0 +1,26 @@
+export * from './colDef';
+export * from './cursorCoordinates';
+export * from './elementSize';
+export * from './gridEditRowModel';
+export * from './gridFeatureMode';
+export * from './gridFilterItem';
+export * from './gridFilterModel';
+export * from './gridFilterOperator';
+export * from './gridRootContainerRef';
+export * from './gridRenderContextProps';
+export * from './gridRows';
+export * from './gridSelectionModel';
+export * from './params';
+export * from './gridCellClass';
+export * from './gridCell';
+export * from './gridColumnHeaderClass';
+export * from './api';
+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';

package/models/logger.d.ts

@@ -0,0 +1,6 @@
+export interface Logger {
+    debug: (...args: any[]) => void;
+    info: (...args: any[]) => void;
+    warn: (...args: any[]) => void;
+    error: (...args: any[]) => void;
+}

package/models/logger.js

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

package/models/muiEvent.d.ts

@@ -0,0 +1,5 @@
+import * as React from 'react';
+export declare type MuiBaseEvent = React.SyntheticEvent<HTMLElement> | DocumentEventMap[keyof DocumentEventMap] | {};
+export declare type MuiEvent<E extends MuiBaseEvent = MuiBaseEvent> = E & {
+    defaultMuiPrevented?: boolean;
+};

package/models/muiEvent.js

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

package/models/package.json

@@ -0,0 +1,6 @@
+{
+  "sideEffects": false,
+  "module": "./index.js",
+  "main": "../node/models/index.js",
+  "types": "./index.d.ts"
+}

package/models/params/gridCellParams.d.ts

@@ -0,0 +1,157 @@
+import { GridCellMode, GridCellValue } from '../gridCell';
+import { GridRowId, GridRowModel, GridRowTreeNodeConfig } from '../gridRows';
+import type { GridStateColDef } from '../colDef/gridColDef';
+import { GridEditCellProps } from '../gridEditRowModel';
+/**
+ * Object passed as parameter in the column [[GridColDef]] cell renderer.
+ */
+export interface GridCellParams<V = any, R = any, F = V> {
+    /**
+     * The grid row id.
+     */
+    id: GridRowId;
+    /**
+     * The column field of the cell that triggered the event.
+     */
+    field: string;
+    /**
+     * The cell value, but if the column has valueGetter, use getValue.
+     */
+    value: V;
+    /**
+     * The cell value formatted with the column valueFormatter.
+     */
+    formattedValue: F;
+    /**
+     * The row model of the row that the current cell belongs to.
+     */
+    row: GridRowModel<R>;
+    /**
+     * The node of the row that the current cell belongs to.
+     */
+    rowNode: GridRowTreeNodeConfig;
+    /**
+     * The column of the row that the current cell belongs to.
+     */
+    colDef: GridStateColDef;
+    /**
+     * If true, the cell is editable.
+     */
+    isEditable?: boolean;
+    /**
+     * The mode of the cell.
+     */
+    cellMode: GridCellMode;
+    /**
+     * If true, the cell is the active element.
+     */
+    hasFocus: boolean;
+    /**
+     * the tabIndex value.
+     */
+    tabIndex: 0 | -1;
+    /**
+     * Get the cell value of a row and field.
+     * @param {GridRowId} id The row id.
+     * @param {string} field The field.
+     * @returns {GridCellValue} The cell value.
+     * @deprecated Use `params.row` to directly access the fields you want instead.
+     */
+    getValue: (id: GridRowId, field: string) => GridCellValue;
+}
+/**
+ * GridCellParams containing api.
+ */
+export interface GridRenderCellParams<V = any, R = any, F = V> extends GridCellParams<V, R, F> {
+    /**
+     * GridApi that let you manipulate the grid.
+     * @deprecated Use the `apiRef` returned by `useGridApiContext` or `useGridApiRef` (only available in `@mui/x-data-grid-pro`)
+     */
+    api: any;
+}
+/**
+ * GridEditCellProps containing api.
+ */
+export interface GridRenderEditCellParams<V = any, R = any, F = V> extends GridCellParams<V, R, F>, GridEditCellProps<V> {
+    /**
+     * GridApi that let you manipulate the grid.
+     * @deprecated Use the `apiRef` returned by `useGridApiContext` or `useGridApiRef` (only available in `@mui/x-data-grid-pro`)
+     */
+    api: any;
+}
+/**
+ * Parameters passed to `colDef.valueGetter`.
+ */
+export interface GridValueGetterParams<V = any, R = any> extends Omit<GridCellParams<V, R, any>, 'formattedValue' | 'isEditable'> {
+    /**
+     * GridApi that let you manipulate the grid.
+     * @deprecated Use the `apiRef` returned by `useGridApiContext` or `useGridApiRef` (only available in `@mui/x-data-grid-pro`)
+     */
+    api: any;
+}
+/**
+ * @deprecated Use `GridValueGetterParams` instead.
+ */
+export declare type GridValueGetterFullParams<V = any, R = any> = GridValueGetterParams<V, R>;
+/**
+ * Object passed as parameter in the column [[GridColDef]] value setter callback.
+ */
+export interface GridValueSetterParams {
+    /**
+     * The new cell value.
+     */
+    value: GridCellValue;
+    /**
+     * The row that is being edited.
+     */
+    row: GridRowModel;
+}
+/**
+ * Object passed as parameter in the column [[GridColDef]] value formatter callback.
+ */
+export interface GridValueFormatterParams {
+    /**
+     * The grid row id.
+     * It is not available when the value formatter is called by the filter panel.
+     */
+    id?: GridRowId;
+    /**
+     * The column field of the cell that triggered the event.
+     */
+    field: string;
+    /**
+     * The cell value, if the column has valueGetter it is the value returned by it.
+     */
+    value: GridCellValue;
+    /**
+     * GridApi that let you manipulate the grid.
+     * @deprecated Use the `apiRef` returned by `useGridApiContext` or `useGridApiRef` (only available in `@mui/x-data-grid-pro`)
+     */
+    api: any;
+}
+/**
+ * Object passed as parameter in the column [[GridColDef]] edit cell props change callback.
+ */
+export interface GridPreProcessEditCellProps {
+    /**
+     * The grid row id.
+     */
+    id: GridRowId;
+    /**
+     * The row that is being edited.
+     */
+    row: GridRowModel;
+    /**
+     * The edit cell props.
+     */
+    props: GridEditCellProps;
+    /**
+     * Whether the new value is different from the stored value or not.
+     */
+    hasChanged?: boolean;
+    /**
+     * Object containing the props of the other fields.
+     * Only available for row editing and when using the new editing API.
+     */
+    otherFieldsProps?: Record<string, GridEditCellProps>;
+}

package/models/params/gridCellParams.js

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

package/models/params/gridColumnHeaderParams.d.ts

@@ -0,0 +1,14 @@
+import type { GridStateColDef } from '../colDef/gridColDef';
+/**
+ * Object passed as parameter in the column [[GridColDef]] header renderer.
+ */
+export interface GridColumnHeaderParams {
+    /**
+     * The column field of the column that triggered the event
+     */
+    field: string;
+    /**
+     * The column of the current header component.
+     */
+    colDef: GridStateColDef;
+}

package/models/params/gridColumnHeaderParams.js

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

package/models/params/gridColumnOrderChangeParams.d.ts

@@ -0,0 +1,26 @@
+import type { GridStateColDef } from '../colDef/gridColDef';
+/**
+ * Object passed as parameter of the column order change event.
+ */
+export interface GridColumnOrderChangeParams {
+    /**
+     * The HTMLElement column header element.
+     */
+    element?: HTMLElement | null;
+    /**
+     * The column field of the column that triggered the event.
+     */
+    field: string;
+    /**
+     * The column of the current header component.
+     */
+    colDef: GridStateColDef;
+    /**
+     * The target column index.
+     */
+    targetIndex: number;
+    /**
+     * The old column index.
+     */
+    oldIndex: number;
+}

package/models/params/gridColumnOrderChangeParams.js

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