@mui/x-data-grid 8.0.0-beta.3 → 8.1.0

package/modern/models/events/gridEventLookup.d.ts

@@ -1,661 +0,0 @@
-import * as React from 'react';
-import type { GridColumnHeaderParams, GridColumnOrderChangeParams, GridColumnResizeParams, GridHeaderSelectionCheckboxParams, GridMenuParams, GridPreferencePanelParams, GridRowParams, GridRowSelectionCheckboxParams, GridScrollParams, GridColumnGroupHeaderParams, GridRenderContext } from '../params';
-import { GridCellEditStartParams, GridCellEditStopParams } from "../params/gridEditCellParams.js";
-import { GridCellParams } from "../params/gridCellParams.js";
-import type { GridFilterModel } from '../gridFilterModel';
-import type { GridSortModel } from '../gridSortModel';
-import type { GridRowSelectionModel } from '../gridRowSelectionModel';
-import type { ElementSize } from '../elementSize';
-import type { MuiBaseEvent } from '../muiEvent';
-import type { GridGroupNode } from '../gridRows';
-import type { GridColumnVisibilityModel } from '../../hooks/features/columns';
-import type { GridStrategyProcessorName } from '../../hooks/core/strategyProcessing';
-import { GridRowEditStartParams, GridRowEditStopParams } from "../params/gridRowParams.js";
-import { GridCellModesModel, GridRowModesModel } from "../api/gridEditingApi.js";
-import { GridPaginationMeta, GridPaginationModel } from "../gridPaginationProps.js";
-import { GridDensity } from "../gridDensity.js";
-export interface GridRowEventLookup {
-  /**
-   * Fired when a row is clicked.
-   * Not fired if the cell clicked is from an interactive column (actions, checkbox, etc).
-   */
-  rowClick: {
-    params: GridRowParams;
-    event: React.MouseEvent<HTMLElement>;
-  };
-  /**
-   * Fired when a row is double-clicked.
-   */
-  rowDoubleClick: {
-    params: GridRowParams;
-    event: React.MouseEvent<HTMLElement>;
-  };
-  /**
-   * Fired when the mouse enters the row. Called with a [[GridRowParams]] object.
-   */
-  rowMouseEnter: {
-    params: GridRowParams;
-    event: React.MouseEvent<HTMLElement>;
-  };
-  /**
-   * Fired when the mouse leaves the row. Called with a [[GridRowParams]] object.
-   */
-  rowMouseLeave: {
-    params: GridRowParams;
-    event: React.MouseEvent<HTMLElement>;
-  };
-  /**
-   * @ignore - do not document.
-   */
-  rowMouseOut: {
-    params: GridRowParams;
-    event: React.MouseEvent<HTMLElement>;
-  };
-  /**
-   * @ignore - do not document.
-   */
-  rowMouseOver: {
-    params: GridRowParams;
-    event: React.MouseEvent<HTMLElement>;
-  };
-  /**
-   * Fired when the user starts dragging a row. It's mapped to the `dragstart` DOM event.
-   * @ignore - do not document.
-   */
-  rowDragStart: {
-    params: GridRowParams;
-    event: React.DragEvent<HTMLElement>;
-  };
-  /**
-   * Fired while an element or text selection is dragged over the row.
-   * It's mapped to the `dragover` DOM event.
-   * @ignore - do not document.
-   */
-  rowDragOver: {
-    params: GridRowParams;
-    event: React.DragEvent<HTMLElement>;
-  };
-  /**
-   * Fired when the dragging of a row ends.
-   * @ignore - do not document.
-   */
-  rowDragEnd: {
-    params: GridRowParams;
-    event: React.DragEvent<HTMLElement>;
-  };
-}
-export interface GridColumnHeaderEventLookup {
-  /**
-   * Fired when a column header is clicked
-   */
-  columnHeaderClick: {
-    params: GridColumnHeaderParams;
-    event: React.MouseEvent<HTMLElement>;
-  };
-  /**
-   * Fired when the user attempts to open a context menu in the column header.
-   */
-  columnHeaderContextMenu: {
-    params: GridColumnHeaderParams;
-    event: React.MouseEvent<HTMLElement>;
-  };
-  /**
-   * Fired when a column header is double-clicked.
-   */
-  columnHeaderDoubleClick: {
-    params: GridColumnHeaderParams;
-    event: React.MouseEvent<HTMLElement>;
-  };
-  /**
-   * Fired when a `mouseover` event happens in a column header.
-   * @ignore - do not document.
-   */
-  columnHeaderOver: {
-    params: GridColumnHeaderParams;
-    event: React.MouseEvent<HTMLElement>;
-  };
-  /**
-   * Fired when a `mouseout` event happens in a column header.
-   * @ignore - do not document.
-   */
-  columnHeaderOut: {
-    params: GridColumnHeaderParams;
-    event: React.MouseEvent<HTMLElement>;
-  };
-  /**
-   * Fired when a `mouseenter` event happens in a column header.
-   * @ignore - do not document.
-   */
-  columnHeaderEnter: {
-    params: GridColumnHeaderParams;
-    event: React.MouseEvent<HTMLElement>;
-  };
-  /**
-   * Fired when a `mouseleave` event happens in a column header.
-   * @ignore - do not document.*
-   */
-  columnHeaderLeave: {
-    params: GridColumnHeaderParams;
-    event: React.MouseEvent<HTMLElement>;
-  };
-  /**
-   * Fired when a key is pressed in a column header. It's mapped do the `keydown` DOM event.
-   */
-  columnHeaderKeyDown: {
-    params: GridColumnHeaderParams;
-    event: React.KeyboardEvent<HTMLElement>;
-  };
-  /**
-   * Fired when a column header gains focus.
-   * @ignore - do not document.
-   */
-  columnHeaderFocus: {
-    params: GridColumnHeaderParams;
-    event: React.FocusEvent<HTMLElement>;
-  };
-  /**
-   * Fired when a column header loses focus.
-   * @ignore - do not document.
-   */
-  columnHeaderBlur: {
-    params: GridColumnHeaderParams;
-    event: React.FocusEvent<HTMLElement>;
-  };
-  /**
-   * Fired when the user starts dragging a column header. It's mapped to the `dragstart` DOM event.
-   * @ignore - do not document.
-   */
-  columnHeaderDragStart: {
-    params: GridColumnHeaderParams;
-    event: React.DragEvent<HTMLElement>;
-  };
-  /**
-   * Fired when the dragged column header enters a valid drop target.
-   * It's mapped to the `dragend` DOM event.
-   * @ignore - do not document.
-   */
-  columnHeaderDragEnter: {
-    params: GridColumnHeaderParams;
-    event: React.DragEvent<HTMLElement>;
-  };
-  /**
-   * 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: {
-    params: GridColumnHeaderParams;
-    event: React.DragEvent<HTMLElement>;
-  };
-  /**
-   * Fired when the dragging of a column header ends.
-   * @ignore - do not document.
-   */
-  columnHeaderDragEnd: {
-    params: GridColumnHeaderParams;
-    event: React.DragEvent<HTMLElement>;
-  };
-  /**
-   * Fired when a `dblclick` DOM event happens in the column header separator.
-   * @ignore - do not document.
-   */
-  columnSeparatorDoubleClick: {
-    params: GridColumnHeaderParams;
-    event: React.MouseEvent<HTMLElement>;
-  };
-  /**
-   * Fired when a `mousedown` DOM event happens in the column header separator.
-   * @ignore - do not document.
-   */
-  columnSeparatorMouseDown: {
-    params: GridColumnHeaderParams;
-    event: React.MouseEvent<HTMLElement>;
-  };
-  /**
-   * Fired when the index of a column changes.
-   * @ignore - do not document.
-   */
-  columnIndexChange: {
-    params: GridColumnOrderChangeParams;
-  };
-}
-export interface GridHeaderFilterEventLookup {
-  /**
-   * Fired when a column header filter is clicked
-   * @ignore - do not document.
-   */
-  headerFilterClick: {
-    params: GridColumnHeaderParams;
-    event: React.MouseEvent<HTMLElement>;
-  };
-  /**
-   * Fired when a key is pressed in a column header filter. It's mapped to the `keydown` DOM event.
-   * @ignore - do not document.
-   */
-  headerFilterKeyDown: {
-    params: GridColumnHeaderParams;
-    event: React.KeyboardEvent<HTMLElement>;
-  };
-  /**
-   * Fired when a mouse is pressed in a column header filter. It's mapped to the `mousedown` DOM event.
-   * @ignore - do not document.
-   */
-  headerFilterMouseDown: {
-    params: GridColumnHeaderParams;
-    event: React.KeyboardEvent<HTMLElement>;
-  };
-  /**
-   * Fired when a column header filter is blurred.
-   * @ignore - do not document.
-   */
-  headerFilterBlur: {
-    params: GridColumnHeaderParams;
-    event: React.KeyboardEvent<HTMLElement>;
-  };
-}
-export interface GridColumnGroupHeaderEventLookup {
-  /**
-   * Fired when a key is pressed in a column group header. It's mapped do the `keydown` DOM event.
-   */
-  columnGroupHeaderKeyDown: {
-    params: GridColumnGroupHeaderParams;
-    event: React.KeyboardEvent<HTMLElement>;
-  };
-  /**
-   * Fired when a column group header gains focus.
-   * @ignore - do not document.
-   */
-  columnGroupHeaderFocus: {
-    params: GridColumnGroupHeaderParams;
-    event: React.FocusEvent<HTMLElement>;
-  };
-  /**
-   * Fired when a column group header loses focus.
-   * @ignore - do not document.
-   */
-  columnGroupHeaderBlur: {
-    params: GridColumnGroupHeaderParams;
-    event: React.FocusEvent<HTMLElement>;
-  };
-}
-export interface GridCellEventLookup {
-  /**
-   * Fired when a cell is clicked.
-   */
-  cellClick: {
-    params: GridCellParams<any>;
-    event: React.MouseEvent<HTMLElement>;
-  };
-  /**
-   * Fired when a cell is double-clicked.
-   */
-  cellDoubleClick: {
-    params: GridCellParams<any>;
-    event: React.MouseEvent<HTMLElement>;
-  };
-  /**
-   * Fired when a `mousedown` event happens in a cell.
-   */
-  cellMouseDown: {
-    params: GridCellParams<any>;
-    event: React.MouseEvent<HTMLElement>;
-  };
-  /**
-   * Fired when a `mouseup` event happens in a cell.
-   */
-  cellMouseUp: {
-    params: GridCellParams<any>;
-    event: React.MouseEvent<HTMLElement>;
-  };
-  /**
-   * Fired when a `mouseover` event happens in a cell.
-   */
-  cellMouseOver: {
-    params: GridCellParams<any>;
-    event: React.MouseEvent<HTMLElement>;
-  };
-  /**
-   * Fired when a `keydown` event happens in a cell.
-   */
-  cellKeyDown: {
-    params: GridCellParams<any>;
-    event: React.KeyboardEvent<HTMLElement>;
-  };
-  /**
-   * Fired when a `keyup` event happens in a cell.
-   */
-  cellKeyUp: {
-    params: GridCellParams<any>;
-    event: React.KeyboardEvent<HTMLElement>;
-  };
-  /**
-   * Fired when the dragged cell enters a valid drop target. It's mapped to the `dragend` DOM event.
-   * @ignore - do not document.
-   */
-  cellDragEnter: {
-    params: GridCellParams<any>;
-    event: React.DragEvent<HTMLElement>;
-  };
-  /**
-   * 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: {
-    params: GridCellParams<any>;
-    event: React.DragEvent<HTMLElement>;
-  };
-}
-export interface GridControlledStateEventLookup {
-  /**
-   * Fired when the pagination model changes.
-   */
-  paginationModelChange: {
-    params: GridPaginationModel;
-  };
-  /**
-   * Fired when the filter model changes.
-   */
-  filterModelChange: {
-    params: GridFilterModel;
-  };
-  /**
-   * Fired when the sort model changes.
-   */
-  sortModelChange: {
-    params: GridSortModel;
-  };
-  /**
-   * Fired when the selection state of one or multiple rows changes.
-   */
-  rowSelectionChange: {
-    params: GridRowSelectionModel;
-  };
-  /**
-   * Fired when the column visibility model changes.
-   */
-  columnVisibilityModelChange: {
-    params: GridColumnVisibilityModel;
-  };
-  /**
-   * Fired when the row count change.
-   */
-  rowCountChange: {
-    params: number;
-  };
-  /**
-   * Fired when the density changes.
-   */
-  densityChange: {
-    params: GridDensity;
-  };
-  /**
-   * Fired when the pagination meta change.
-   */
-  paginationMetaChange: {
-    params: GridPaginationMeta;
-  };
-}
-export interface GridControlledStateReasonLookup {
-  filter: 'upsertFilterItem' | 'upsertFilterItems' | 'deleteFilterItem' | 'changeLogicOperator' | 'restoreState' | 'removeAllFilterItems';
-  pagination: 'setPaginationModel' | 'stateRestorePreProcessing';
-  rows: 'addSkeletonRows';
-}
-export interface GridEventLookup extends GridRowEventLookup, GridColumnHeaderEventLookup, GridHeaderFilterEventLookup, GridColumnGroupHeaderEventLookup, GridCellEventLookup, GridControlledStateEventLookup {
-  /**
-   * Fired when rootElementRef.current becomes available.
-   */
-  rootMount: {
-    params: HTMLElement;
-  };
-  /**
-   * Fired when the grid is unmounted.
-   */
-  unmount: {};
-  /**
-   * Fired when the state of the grid is updated.
-   */
-  stateChange: {
-    params: any;
-  };
-  /**
-   * Fired when the grid is resized.
-   */
-  resize: {
-    params: ElementSize;
-  };
-  /**
-   * Fired when the inner size of the viewport changes. Called with an [[ElementSize]] object.
-   */
-  viewportInnerSizeChange: {
-    params: ElementSize;
-  };
-  /**
-   * Fired when the grid is resized with a debounced time of 60ms.
-   */
-  debouncedResize: {
-    params: ElementSize;
-  };
-  /**
-   * Fired when a processor of the active strategy changes.
-   * @ignore - do not document.
-   */
-  activeStrategyProcessorChange: {
-    params: GridStrategyProcessorName;
-  };
-  /**
-   * Fired when the callback to decide if a strategy is available or not changes.
-   * @ignore - do not document.
-   */
-  strategyAvailabilityChange: {};
-  /**
-   * Fired when the columns state is changed.
-   */
-  columnsChange: {
-    params: string[];
-  };
-  /**
-   * Fired when the width of a column is changed.
-   */
-  columnWidthChange: {
-    params: GridColumnResizeParams;
-    event: MouseEvent | {};
-  };
-  /**
-   * Fired when the user starts resizing a column.
-   */
-  columnResizeStart: {
-    params: {
-      field: string;
-    };
-    event: React.MouseEvent<HTMLElement>;
-  };
-  /**
-   * Fired when the user stops resizing a column.
-   */
-  columnResizeStop: {
-    params: null;
-    event: MouseEvent;
-  };
-  /**
-   * Fired during the resizing of a column.
-   */
-  columnResize: {
-    params: GridColumnResizeParams;
-    event: MouseEvent;
-  };
-  /**
-   * Fired when the user ends reordering a column.
-   */
-  columnOrderChange: {
-    params: GridColumnOrderChangeParams;
-  };
-  /**
-   * Fired when the rows are updated.
-   * @ignore - do not document.
-   */
-  rowsSet: {};
-  /**
-   * Fired when the filtered rows are updated
-   * @ignore - do not document.
-   */
-  filteredRowsSet: {};
-  /**
-   * Fired when the sorted rows are updated
-   * @ignore - do not document
-   */
-  sortedRowsSet: {};
-  /**
-   * Fired when the expansion of a row is changed. Called with a [[GridGroupNode]] object.
-   */
-  rowExpansionChange: {
-    params: GridGroupNode;
-  };
-  /**
-   * Fired when the rendered rows index interval changes. Called with a [[GridRenderContext]] object.
-   */
-  renderedRowsIntervalChange: {
-    params: GridRenderContext;
-  };
-  /**
-   * Fired when the mode of a cell changes.
-   * @ignore - do not document
-   */
-  cellModeChange: {
-    params: GridCellParams<any>;
-  };
-  /**
-   * Fired when the model that controls the cell modes changes.
-   */
-  cellModesModelChange: {
-    params: GridCellModesModel;
-  };
-  /**
-   * Fired when the model that controls the row modes changes.
-   */
-  rowModesModelChange: {
-    params: GridRowModesModel;
-  };
-  /**
-   * Fired when the cell turns to edit mode.
-   */
-  cellEditStart: {
-    params: GridCellEditStartParams;
-    event: React.MouseEvent<HTMLElement> | React.KeyboardEvent<HTMLElement>;
-  };
-  /**
-   * Fired when the cell turns back to view mode.
-   */
-  cellEditStop: {
-    params: GridCellEditStopParams;
-    event: MuiBaseEvent;
-  };
-  /**
-   * Fired when the row turns to edit mode.
-   */
-  rowEditStart: {
-    params: GridRowEditStartParams;
-    event: React.MouseEvent<HTMLElement> | React.KeyboardEvent<HTMLElement>;
-  };
-  /**
-   * Fired when the row turns back to view mode.
-   */
-  rowEditStop: {
-    params: GridRowEditStopParams;
-    event: MuiBaseEvent;
-  };
-  /**
-   * Fired when a cell gains focus.
-   * @ignore - do not document.
-   */
-  cellFocusIn: {
-    params: GridCellParams<any>;
-  };
-  /**
-   * Fired when a cell loses focus.
-   * @ignore - do not document.
-   */
-  cellFocusOut: {
-    params: GridCellParams<any>;
-    event: MuiBaseEvent;
-  };
-  /**
-   * Fired during the scroll of the grid viewport.
-   */
-  scrollPositionChange: {
-    params: GridScrollParams;
-    event: React.UIEvent | MuiBaseEvent;
-  };
-  /**
-   * Fired when the content size used by the `GridVirtualScroller` changes.
-   * @ignore - do not document.
-   */
-  virtualScrollerContentSizeChange: {
-    params: {
-      columnsTotalWidth: number;
-      contentHeight: number;
-    };
-  };
-  /**
-   * Fired when the content is scrolled by the mouse wheel.
-   * It's attached to the "mousewheel" event.
-   * @ignore - do not document.
-   */
-  virtualScrollerWheel: {
-    params: {};
-    event: React.WheelEvent;
-  };
-  /**
-   * Fired when the content is moved using a touch device.
-   * It's attached to the "touchmove" event.
-   * @ignore - do not document.
-   */
-  virtualScrollerTouchMove: {
-    params: {};
-    event: React.TouchEvent;
-  };
-  /**
-   * Fired when the value of the selection checkbox of the header is changed.
-   */
-  headerSelectionCheckboxChange: {
-    params: GridHeaderSelectionCheckboxParams;
-  };
-  /**
-   * Fired when the value of the selection checkbox of a row is changed.
-   */
-  rowSelectionCheckboxChange: {
-    params: GridRowSelectionCheckboxParams;
-    event: React.ChangeEvent<HTMLElement>;
-  };
-  /**
-   * Fired when the data is copied to the clipboard.
-   */
-  clipboardCopy: {
-    params: string;
-  };
-  /**
-   * Fired when the preference panel is closed.
-   */
-  preferencePanelClose: {
-    params: GridPreferencePanelParams;
-  };
-  /**
-   * Fired when the preference panel is opened.
-   */
-  preferencePanelOpen: {
-    params: GridPreferencePanelParams;
-  };
-  /**
-   * Fired when the menu is opened.
-   */
-  menuOpen: {
-    params: GridMenuParams;
-  };
-  /**
-   * Fired when the grid menu is closed.
-   */
-  menuClose: {
-    params: GridMenuParams;
-  };
-}
-export type GridEvents = keyof GridEventLookup;

