@mui/x-data-grid 5.4.0 → 5.6.0

package/models/api/gridLocaleTextApi.d.ts

@@ -0,0 +1,101 @@
+/// <reference types="react" />
+import { ComponentsPropsList } from '@mui/material/styles';
+/**
+ * Set the types of the texts in the grid.
+ */
+export interface GridLocaleText {
+    noRowsLabel: string;
+    noResultsOverlayLabel: string;
+    errorOverlayDefaultLabel: string;
+    toolbarDensity: React.ReactNode;
+    toolbarDensityLabel: string;
+    toolbarDensityCompact: string;
+    toolbarDensityStandard: string;
+    toolbarDensityComfortable: string;
+    toolbarColumns: React.ReactNode;
+    toolbarColumnsLabel: string;
+    toolbarFilters: React.ReactNode;
+    toolbarFiltersLabel: string;
+    toolbarFiltersTooltipHide: React.ReactNode;
+    toolbarFiltersTooltipShow: React.ReactNode;
+    toolbarFiltersTooltipActive: (count: number) => React.ReactNode;
+    toolbarExport: React.ReactNode;
+    toolbarExportLabel: string;
+    toolbarExportCSV: React.ReactNode;
+    toolbarExportPrint: React.ReactNode;
+    columnsPanelTextFieldLabel: string;
+    columnsPanelTextFieldPlaceholder: string;
+    columnsPanelDragIconLabel: string;
+    columnsPanelShowAllButton: React.ReactNode;
+    columnsPanelHideAllButton: React.ReactNode;
+    filterPanelAddFilter: React.ReactNode;
+    filterPanelDeleteIconLabel: string;
+    filterPanelLinkOperator: string;
+    filterPanelOperators: React.ReactNode;
+    filterPanelOperatorAnd: React.ReactNode;
+    filterPanelOperatorOr: React.ReactNode;
+    filterPanelColumns: React.ReactNode;
+    filterPanelInputLabel: string;
+    filterPanelInputPlaceholder: string;
+    filterOperatorContains: string;
+    filterOperatorEquals: string;
+    filterOperatorStartsWith: string;
+    filterOperatorEndsWith: string;
+    filterOperatorIs: string;
+    filterOperatorNot: string;
+    filterOperatorAfter: string;
+    filterOperatorOnOrAfter: string;
+    filterOperatorBefore: string;
+    filterOperatorOnOrBefore: string;
+    filterOperatorIsEmpty: string;
+    filterOperatorIsNotEmpty: string;
+    filterOperatorIsAnyOf: string;
+    filterValueAny: string;
+    filterValueTrue: string;
+    filterValueFalse: string;
+    columnMenuLabel: string;
+    columnMenuShowColumns: React.ReactNode;
+    columnMenuFilter: React.ReactNode;
+    columnMenuHideColumn: React.ReactNode;
+    columnMenuUnsort: React.ReactNode;
+    columnMenuSortAsc: React.ReactNode;
+    columnMenuSortDesc: React.ReactNode;
+    columnHeaderFiltersTooltipActive: (count: number) => React.ReactNode;
+    columnHeaderFiltersLabel: string;
+    columnHeaderSortIconLabel: string;
+    footerRowSelected: (count: number) => React.ReactNode;
+    footerTotalRows: React.ReactNode;
+    footerTotalVisibleRows: (visibleCount: number, totalCount: number) => React.ReactNode;
+    checkboxSelectionHeaderName: string;
+    checkboxSelectionSelectAllRows: string;
+    checkboxSelectionUnselectAllRows: string;
+    checkboxSelectionSelectRow: string;
+    checkboxSelectionUnselectRow: string;
+    booleanCellTrueLabel: string;
+    booleanCellFalseLabel: string;
+    actionsCellMore: string;
+    pinToLeft: string;
+    pinToRight: string;
+    unpin: string;
+    treeDataGroupingHeaderName: string;
+    treeDataExpand: string;
+    treeDataCollapse: string;
+    groupingColumnHeaderName: string;
+    groupColumn: (name: string) => string;
+    unGroupColumn: (name: string) => string;
+    expandDetailPanel: string;
+    collapseDetailPanel: string;
+    MuiTablePagination: Omit<ComponentsPropsList['MuiTablePagination'], 'page' | 'count' | 'onChangePage' | 'rowsPerPage' | 'onPageChange'>;
+}
+export declare type GridTranslationKeys = keyof GridLocaleText;
+/**
+ * The grid locale text API [[apiRef]].
+ */
+export interface GridLocaleTextApi {
+    /**
+     * Returns the translation for the `key`.
+     * @param {T} key One of the keys in [[GridLocaleText]].
+     * @returns {GridLocaleText[T]} The translated value.
+     */
+    getLocaleText: <T extends GridTranslationKeys>(key: T) => GridLocaleText[T];
+}

