@mui/x-data-grid 5.5.1 → 5.7.0

package/models/api/gridSelectionApi.d.ts

@@ -0,0 +1,49 @@
+import { GridRowId, GridRowModel } from '../gridRows';
+/**
+ * The selection API interface that is available in the grid [[apiRef]].
+ */
+export interface GridSelectionApi {
+    /**
+     * Change the selection state of a row.
+     * @param {GridRowId} id The id of the row.
+     * @param {boolean} isSelected Pass `false` to unselect a row. Default is `true`.
+     * @param {boolean} resetSelection Whether to reset the already selected rows or not. Default is `false`.
+     */
+    selectRow: (id: GridRowId, isSelected?: boolean, resetSelection?: boolean) => void;
+    /**
+     * Change the selection state of multiple rows.
+     * @param {GridRowId[]} ids The row ids.
+     * @param {boolean} isSelected The new selection state. Default is `true`.
+     * @param {boolean} resetSelection Whether to reset the already selected rows or not. Default is `false`.
+     */
+    selectRows: (ids: GridRowId[], isSelected?: boolean, resetSelection?: boolean) => void;
+    /**
+     * Change the selection state of all the selectable rows in a range.
+     * @param {Object} range The range of rows to select.
+     * @param {GridRowId} range.startId The first row id.
+     * @param {GridRowId} range.endId The last row id.
+     * @param {boolean} isSelected The new selection state. Default is `true`.
+     * @param {boolean} resetSelection Whether to reset the selected rows outside of the range or not. Default is `false`.
+     */
+    selectRowRange: (range: {
+        startId: GridRowId;
+        endId: GridRowId;
+    }, isSelected?: boolean, resetSelection?: boolean) => void;
+    /**
+     * Determines if a row is selected or not.
+     * @param {GridRowId} id The id of the row.
+     * @returns {boolean} A boolean indicating if the row is selected.
+     */
+    isRowSelected: (id: GridRowId) => boolean;
+    /**
+     * Returns an array of the selected rows.
+     * @returns {Map<GridRowId, GridRowModel>} A `Map` with the selected rows.
+     */
+    getSelectedRows: () => Map<GridRowId, GridRowModel>;
+    /**
+     * Updates the selected rows to be those passed to the `rowIds` argument.
+     * Any row already selected will be unselected.
+     * @param {GridRowId[]} rowIds The row ids to select.
+     */
+    setSelectionModel: (rowIds: GridRowId[]) => void;
+}

package/models/api/gridSelectionApi.js

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

package/models/api/gridSortApi.d.ts

@@ -0,0 +1,54 @@
+import { GridColDef } from '../colDef/gridColDef';
+import { GridRowId, GridRowModel } from '../gridRows';
+import { GridSortDirection, GridSortModel } from '../gridSortModel';
+/**
+ * The sort API interface that is available in the grid [[apiRef]].
+ */
+export interface GridSortApi {
+    /**
+     * Returns the sort model currently applied to the grid.
+     * @returns {GridSortModel} The `GridSortModel`.
+     */
+    getSortModel: () => GridSortModel;
+    /**
+     * Applies the current sort model to the rows.
+     */
+    applySorting: () => void;
+    /**
+     * Updates the sort model and triggers the sorting of rows.
+     * @param {GridSortModel} model The `GridSortModel` to be applied.
+     */
+    setSortModel: (model: GridSortModel) => void;
+    /**
+     * Sorts a column.
+     * @param {GridColDef} column The [[GridColDef]] of the column to be sorted.
+     * @param {GridSortDirection} direction The direction to be sorted. By default, the next in the `sortingOrder` prop.
+     * @param {boolean} allowMultipleSorting Whether to keep the existing [[GridSortItem]]. Default is `false`.
+     */
+    sortColumn: (column: GridColDef, direction?: GridSortDirection, allowMultipleSorting?: boolean) => void;
+    /**
+     * Returns all rows sorted according to the active sort model.
+     * @returns {GridRowModel[]} The sorted [[GridRowModel]] objects.
+     */
+    getSortedRows: () => GridRowModel[];
+    /**
+     * Returns all row ids sorted according to the active sort model.
+     * @returns {GridRowId[]} The sorted [[GridRowId]] values.
+     */
+    getSortedRowIds: () => GridRowId[];
+    /**
+     * Gets the `GridRowId` of a row at a specific index.
+     * The index is based on the sorted but unfiltered row list.
+     * @param {number} index The index of the row
+     * @returns {GridRowId} The `GridRowId` of the row.
+     */
+    getRowIdFromRowIndex: (index: number) => GridRowId;
+    /**
+     * Gets the row index of a row with a given id.
+     * The index is based on the sorted but unfiltered row list.
+     * @param {GridRowId} id The `GridRowId` of the row.
+     * @returns {number} The index of the row.
+     * @deprecated Use `getRowIndexRelativeToVisibleRows` instead.
+     */
+    getRowIndex: (id: GridRowId) => number;
+}

