@mui/x-data-grid-pro 5.5.1 → 5.7.0

package/models/dataGridProProps.d.ts

@@ -0,0 +1,174 @@
+import * as React from 'react';
+import { GridRowModel, GridRowTreeNodeConfig, GridEventListener, GridEvents, GridCallbackDetails, GridRowParams, GridRowId } from '@mui/x-data-grid';
+import { GridExperimentalFeatures, DataGridPropsWithoutDefaultValue, DataGridPropsWithDefaultValues, DataGridPropsWithComplexDefaultValueAfterProcessing, DataGridPropsWithComplexDefaultValueBeforeProcessing } from '@mui/x-data-grid/internals';
+import type { GridPinnedColumns } from '../hooks/features/columnPinning';
+import { GridApiPro } from './gridApiPro';
+import { GridGroupingColDefOverride, GridGroupingColDefOverrideParams } from './gridGroupingColDefOverride';
+import type { GridRowGroupingModel } from '../hooks/features/rowGrouping';
+import { GridInitialStatePro } from './gridStatePro';
+export interface GridExperimentalProFeatures extends GridExperimentalFeatures {
+    /**
+     * Will be part of the premium-plan when fully ready.
+     */
+    rowGrouping: boolean;
+}
+/**
+ * The props users can give to the `DataGridProProps` component.
+ */
+export interface DataGridProProps extends Omit<Partial<DataGridProPropsWithDefaultValue> & DataGridPropsWithComplexDefaultValueBeforeProcessing & DataGridProPropsWithoutDefaultValue, DataGridProForcedPropsKey> {
+    /**
+     * Features under development.
+     * For each feature, if the flag is not explicitly set to `true`, the feature will be fully disabled and any property / method call will not have any effect.
+     */
+    experimentalFeatures?: Partial<GridExperimentalProFeatures>;
+}
+/**
+ * The props of the `DataGridPro` component after the pre-processing phase.
+ */
+export interface DataGridProProcessedProps extends DataGridProPropsWithDefaultValue, DataGridPropsWithComplexDefaultValueAfterProcessing, DataGridProPropsWithoutDefaultValue {
+}
+export declare type DataGridProForcedPropsKey = 'signature';
+/**
+ * The `DataGridPro` options with a default value overridable through props
+ * None of the entry of this interface should be optional, they all have default values and `DataGridProps` already applies a `Partial<DataGridSimpleOptions>` for the public interface
+ * The controlled model do not have a default value at the prop processing level, so they must be defined in `DataGridOtherProps`
+ */
+export interface DataGridProPropsWithDefaultValue extends DataGridPropsWithDefaultValues {
+    /**
+     * Set the area in `px` at the bottom of the grid viewport where onRowsScrollEnd is called.
+     * @default 80
+     */
+    scrollEndThreshold: number;
+    /**
+     * If `true`, the rows will be gathered in a tree structure according to the `getTreeDataPath` prop.
+     * @default false
+     */
+    treeData: boolean;
+    /**
+     * If above 0, the row children will be expanded up to this depth.
+     * If equal to -1, all the row children will be expanded.
+     * @default 0
+     */
+    defaultGroupingExpansionDepth: number;
+    /**
+     * Determines if a group should be expanded after its creation.
+     * This prop takes priority over the `defaultGroupingExpansionDepth` prop.
+     * @param {GridRowTreeNodeConfig} node The node of the group to test.
+     * @returns {boolean} A boolean indicating if the group is expanded.
+     */
+    isGroupExpandedByDefault?: (node: GridRowTreeNodeConfig) => boolean;
+    /**
+     * If `true`, the column pinning is disabled.
+     * @default false
+     */
+    disableColumnPinning: boolean;
+    /**
+     * If `true`, the filtering will only be applied to the top level rows when grouping rows with the `treeData` prop.
+     * @default false
+     */
+    disableChildrenFiltering: boolean;
+    /**
+     * If `true`, the sorting will only be applied to the top level rows when grouping rows with the `treeData` prop.
+     * @default false
+     */
+    disableChildrenSorting: boolean;
+    /**
+     * If `true`, the row grouping is disabled.
+     * @default false
+     */
+    disableRowGrouping: boolean;
+    /**
+     * If `single`, all column we are grouping by will be represented in the same grouping the same column.
+     * If `multiple`, each column we are grouping by will be represented in its own column.
+     * @default 'single'
+     */
+    rowGroupingColumnMode: 'single' | 'multiple';
+    /**
+     * Function that returns the height of the row detail panel.
+     * @param {GridRowParams} params With all properties from [[GridRowParams]].
+     * @returns {number} The height in pixels.
+     * @default "() => 500"
+     */
+    getDetailPanelHeight: (params: GridRowParams) => number;
+}
+export interface DataGridProPropsWithoutDefaultValue extends Omit<DataGridPropsWithoutDefaultValue, 'initialState'> {
+    /**
+     * The ref object that allows grid manipulation. Can be instantiated with [[useGridApiRef()]].
+     */
+    apiRef?: React.MutableRefObject<GridApiPro>;
+    /**
+     * The initial state of the DataGridPro.
+     * The data in it will be set in the state on initialization but will not be controlled.
+     * If one of the data in `initialState` is also being controlled, then the control state wins.
+     */
+    initialState?: GridInitialStatePro;
+    /**
+     * Determines the path of a row in the tree data.
+     * For instance, a row with the path ["A", "B"] is the child of the row with the path ["A"].
+     * Note that all paths must contain at least one element.
+     * @param {GridRowModel} row The row from which we want the path.
+     * @returns {string[]} The path to the row.
+     */
+    getTreeDataPath?: (row: GridRowModel) => string[];
+    /**
+     * Callback fired while a column is being resized.
+     * @param {GridColumnResizeParams} params With all properties from [[GridColumnResizeParams]].
+     * @param {MuiEvent<React.MouseEvent>} event The event object.
+     * @param {GridCallbackDetails} details Additional details for this callback.
+     */
+    onColumnResize?: GridEventListener<GridEvents.columnResize>;
+    /**
+     * Callback fired when the width of a column is changed.
+     * @param {GridColumnResizeParams} params With all properties from [[GridColumnResizeParams]].
+     * @param {MuiEvent<React.MouseEvent>} event The event object.
+     * @param {GridCallbackDetails} details Additional details for this callback.
+     */
+    onColumnWidthChange?: GridEventListener<GridEvents.columnWidthChange>;
+    /**
+     * Callback fired when scrolling to the bottom of the grid viewport.
+     * @param {GridRowScrollEndParams} params With all properties from [[GridRowScrollEndParams]].
+     * @param {MuiEvent<{}>} event The event object.
+     * @param {GridCallbackDetails} details Additional details for this callback.
+     */
+    onRowsScrollEnd?: GridEventListener<GridEvents.rowsScrollEnd>;
+    /**
+     * The column fields to display pinned to left or right.
+     */
+    pinnedColumns?: GridPinnedColumns;
+    /**
+     * Callback fired when the pinned columns have changed.
+     * @param {GridPinnedColumns} pinnedColumns The changed pinned columns.
+     * @param {GridCallbackDetails} details Additional details for this callback.
+     */
+    onPinnedColumnsChange?: (pinnedColumns: GridPinnedColumns, details: GridCallbackDetails) => void;
+    /**
+     * Set the row grouping model of the grid.
+     */
+    rowGroupingModel?: GridRowGroupingModel;
+    /**
+     * Callback fired when the row grouping model changes.
+     * @param {GridRowGroupingModel} model Columns used as grouping criteria.
+     * @param {GridCallbackDetails} details Additional details for this callback.
+     */
+    onRowGroupingModelChange?: (model: GridRowGroupingModel, details: GridCallbackDetails) => void;
+    /**
+     * The grouping column used by the tree data.
+     */
+    groupingColDef?: GridGroupingColDefOverride | ((params: GridGroupingColDefOverrideParams) => GridGroupingColDefOverride | undefined | null);
+    /**
+     * The row ids to show the detail panel.
+     */
+    detailPanelExpandedRowIds?: GridRowId[];
+    /**
+     * Callback fired when the detail panel of a row is opened or closed.
+     * @param {GridRowId[]} ids The ids of the rows which have the detail panel open.
+     * @param {GridCallbackDetails} details Additional details for this callback.
+     */
+    onDetailPanelExpandedRowIdsChange?: (ids: GridRowId[], details: GridCallbackDetails) => void;
+    /**
+     * Function that returns the element to render in row detail.
+     * @param {GridRowParams} params With all properties from [[GridRowParams]].
+     * @returns {JSX.Element} The row detail element.
+     */
+    getDetailPanelContent?: (params: GridRowParams) => React.ReactNode;
+}

