@mui/x-data-grid 5.4.0 → 5.6.0

package/models/events/gridEvents.d.ts

@@ -0,0 +1,321 @@
+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.
+     */
+    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.
+     */
+    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.
+     */
+    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.
+     */
+    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.
+     */
+    preProcessorRegister = "preProcessorRegister",
+    /**
+     * Fired when a pre-processor is unregistered.
+     * @ignore - do not document.
+     */
+    preProcessorUnregister = "preProcessorUnregister",
+    /**
+     * Fired when the row grouping function is changed
+     * @ignore - do not document.
+     */
+    rowGroupsPreProcessingChange = "rowGroupsPreProcessingChange",
+    /**
+     * 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"
+}
+export declare type GridEventsStr = keyof GridEventLookup;
+export { GridEvents };

package/models/events/gridEvents.js

@@ -0,0 +1,77 @@
+var GridEvents;
+
+(function (GridEvents) {
+  GridEvents["resize"] = "resize";
+  GridEvents["debouncedResize"] = "debouncedResize";
+  GridEvents["viewportInnerSizeChange"] = "viewportInnerSizeChange";
+  GridEvents["componentError"] = "componentError";
+  GridEvents["unmount"] = "unmount";
+  GridEvents["cellModeChange"] = "cellModeChange";
+  GridEvents["cellClick"] = "cellClick";
+  GridEvents["cellDoubleClick"] = "cellDoubleClick";
+  GridEvents["cellMouseDown"] = "cellMouseDown";
+  GridEvents["cellMouseUp"] = "cellMouseUp";
+  GridEvents["cellKeyDown"] = "cellKeyDown";
+  GridEvents["cellFocusIn"] = "cellFocusIn";
+  GridEvents["cellFocusOut"] = "cellFocusOut";
+  GridEvents["cellDragEnter"] = "cellDragEnter";
+  GridEvents["cellDragOver"] = "cellDragOver";
+  GridEvents["editCellPropsChange"] = "editCellPropsChange";
+  GridEvents["cellEditCommit"] = "cellEditCommit";
+  GridEvents["cellEditStart"] = "cellEditStart";
+  GridEvents["cellEditStop"] = "cellEditStop";
+  GridEvents["rowEditStart"] = "rowEditStart";
+  GridEvents["rowEditStop"] = "rowEditStop";
+  GridEvents["rowEditCommit"] = "rowEditCommit";
+  GridEvents["cellNavigationKeyDown"] = "cellNavigationKeyDown";
+  GridEvents["rowClick"] = "rowClick";
+  GridEvents["rowDoubleClick"] = "rowDoubleClick";
+  GridEvents["rowMouseEnter"] = "rowMouseEnter";
+  GridEvents["rowMouseLeave"] = "rowMouseLeave";
+  GridEvents["editRowsModelChange"] = "editRowsModelChange";
+  GridEvents["columnHeaderBlur"] = "columnHeaderBlur";
+  GridEvents["columnHeaderFocus"] = "columnHeaderFocus";
+  GridEvents["columnHeaderNavigationKeyDown"] = "columnHeaderNavigationKeyDown";
+  GridEvents["columnHeaderKeyDown"] = "columnHeaderKeyDown";
+  GridEvents["columnHeaderClick"] = "columnHeaderClick";
+  GridEvents["columnHeaderDoubleClick"] = "columnHeaderDoubleClick";
+  GridEvents["columnHeaderOver"] = "columnHeaderOver";
+  GridEvents["columnHeaderOut"] = "columnHeaderOut";
+  GridEvents["columnHeaderEnter"] = "columnHeaderEnter";
+  GridEvents["columnHeaderLeave"] = "columnHeaderLeave";
+  GridEvents["columnHeaderDragStart"] = "columnHeaderDragStart";
+  GridEvents["columnHeaderDragOver"] = "columnHeaderDragOver";
+  GridEvents["columnHeaderDragEnter"] = "columnHeaderDragEnter";
+  GridEvents["columnHeaderDragEnd"] = "columnHeaderDragEnd";
+  GridEvents["selectionChange"] = "selectionChange";
+  GridEvents["headerSelectionCheckboxChange"] = "headerSelectionCheckboxChange";
+  GridEvents["rowSelectionCheckboxChange"] = "rowSelectionCheckboxChange";
+  GridEvents["pageChange"] = "pageChange";
+  GridEvents["pageSizeChange"] = "pageSizeChange";
+  GridEvents["rowGroupingModelChange"] = "rowGroupingModelChange";
+  GridEvents["rowsScroll"] = "rowsScroll";
+  GridEvents["rowsScrollEnd"] = "rowsScrollEnd";
+  GridEvents["columnSeparatorMouseDown"] = "columnSeparatorMouseDown";
+  GridEvents["columnResize"] = "columnResize";
+  GridEvents["columnWidthChange"] = "columnWidthChange";
+  GridEvents["columnResizeStart"] = "columnResizeStart";
+  GridEvents["columnResizeStop"] = "columnResizeStop";
+  GridEvents["columnOrderChange"] = "columnOrderChange";
+  GridEvents["rowsSet"] = "rowsSet";
+  GridEvents["rowExpansionChange"] = "rowExpansionChange";
+  GridEvents["visibleRowsSet"] = "visibleRowsSet";
+  GridEvents["columnsChange"] = "columnsChange";
+  GridEvents["detailPanelsExpandedRowIdsChange"] = "detailPanelsExpandedRowIdsChange";
+  GridEvents["pinnedColumnsChange"] = "pinnedColumnsChange";
+  GridEvents["preProcessorRegister"] = "preProcessorRegister";
+  GridEvents["preProcessorUnregister"] = "preProcessorUnregister";
+  GridEvents["rowGroupsPreProcessingChange"] = "rowGroupsPreProcessingChange";
+  GridEvents["sortModelChange"] = "sortModelChange";
+  GridEvents["filterModelChange"] = "filterModelChange";
+  GridEvents["columnVisibilityModelChange"] = "columnVisibilityModelChange";
+  GridEvents["stateChange"] = "stateChange";
+  GridEvents["columnVisibilityChange"] = "columnVisibilityChange";
+  GridEvents["virtualScrollerContentSizeChange"] = "virtualScrollerContentSizeChange";
+})(GridEvents || (GridEvents = {}));
+
+export { GridEvents };

package/models/events/index.d.ts

@@ -0,0 +1,4 @@
+export * from './gridEventListener';
+export * from './gridEventPublisher';
+export * from './gridEventLookup';
+export * from './gridEvents';

package/models/events/index.js

@@ -0,0 +1,4 @@
+export * from './gridEventListener';
+export * from './gridEventPublisher';
+export * from './gridEventLookup';
+export * from './gridEvents';

package/models/gridCell.d.ts

@@ -0,0 +1,25 @@
+/**
+ * The mode of the cell.
+ */
+export declare type GridCellMode = 'edit' | 'view';
+/**
+ * The mode of the row.
+ */
+export declare type GridRowMode = 'edit' | 'view';
+/**
+ * The cell value type.
+ */
+export declare type GridCellValue = string | number | boolean | Date | null | undefined | object;
+/**
+ * The coordinates of cell represented by their row and column indexes.
+ */
+export interface GridCellIndexCoordinates {
+    colIndex: number;
+    rowIndex: number;
+}
+/**
+ * The coordinates of column header represented by their row and column indexes.
+ */
+export interface GridColumnHeaderIndexCoordinates {
+    colIndex: number;
+}