package/models/api/gridLocaleTextApi.js

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

package/models/api/gridLoggerApi.d.ts

@@ -0,0 +1,12 @@
+import { Logger } from '../logger';
+/**
+ * The logger API interface that is available in the grid `apiRef`.
+ */
+export interface GridLoggerApi {
+    /**
+     * @param {string} name The name of the logger
+     * @returns {Logger} Instance of the logger
+     * @ignore - do not document.
+     */
+    getLogger: (name: string) => Logger;
+}

package/models/api/gridLoggerApi.js

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

package/models/api/gridParamsApi.d.ts

@@ -0,0 +1,53 @@
+import { GridCellValue } from '../gridCell';
+import { GridRowId } from '../gridRows';
+import { GridCellParams } from '../params/gridCellParams';
+import { GridColumnHeaderParams } from '../params/gridColumnHeaderParams';
+import { GridRowParams } from '../params/gridRowParams';
+export interface GridParamsApi {
+    /**
+     * Gets the value of a cell at the given `id` and `field`.
+     * @param {GridRowId} id The id of the row.
+     * @param {string} field The column field.
+     * @returns {GridCellValue} The cell value.
+     */
+    getCellValue: (id: GridRowId, field: string) => GridCellValue;
+    /**
+     * Gets the underlying DOM element for a cell at the given `id` and `field`.
+     * @param {GridRowId} id The id of the row.
+     * @param {string} field The column field.
+     * @returns {HTMLDivElement | null} The DOM element or `null`.
+     */
+    getCellElement: (id: GridRowId, field: string) => HTMLDivElement | null;
+    /**
+     * Gets the [[GridCellParams]] object that is passed as argument in events.
+     * @param {GridRowId} id The id of the row.
+     * @param {string} field The column field.
+     * @returns {GridCellParams} The cell params.
+     */
+    getCellParams: <V = any, R = any, F = V>(id: GridRowId, field: string) => GridCellParams<V, R, F>;
+    /**
+     * Gets the [[GridRowParams]] object that is passed as argument in events.
+     * @param {GridRowId} id The id of the row.
+     * @param {string} field The column field.
+     * @returns {GridRowParams} The row params.
+     */
+    getRowParams: (id: GridRowId) => GridRowParams;
+    /**
+     * Gets the underlying DOM element for a row at the given `id`.
+     * @param {GridRowId} id The id of the row.
+     * @returns {HTMLDivElement | null} The DOM element or `null`.
+     */
+    getRowElement: (id: GridRowId) => HTMLDivElement | null;
+    /**
+     * Gets the underlying DOM element for the column header with the given `field`.
+     * @param {string} field The column field.
+     * @returns {HTMLDivElement | null} The DOM element or `null`.
+     */
+    getColumnHeaderElement: (field: string) => HTMLDivElement | null;
+    /**
+     * Gets the [[GridColumnHeaderParams]] object that is passed as argument in events.
+     * @param {string} field The column field.
+     * @returns {GridColumnHeaderParams} The cell params.
+     */
+    getColumnHeaderParams: (field: string) => GridColumnHeaderParams;
+}

package/models/api/gridParamsApi.js

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

package/models/api/gridPreferencesPanelApi.d.ts

@@ -0,0 +1,15 @@
+import { GridPreferencePanelsValue } from '../../hooks/features/preferencesPanel/gridPreferencePanelsValue';
+/**
+ * The preferences panel API interface that is available in the grid [[apiRef]].
+ */
+export interface GridPreferencesPanelApi {
+    /**
+     * Displays the preferences panel. The `newValue` argument controls the content of the panel.
+     * @param {GridPreferencePanelsValue} newValue The panel to open. Use `"filters"` or `"columns"`.
+     */
+    showPreferences: (newValue: GridPreferencePanelsValue) => void;
+    /**
+     * Hides the preferences panel.
+     */
+    hidePreferences: () => void;
+}

package/models/api/gridPreferencesPanelApi.js

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

package/models/api/gridPrintExportApi.d.ts

@@ -0,0 +1,11 @@
+import { GridPrintExportOptions } from '../gridExport';
+/**
+ * The Print export API interface that is available in the grid [[apiRef]].
+ */
+export interface GridPrintExportApi {
+    /**
+     * Print the grid's data.
+     * @param {GridPrintExportOptions} options The options to apply on the export.
+     */
+    exportDataAsPrint: (options?: GridPrintExportOptions) => void;
+}