package/models/dataGridProProps.js

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

package/models/gridApiPro.d.ts

@@ -0,0 +1,12 @@
+import { GridApiCommon, GridStateApi, GridStatePersistenceApi } from '@mui/x-data-grid';
+import { GridInitialStatePro, GridStatePro } from './gridStatePro';
+import type { GridColumnPinningApi, GridRowGroupingApi, GridDetailPanelApi } from '../hooks';
+declare type GridStateApiUntyped = {
+    [key in keyof (GridStateApi<any> & GridStatePersistenceApi<any>)]: any;
+};
+/**
+ * The api of `DataGridPro`.
+ */
+export interface GridApiPro extends Omit<GridApiCommon, keyof GridStateApiUntyped>, GridStateApi<GridStatePro>, GridStatePersistenceApi<GridInitialStatePro>, GridRowGroupingApi, GridColumnPinningApi, GridDetailPanelApi {
+}
+export {};

package/models/gridApiPro.js

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

package/models/gridGroupingColDefOverride.d.ts

@@ -0,0 +1,30 @@
+import { GridColDef } from '@mui/x-data-grid';
+export interface GridGroupingColDefOverride extends Omit<GridColDef, 'editable' | 'valueSetter' | 'field' | 'type' | 'preProcessEditCellProps' | 'renderEditCell' | 'groupable'> {
+    /**
+     * The field from which we want to apply the sorting and the filtering for the grouping column.
+     * It is only useful when `props.rowGroupingColumnMode === "multiple"` to decide which grouping criteria should be used for sorting and filtering.
+     * Do not have any effect when building the tree with the `props.treeData` feature.
+     * @default: The sorting and filtering is applied based on the leaf field in any, otherwise based on top level grouping criteria.
+     */
+    mainGroupingCriteria?: string;
+    /**
+     * The field from which we want to render the leaves of the tree.
+     * Do not have any effect when building the tree with the `props.treeData` feature.
+     */
+    leafField?: string;
+    /**
+     * If `true`, the grouping cells will not render the amount of descendants.
+     * @default: false
+     */
+    hideDescendantCount?: boolean;
+}
+export interface GridGroupingColDefOverrideParams {
+    /**
+     * The name of the grouping algorithm currently building the grouping column.
+     */
+    groupingName: string;
+    /**
+     * The fields of the columns from which we want to group the values on this new grouping column.
+     */
+    fields: string[];
+}