package/models/api/gridSortApi.js

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

package/models/api/gridStateApi.d.ts

@@ -0,0 +1,26 @@
+import { GridStateCommunity } from '../gridStateCommunity';
+import { GridControlledStateEventLookup } from '../events';
+import { GridControlStateItem } from '../controlStateItem';
+export interface GridStateApi<State extends GridStateCommunity> {
+    /**
+     * Property that contains the whole state of the grid.
+     */
+    state: State;
+    /**
+     * Forces the grid to rerender. It's often used after a state update.
+     */
+    forceUpdate: () => void;
+    /**
+     * Sets the whole state of the grid.
+     * @param {GridState | (oldState: GridState) => GridState} state The new state or the callback creating the new state.
+     * @returns {boolean} Has the state been updated.
+     * @ignore - do not document.
+     */
+    setState: <S extends State>(state: S | ((previousState: S) => S)) => boolean;
+    /**
+     * Updates a control state that binds the model, the onChange prop, and the grid state together.
+     * @param {GridControlStateItem>} controlState The [[GridControlStateItem]] to be registered.
+     * @ignore - do not document.
+     */
+    unstable_updateControlState: <E extends keyof GridControlledStateEventLookup>(controlState: GridControlStateItem<State, E>) => void;
+}

package/models/api/gridStateApi.js

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

package/models/api/gridVirtualScrollerApi.d.ts

@@ -0,0 +1,9 @@
+import { GridRenderContext } from '../params/gridScrollParams';
+export interface GridVirtualScrollerApi {
+    /**
+     * Get the current grid rendering context.
+     * @returns {GridRenderContext} The `GridRenderContext`.
+     * @ignore - do not document.
+     */
+    unstable_getRenderContext: () => GridRenderContext;
+}

package/models/api/gridVirtualScrollerApi.js

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

package/models/api/index.d.ts

@@ -0,0 +1,25 @@
+import type { GridEditingApi } from './gridEditingApi';
+export * from './gridParamsApi';
+export * from './gridCoreApi';
+export * from './gridColumnApi';
+export * from './gridDensityApi';
+export * from './gridRowApi';
+export * from './gridRowsMetaApi';
+export * from './gridSelectionApi';
+export * from './gridSortApi';
+export * from './gridStateApi';
+export * from './gridLocaleTextApi';
+export * from './gridCsvExportApi';
+export * from './gridFocusApi';
+export * from './gridFilterApi';
+export * from './gridColumnMenuApi';
+export * from './gridPreferencesPanelApi';
+export * from './gridPrintExportApi';
+export * from './gridDisableVirtualizationApi';
+export * from './gridClipboardApi';
+export * from './gridCallbackDetails';
+export * from './gridScrollApi';
+export * from './gridVirtualScrollerApi';
+export * from './gridApiCommon';
+export type { GridEditingApi, GridOldEditingApi, GridNewEditingApi } from './gridEditingApi';
+export declare type GridEditRowApi = GridEditingApi;