package/models/gridCell.js

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

package/models/gridCellClass.d.ts

@@ -0,0 +1,9 @@
+import { GridCellParams } from './params/gridCellParams';
+/**
+ * A function used to process cellClassName params.
+ */
+export declare type GridCellClassFn = (params: GridCellParams) => string;
+/**
+ * The union type representing the [[GridColDef]] cell class type.
+ */
+export declare type GridCellClassNamePropType = string | GridCellClassFn;

package/models/gridCellClass.js

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

package/models/gridColumnHeaderClass.d.ts

@@ -0,0 +1,9 @@
+import { GridColumnHeaderParams } from './params/gridColumnHeaderParams';
+/**
+ * A function used to process headerClassName params.
+ */
+export declare type GridColumnHeaderClassFn = (params: GridColumnHeaderParams) => string;
+/**
+ * The union type representing the [[GridColDef]] column header class type.
+ */
+export declare type GridColumnHeaderClassNamePropType = string | GridColumnHeaderClassFn;

package/models/gridColumnHeaderClass.js

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

package/models/gridDensity.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Available densities.
+ */
+export declare type GridDensity = 'compact' | 'standard' | 'comfortable';
+/**
+ * Density enum.
+ */
+declare enum GridDensityTypes {
+    Compact = "compact",
+    Standard = "standard",
+    Comfortable = "comfortable"
+}
+export { GridDensityTypes };