package/modern/models/events/gridEventLookup.js

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

package/modern/models/events/gridEventPublisher.d.ts

@@ -1,29 +0,0 @@
-import type { MuiBaseEvent } from '../muiEvent';
-import type { GridEventLookup, GridEvents } from './gridEventLookup';
-type PublisherArgsNoEvent<E extends GridEvents, T extends {
-  params: any;
-}> = [E, T['params']];
-type PublisherArgsRequiredEvent<E extends GridEvents, T extends {
-  params: any;
-  event: MuiBaseEvent;
-}> = [E, T['params'], T['event']];
-type PublisherArgsOptionalEvent<E extends GridEvents, T extends {
-  params: any;
-  event: MuiBaseEvent;
-}> = PublisherArgsRequiredEvent<E, T> | PublisherArgsNoEvent<E, T>;
-type PublisherArgsEvent<E extends GridEvents, T extends {
-  params: any;
-  event: MuiBaseEvent;
-}> = {} extends T['event'] ? PublisherArgsOptionalEvent<E, T> : PublisherArgsRequiredEvent<E, T>;
-type PublisherArgsParams<E extends GridEvents, T extends {
-  params: any;
-}> = [E, T['params']];
-type PublisherArgsNoParams<E extends GridEvents> = [E];
-type GridEventPublisherArg<E extends GridEvents, T> = T extends {
-  params: any;
-  event: MuiBaseEvent;
-} ? PublisherArgsEvent<E, T> : T extends {
-  params: any;
-} ? PublisherArgsParams<E, T> : PublisherArgsNoParams<E>;
-export type GridEventPublisher = <E extends GridEvents>(...params: GridEventPublisherArg<E, GridEventLookup[E]>) => void;
-export {};

package/modern/models/events/gridEventPublisher.js

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

package/modern/models/events/index.d.ts

@@ -1,3 +0,0 @@
-export * from "./gridEventListener.js";
-export * from "./gridEventPublisher.js";
-export * from "./gridEventLookup.js";

package/modern/models/events/index.js

@@ -1,3 +0,0 @@
-export * from "./gridEventListener.js";
-export * from "./gridEventPublisher.js";
-export * from "./gridEventLookup.js";

package/modern/models/gridApiCaches.d.ts

@@ -1,6 +0,0 @@
-import { GridRowsInternalCache } from "../hooks/features/rows/gridRowsInterfaces.js";
-import { GridRowsMetaInternalCache } from "../hooks/features/rows/gridRowsMetaInterfaces.js";
-export interface GridApiCaches {
-  rows: GridRowsInternalCache;
-  rowsMeta: GridRowsMetaInternalCache;
-}

package/modern/models/gridApiCaches.js

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