package/models/api/index.js

@@ -0,0 +1,23 @@
+export * from './gridParamsApi';
+export * from './gridCoreApi';
+export * from './gridColumnApi';
+export * from './gridDensityApi';
+export * from './gridRowApi';
+export * from './gridRowsMetaApi';
+export * from './gridSelectionApi';
+export * from './gridSortApi';
+export * from './gridStateApi';
+export * from './gridLocaleTextApi';
+export * from './gridCsvExportApi';
+export * from './gridFocusApi';
+export * from './gridFilterApi';
+export * from './gridColumnMenuApi';
+export * from './gridPreferencesPanelApi';
+export * from './gridPrintExportApi';
+export * from './gridDisableVirtualizationApi';
+export * from './gridClipboardApi';
+export * from './gridCallbackDetails';
+export * from './gridScrollApi';
+export * from './gridVirtualScrollerApi';
+export * from './gridApiCommon';
+export {};

package/models/colDef/gridColDef.d.ts

@@ -0,0 +1,244 @@
+import * as React from 'react';
+import { GridCellValue } from '../gridCell';
+import { GridCellClassNamePropType } from '../gridCellClass';
+import { GridColumnHeaderClassNamePropType } from '../gridColumnHeaderClass';
+import { GridFilterOperator } from '../gridFilterOperator';
+import { GridCellParams, GridRenderCellParams, GridRenderEditCellParams, GridValueFormatterParams, GridValueGetterParams, GridValueSetterParams, GridPreProcessEditCellProps } from '../params/gridCellParams';
+import { GridColumnHeaderParams } from '../params/gridColumnHeaderParams';
+import { GridComparatorFn, GridSortDirection } from '../gridSortModel';
+import { GridColType, GridNativeColTypes } from './gridColType';
+import { GridRowParams } from '../params/gridRowParams';
+import { GridValueOptionsParams } from '../params/gridValueOptionsParams';
+import { GridActionsCellItemProps } from '../../components/cell/GridActionsCellItem';
+import { GridRowModel } from '../gridRows';
+import { GridEditCellProps } from '../gridEditRowModel';
+/**
+ * Alignment used in position elements in Cells.
+ */
+export declare type GridAlignment = 'left' | 'right' | 'center';
+export declare type ValueOptions = string | number | {
+    value: any;
+    label: string;
+};
+/**
+ * Value that can be used as a key for grouping rows
+ */
+export declare type GridKeyValue = string | number | boolean;
+/**
+ * Column Definition interface.
+ */
+export interface GridColDef {
+    /**
+     * The column identifier. It's used to map with [[GridRowModel]] values.
+     */
+    field: string;
+    /**
+     * The title of the column rendered in the column header cell.
+     */
+    headerName?: string;
+    /**
+     * The description of the column rendered as tooltip if the column header name is not fully displayed.
+     */
+    description?: string;
+    /**
+     * Set the width of the column.
+     * @default 100
+     */
+    width?: number;
+    /**
+     * If set, it indicates that a column has fluid width. Range [0, ∞).
+     */
+    flex?: number;
+    /**
+     * Sets the minimum width of a column.
+     * @default 50
+     */
+    minWidth?: number;
+    /**
+     * Sets the maximum width of a column.
+     * @default Infinity
+     */
+    maxWidth?: number;
+    /**
+     * If `true`, hide the column.
+     * @deprecated Use the `columnVisibility` prop instead.
+     * @default false
+     */
+    hide?: boolean;
+    /**
+     * If `false`, removes the buttons for hiding this column.
+     * @default true
+     */
+    hideable?: boolean;
+    /**
+     * If `true`, the column is sortable.
+     * @default true
+     */
+    sortable?: boolean;
+    /**
+     * The order of the sorting sequence.
+     */
+    sortingOrder?: GridSortDirection[];
+    /**
+     * If `true`, the column is resizable.
+     * @default true
+     */
+    resizable?: boolean;
+    /**
+     * If `true`, the cells of the column are editable.
+     * @default false
+     */
+    editable?: boolean;
+    /**
+     * If `true`, the rows can be grouped based on this column values (pro-plan only).
+     * @default true
+     */
+    groupable?: boolean;
+    /**
+     * If `false`, the menu items for column pinning menu will not be rendered.
+     * Only available in DataGridPro.
+     * @default true
+     */
+    pinnable?: boolean;
+    /**
+     * A comparator function used to sort rows.
+     */
+    sortComparator?: GridComparatorFn;
+    /**
+     * Type allows to merge this object with a default definition [[GridColDef]].
+     * @default 'string'
+     */
+    type?: GridColType;
+    /**
+     * To be used in combination with `type: 'singleSelect'`. This is an array (or a function returning an array) of the possible cell values and labels.
+     */
+    valueOptions?: Array<ValueOptions> | ((params: GridValueOptionsParams) => Array<ValueOptions>);
+    /**
+     * Allows to align the column values in cells.
+     */
+    align?: GridAlignment;
+    /**
+     * Function that allows to get a specific data instead of field to render in the cell.
+     * @param {GridValueGetterParams} params Object containing parameters for the getter.
+     * @returns {GridCellValue} The cell value.
+     */
+    valueGetter?: (params: GridValueGetterParams) => GridCellValue;
+    /**
+     * Function that allows to customize how the entered value is stored in the row.
+     * It only works with cell/row editing.
+     * @param {GridValueSetterParams} params Object containing parameters for the setter.
+     * @returns {GridRowModel} The row with the updated field.
+     */
+    valueSetter?: (params: GridValueSetterParams) => GridRowModel;
+    /**
+     * Function that allows to apply a formatter before rendering its value.
+     * @param {GridValueFormatterParams} params Object containing parameters for the formatter.
+     * @returns {GridCellValue} The formatted value.
+     */
+    valueFormatter?: (params: GridValueFormatterParams) => GridCellValue;
+    /**
+     * Function that takes the user-entered value and converts it to a value used internally.
+     * @param {GridCellValue} value The user-entered value.
+     * @param {GridCellParams} params The params when called before saving the value.
+     * @returns {GridCellValue} The converted value to use internally.
+     */
+    valueParser?: (value: GridCellValue, params?: GridCellParams) => GridCellValue;
+    /**
+     * Class name that will be added in cells for that column.
+     */
+    cellClassName?: GridCellClassNamePropType;
+    /**
+     * Allows to override the component rendered as cell for this column.
+     * @param {GridRenderCellParams} params Object containing parameters for the renderer.
+     * @returns {React.ReactNode} The element to be rendered.
+     */
+    renderCell?: (params: GridRenderCellParams) => React.ReactNode;
+    /**
+     * Allows to override the component rendered in edit cell mode for this column.
+     * @param {GridRenderEditCellParams} params Object containing parameters for the renderer.
+     * @returns {React.ReactNode} The element to be rendered.
+     */
+    renderEditCell?: (params: GridRenderEditCellParams) => React.ReactNode;
+    /**
+     * Callback fired when the edit props of the cell changes.
+     * It allows to process the props that saved into the state.
+     * @param {GridPreProcessEditCellProps} params Object containing parameters of the cell being edited.
+     * @returns {GridEditCellProps | Promise<GridEditCellProps>} The new edit cell props.
+     */
+    preProcessEditCellProps?: (params: GridPreProcessEditCellProps) => GridEditCellProps | Promise<GridEditCellProps>;
+    /**
+     * Class name that will be added in the column header cell.
+     */
+    headerClassName?: GridColumnHeaderClassNamePropType;
+    /**
+     * Allows to render a component in the column header cell.
+     * @param {GridColumnHeaderParams} params Object containing parameters for the renderer.
+     * @returns {React.ReactNode} The element to be rendered.
+     */
+    renderHeader?: (params: GridColumnHeaderParams) => React.ReactNode;
+    /**
+     * Header cell element alignment.
+     */
+    headerAlign?: GridAlignment;
+    /**
+     * Toggle the visibility of the sort icons.
+     * @default false
+     */
+    hideSortIcons?: boolean;
+    /**
+     * If `true`, the column menu is disabled for this column.
+     * @default false
+     */
+    disableColumnMenu?: boolean;
+    /**
+     * If `true`, the column is filterable.
+     * @default true
+     */
+    filterable?: boolean;
+    /**
+     * Allows setting the filter operators for this column.
+     */
+    filterOperators?: GridFilterOperator[];
+    /**
+     * If `true`, this column cannot be reordered.
+     * @default false
+     */
+    disableReorder?: boolean;
+    /**
+     * If `true`, this column will not be included in exports.
+     * @default false
+     */
+    disableExport?: boolean;
+}
+export interface GridActionsColDef extends GridColDef {
+    /**
+     * Type allows to merge this object with a default definition [[GridColDef]].
+     * @default 'actions'
+     */
+    type: 'actions';
+    /**
+     * Function that returns the actions to be shown.
+     * @param {GridRowParams} params The params for each row.
+     * @returns {React.ReactElement<GridActionsCellItemProps>[]} An array of [[GridActionsCell]] elements.
+     */
+    getActions: (params: GridRowParams) => React.ReactElement<GridActionsCellItemProps>[];
+}
+export declare type GridEnrichedColDef = GridColDef | GridActionsColDef;
+export declare type GridColumns = GridEnrichedColDef[];
+export declare type GridColTypeDef = Omit<GridColDef, 'field'> & {
+    extendType?: GridNativeColTypes;
+};
+export declare type GridStateColDef = GridEnrichedColDef & {
+    computedWidth: number;
+    /**
+     * If `true`, it means that at least one of the dimension's property of this column has been modified since the last time the column prop has changed.
+     */
+    hasBeenResized?: boolean;
+};
+/**
+ * Meta Info about columns.
+ */
+export interface GridColumnsMeta {
+    totalWidth: number;
+    positions: number[];
+}