package/models/gridDensity.js

@@ -0,0 +1,16 @@
+/**
+ * Available densities.
+ */
+
+/**
+ * Density enum.
+ */
+var GridDensityTypes;
+
+(function (GridDensityTypes) {
+  GridDensityTypes["Compact"] = "compact";
+  GridDensityTypes["Standard"] = "standard";
+  GridDensityTypes["Comfortable"] = "comfortable";
+})(GridDensityTypes || (GridDensityTypes = {}));
+
+export { GridDensityTypes };

package/models/gridEditRowModel.d.ts

@@ -0,0 +1,26 @@
+import { GridCellValue } from './gridCell';
+export interface GridEditCellProps {
+    value: GridCellValue;
+    isValidating?: boolean;
+    [prop: string]: any;
+}
+export declare type GridEditRowProps = {
+    [field: string]: GridEditCellProps;
+};
+export declare type GridEditRowsModel = {
+    [rowId: string]: GridEditRowProps;
+};
+export declare 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/gridEditRowModel.js

@@ -0,0 +1,22 @@
+var GridEditModes;
+
+(function (GridEditModes) {
+  GridEditModes["Cell"] = "cell";
+  GridEditModes["Row"] = "row";
+})(GridEditModes || (GridEditModes = {}));
+
+var GridCellModes;
+
+(function (GridCellModes) {
+  GridCellModes["Edit"] = "edit";
+  GridCellModes["View"] = "view";
+})(GridCellModes || (GridCellModes = {}));
+
+var GridRowModes;
+
+(function (GridRowModes) {
+  GridRowModes["Edit"] = "edit";
+  GridRowModes["View"] = "view";
+})(GridRowModes || (GridRowModes = {}));
+
+export { GridEditModes, GridCellModes, GridRowModes };

package/models/gridExport.d.ts

@@ -0,0 +1,95 @@
+import * as React from 'react';
+import { GridRowId } from './gridRows';
+import type { GridApiCommon } from './api';
+import type { GridApiCommunity } from './api/gridApiCommunity';
+/**
+ * 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;
+}
+export interface GridCsvGetRowsToExportParams<Api extends GridApiCommon = GridApiCommunity> {
+    /**
+     * The API of the grid.
+     */
+    apiRef: React.MutableRefObject<Api>;
+}
+/**
+ * The options to apply on the CSV export.
+ */
+export interface GridCsvExportOptions extends GridExportOptions {
+    /**
+     * 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 first row of the CSV 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 {GridCsvGetRowsToExportParams} params With all properties from [[GridCsvGetRowsToExportParams]].
+     * @returns {GridRowId[]} The id of the rows to export.
+     */
+    getRowsToExport?: (params: GridCsvGetRowsToExportParams) => GridRowId[];
+}
+/**
+ * The options to apply on the 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 `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 | Function;
+}
+/**
+ * Available export formats.
+ */
+export declare type GridExportFormat = 'csv' | 'print';

package/models/gridExport.js

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

package/models/gridFeatureMode.d.ts

@@ -0,0 +1,5 @@
+export declare const GridFeatureModeConstant: {
+    client: "client";
+    server: "server";
+};
+export declare type GridFeatureMode = 'client' | 'server';

package/models/gridFeatureMode.js

@@ -0,0 +1,4 @@
+export const GridFeatureModeConstant = {
+  client: 'client',
+  server: 'server'
+};