package/models/api/gridPrintExportApi.js

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

package/models/api/gridRowApi.d.ts

@@ -0,0 +1,49 @@
+import { GridRowModel, GridRowId, GridRowModelUpdate, GridRowTreeNodeConfig } from '../gridRows';
+/**
+ * The Row API interface that is available in the grid `apiRef`.
+ */
+export interface GridRowApi {
+    /**
+     * Gets the full set of rows as [[Map<GridRowId, GridRowModel>]].
+     * @returns {Map<GridRowId, GridRowModel>} The full set of rows.
+     */
+    getRowModels: () => Map<GridRowId, GridRowModel>;
+    /**
+     * Gets the total number of rows in the grid.
+     * @returns {number} The number of rows.
+     */
+    getRowsCount: () => number;
+    /**
+     * Gets the list of row ids.
+     * @returns {GridRowId[]} A list of ids.
+     */
+    getAllRowIds: () => GridRowId[];
+    /**
+     * Sets a new set of rows.
+     * @param {GridRowModel[]} rows The new rows.
+     */
+    setRows: (rows: GridRowModel[]) => void;
+    /**
+     * Allows to updates, insert and delete rows in a single call.
+     * @param {GridRowModelUpdate[]} updates An array of rows with an `action` specifying what to do.
+     */
+    updateRows: (updates: GridRowModelUpdate[]) => void;
+    /**
+     * Gets the row data with a given id.
+     * @param {GridRowId} id The id of the row.
+     * @returns {GridRowModel} The row data.
+     */
+    getRow: (id: GridRowId) => GridRowModel | null;
+    /**
+     * Gets the row node from the internal tree structure.
+     * @param {GridRowId} id The id of the row.
+     * @returns {GridRowTreeNodeConfig} The row data.
+     */
+    getRowNode: (id: GridRowId) => GridRowTreeNodeConfig | null;
+    /**
+     * Expand or collapse a row children.
+     * @param {GridRowId} id the ID of the row to expand or collapse.
+     * @param {boolean} isExpanded A boolean indicating if the row must be expanded or collapsed.
+     */
+    setRowChildrenExpansion: (id: GridRowId, isExpanded: boolean) => void;
+}

package/models/api/gridRowApi.js

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

package/models/api/gridRowsMetaApi.d.ts

@@ -0,0 +1,20 @@
+import { GridRowId } from '../gridRows';
+/**
+ * The Row Meta API interface that is available in the grid `apiRef`.
+ */
+export interface GridRowsMetaApi {
+    /**
+     * Gets base row height without considering additional height a row may take.
+     * @param {GridRowId} id The id of the row.
+     * @returns {number} The target row height.
+     * @ignore - do not document.
+     */
+    unstable_getRowHeight: (id: GridRowId) => number;
+    /**
+     * Updates the base height of a row.
+     * @param {GridRowId} id The id of the row.
+     * @param {number} height The new height.
+     * @ignore - do not document.
+     */
+    unstable_setRowHeight: (id: GridRowId, height: number) => void;
+}

package/models/api/gridRowsMetaApi.js

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

package/models/api/gridScrollApi.d.ts

@@ -0,0 +1,24 @@
+import { GridCellIndexCoordinates } from '../gridCell';
+import { GridScrollParams } from '../params/gridScrollParams';
+/**
+ * The scroll API interface that is available in the grid [[apiRef]].
+ */
+export interface GridScrollApi {
+    /**
+     * Triggers the viewport to scroll to the given positions (in pixels).
+     * @param {GridScrollParams} params An object containing the `left` or `top` position to scroll.
+     */
+    scroll: (params: Partial<GridScrollParams>) => void;
+    /**
+     * Returns the current scroll position.
+     * @returns {GridScrollParams} The scroll positions.
+     */
+    getScrollPosition: () => GridScrollParams;
+    /**
+     * Triggers the viewport to scroll to the cell at indexes given by `params`.
+     * Returns `true` if the grid had to scroll to reach the target.
+     * @param {GridCellIndexCoordinates} params The indexes where the cell is.
+     * @returns {boolean} Returns `true` if the index was outside of the viewport and the grid had to scroll to reach the target.
+     */
+    scrollToIndexes: (params: Partial<GridCellIndexCoordinates>) => boolean;
+}

package/models/api/gridScrollApi.js

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

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,53 @@
+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.
+     */
+    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 } 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 {};