package/models/colDef/gridColDef.js

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

package/models/colDef/gridColType.d.ts

@@ -0,0 +1,2 @@
+export declare type GridNativeColTypes = 'string' | 'number' | 'date' | 'dateTime' | 'boolean' | 'singleSelect' | 'actions';
+export declare type GridColType = GridNativeColTypes | string;

package/models/colDef/gridColType.js

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

package/models/colDef/gridColumnTypesRecord.d.ts

@@ -0,0 +1,3 @@
+import { GridColTypeDef } from './gridColDef';
+import { GridColType } from './gridColType';
+export declare type GridColumnTypesRecord = Record<GridColType, GridColTypeDef>;

package/models/colDef/gridColumnTypesRecord.js

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

package/models/colDef/gridDefaultColumnTypes.d.ts

@@ -0,0 +1,3 @@
+import { GridColumnTypesRecord } from './gridColumnTypesRecord';
+export declare const DEFAULT_GRID_COL_TYPE_KEY = "__default__";
+export declare const getGridDefaultColumnTypes: () => GridColumnTypesRecord;

package/models/colDef/gridDefaultColumnTypes.js

@@ -0,0 +1,20 @@
+import { GRID_STRING_COL_DEF } from '../../colDef/gridStringColDef';
+import { GRID_NUMERIC_COL_DEF } from '../../colDef/gridNumericColDef';
+import { GRID_DATE_COL_DEF, GRID_DATETIME_COL_DEF } from '../../colDef/gridDateColDef';
+import { GRID_BOOLEAN_COL_DEF } from '../../colDef/gridBooleanColDef';
+import { GRID_SINGLE_SELECT_COL_DEF } from '../../colDef/gridSingleSelectColDef';
+import { GRID_ACTIONS_COL_DEF, GRID_ACTIONS_COLUMN_TYPE } from '../../colDef/gridActionsColDef';
+export const DEFAULT_GRID_COL_TYPE_KEY = '__default__';
+export const getGridDefaultColumnTypes = () => {
+  const nativeColumnTypes = {
+    string: GRID_STRING_COL_DEF,
+    number: GRID_NUMERIC_COL_DEF,
+    date: GRID_DATE_COL_DEF,
+    dateTime: GRID_DATETIME_COL_DEF,
+    boolean: GRID_BOOLEAN_COL_DEF,
+    singleSelect: GRID_SINGLE_SELECT_COL_DEF,
+    [GRID_ACTIONS_COLUMN_TYPE]: GRID_ACTIONS_COL_DEF,
+    [DEFAULT_GRID_COL_TYPE_KEY]: GRID_STRING_COL_DEF
+  };
+  return nativeColumnTypes;
+};