package/models/gridGroupingColDefOverride.js

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

package/models/gridGroupingValueGetterParams.d.ts

@@ -0,0 +1,31 @@
+import { GridRowId, GridRowModel, GridRowTreeNodeConfig, GridColDef, GridStateColDef } from '@mui/x-data-grid';
+/**
+ * Parameters passed to `colDef.groupingValueGetter`.
+ */
+export interface GridGroupingValueGetterParams<V = any, R = any> {
+    /**
+     * The grid row id.
+     */
+    id: GridRowId;
+    /**
+     * The column field of the cell that triggered the event.
+     */
+    field: string;
+    /**
+     * The cell value, does not take `valueGetter` into account.
+     */
+    value: V;
+    /**
+     * The row model of the row that the current cell belongs to.
+     */
+    row: GridRowModel<R>;
+    /**
+     * The column of the row that the current cell belongs to.
+     */
+    colDef: GridColDef | GridStateColDef;
+    /**
+     * The node of the row that the current cell belongs to.
+     * It only contains the information available before the actual grouping.
+     */
+    rowNode: Pick<GridRowTreeNodeConfig, 'id' | 'isAutoGenerated'>;
+}

package/models/gridGroupingValueGetterParams.js

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

package/models/gridRowScrollEndParams.d.ts

@@ -0,0 +1,18 @@
+import { GridColumns } from '@mui/x-data-grid';
+/**
+ * Object passed as parameter in the onRowsScrollEnd callback.
+ */
+export interface GridRowScrollEndParams {
+    /**
+     * The number of rows that fit in the viewport.
+     */
+    viewportPageSize: number;
+    /**
+     * The number of rows allocated for the rendered zone.
+     */
+    virtualRowsCount: number;
+    /**
+     * The grid visible columns.
+     */
+    visibleColumns: GridColumns;
+}

package/models/gridRowScrollEndParams.js

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

package/models/gridStatePro.d.ts

@@ -0,0 +1,20 @@
+import { GridInitialState as GridInitialStateCommunity, GridState as GridStateCommunity } from '@mui/x-data-grid';
+import type { GridRowGroupingState, GridDetailPanelState, GridDetailPanelInitialState, GridColumnReorderState, GridColumnResizeState, GridColumnPinningState, GridRowGroupingInitialState } from '../hooks';
+/**
+ * The state of `DataGridPro`.
+ */
+export interface GridStatePro extends GridStateCommunity {
+    columnReorder: GridColumnReorderState;
+    columnResize: GridColumnResizeState;
+    pinnedColumns: GridColumnPinningState;
+    rowGrouping: GridRowGroupingState;
+    detailPanel: GridDetailPanelState;
+}
+/**
+ * The initial state of `DataGridPro`.
+ */
+export interface GridInitialStatePro extends GridInitialStateCommunity {
+    rowGrouping?: GridRowGroupingInitialState;
+    pinnedColumns?: GridColumnPinningState;
+    detailPanel?: GridDetailPanelInitialState;
+}

package/models/gridStatePro.js

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

package/models/index.d.ts

@@ -0,0 +1,4 @@
+export * from './gridGroupingColDefOverride';
+export type { DataGridProProps } from './dataGridProProps';
+export * from './gridRowScrollEndParams';
+export * from './gridGroupingValueGetterParams';

package/models/index.js

@@ -0,0 +1,4 @@
+export * from './gridGroupingColDefOverride';
+export * from './gridRowScrollEndParams';
+export * from './gridGroupingValueGetterParams';
+export {};

package/models/package.json

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