package/models/colDef/index.d.ts

@@ -0,0 +1,4 @@
+export * from './gridColDef';
+export * from './gridColType';
+export * from './gridColumnTypesRecord';
+export * from './gridDefaultColumnTypes';

package/models/colDef/index.js

@@ -0,0 +1,6 @@
+// ColDef
+export * from './gridColDef'; // Other types
+
+export * from './gridColType';
+export * from './gridColumnTypesRecord';
+export * from './gridDefaultColumnTypes';

package/models/controlStateItem.d.ts

@@ -0,0 +1,14 @@
+import { GridCallbackDetails } from './api/gridCallbackDetails';
+import type { GridEventLookup, GridControlledStateEventLookup } from './events';
+import type { OutputSelector } from '../utils/createSelector';
+import { GridStateCommunity } from './gridStateCommunity';
+export interface GridControlStateItem<State extends GridStateCommunity, E extends keyof GridControlledStateEventLookup> {
+    stateId: string;
+    propModel?: GridEventLookup[E]['params'];
+    stateSelector: OutputSelector<{
+        state: State;
+        instanceId: string;
+    }, GridControlledStateEventLookup[E]['params']> | ((state: State) => GridControlledStateEventLookup[E]['params']);
+    propOnChange?: (model: GridControlledStateEventLookup[E]['params'], details: GridCallbackDetails) => void;
+    changeEvent: E;
+}

package/models/controlStateItem.js

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

package/models/cursorCoordinates.d.ts

@@ -0,0 +1,4 @@
+export interface CursorCoordinates {
+    x: number;
+    y: number;
+}

package/models/cursorCoordinates.js

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

package/models/elementSize.d.ts

@@ -0,0 +1,13 @@
+/**
+ * The size of a container.
+ */
+export interface ElementSize {
+    /**
+     * The height of a container or HTMLElement.
+     */
+    height: number;
+    /**
+     * The width of a container or HTMLElement.
+     */
+    width: number;
+}

package/models/elementSize.js

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

package/models/events/gridEventListener.d.ts

@@ -0,0 +1,9 @@
+import { MuiBaseEvent, MuiEvent } from '../muiEvent';
+import { GridCallbackDetails } from '../api/gridCallbackDetails';
+import { GridEventsStr } from './gridEvents';
+import { GridEventLookup } from './gridEventLookup';
+export declare type GridEventListener<E extends GridEventsStr> = (params: GridEventLookup[E] extends {
+    params: any;
+} ? GridEventLookup[E]['params'] : undefined, event: GridEventLookup[E] extends {
+    event: MuiBaseEvent;
+} ? MuiEvent<GridEventLookup[E]['event']> : MuiEvent<{}>, details: GridCallbackDetails) => void;

package/models/events/gridEventListener.js

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