[DataGrid Pro]: export GridRowReorderCell (#14079)

Signed-off-by: Michel Engelen <[email protected]> Signed-off-by: Gene Arch <[email protected]> Co-authored-by: Michel Engelen <[email protected]> Co-authored-by: Olivier Tassinari <[email protected]> Co-authored-by: Rom Grk <[email protected]> Co-authored-by: Gene Arch <[email protected]>
mui · Aug 25, 2024 · 3f90e76 · 3f90e76
1 parent b321b40
commit 3f90e76
Show file tree

Hide file tree

Showing 5 changed files with 77 additions and 1 deletion.
diff --git a/packages/x-data-grid-premium/src/hooks/features/aggregation/gridAggregationInterfaces.ts b/packages/x-data-grid-premium/src/hooks/features/aggregation/gridAggregationInterfaces.ts
@@ -74,7 +74,7 @@ export interface GridAggregationFunction<V = any, AV = V> {
   getCellValue?: (params: GridAggregationGetCellValueParams) => V;
 }
 
-interface GridAggregationParams<V = any> {
+export interface GridAggregationParams<V = any> {
   values: (V | undefined)[];
   groupId: GridRowId;
   field: GridColDef['field'];

diff --git a/packages/x-data-grid-pro/src/components/GridRowReorderCell.tsx b/packages/x-data-grid-pro/src/components/GridRowReorderCell.tsx
@@ -1,4 +1,5 @@
 import * as React from 'react';
+import PropTypes from 'prop-types';
 import composeClasses from '@mui/utils/composeClasses';
 import {
   GridRenderCellParams,
@@ -96,6 +97,75 @@ function GridRowReorderCell(params: GridRenderCellParams) {
   );
 }
 
+GridRowReorderCell.propTypes = {
+  // ----------------------------- Warning --------------------------------
+  // | These PropTypes are generated from the TypeScript type definitions |
+  // | To update them edit the TypeScript types and run "pnpm proptypes"  |
+  // ----------------------------------------------------------------------
+  /**
+   * GridApi that let you manipulate the grid.
+   */
+  api: PropTypes.object.isRequired,
+  /**
+   * The mode of the cell.
+   */
+  cellMode: PropTypes.oneOf(['edit', 'view']).isRequired,
+  /**
+   * The column of the row that the current cell belongs to.
+   */
+  colDef: PropTypes.object.isRequired,
+  /**
+   * The column field of the cell that triggered the event.
+   */
+  field: PropTypes.string.isRequired,
+  /**
+   * A ref allowing to set imperative focus.
+   * It can be passed to the element that should receive focus.
+   * @ignore - do not document.
+   */
+  focusElementRef: PropTypes.oneOfType([
+    PropTypes.func,
+    PropTypes.shape({
+      current: PropTypes.shape({
+        focus: PropTypes.func.isRequired,
+      }),
+    }),
+  ]),
+  /**
+   * The cell value formatted with the column valueFormatter.
+   */
+  formattedValue: PropTypes.any,
+  /**
+   * If true, the cell is the active element.
+   */
+  hasFocus: PropTypes.bool.isRequired,
+  /**
+   * The grid row id.
+   */
+  id: PropTypes.oneOfType([PropTypes.number, PropTypes.string]).isRequired,
+  /**
+   * If true, the cell is editable.
+   */
+  isEditable: PropTypes.bool,
+  /**
+   * The row model of the row that the current cell belongs to.
+   */
+  row: PropTypes.any.isRequired,
+  /**
+   * The node of the row that the current cell belongs to.
+   */
+  rowNode: PropTypes.object.isRequired,
+  /**
+   * the tabIndex value.
+   */
+  tabIndex: PropTypes.oneOf([-1, 0]).isRequired,
+  /**
+   * The cell value.
+   * If the column has `valueGetter`, use `params.row` to directly access the fields.
+   */
+  value: PropTypes.any,
+} as any;
+
 export { GridRowReorderCell };
 
 export const renderRowReorderCell = (params: GridRenderCellParams) => {

diff --git a/packages/x-data-grid-pro/src/components/index.ts b/packages/x-data-grid-pro/src/components/index.ts
@@ -2,5 +2,6 @@
 export * from './GridTreeDataGroupingCell';
 export * from './GridColumnMenuPinningItem';
 export * from './GridDetailPanelToggleCell';
+export * from './GridRowReorderCell';
 export * from '../material/icons';
 export * from './headerFiltering';
diff --git a/scripts/x-data-grid-premium.exports.json b/scripts/x-data-grid-premium.exports.json
@@ -95,6 +95,7 @@
   { "name": "gridAggregationLookupSelector", "kind": "Variable" },
   { "name": "GridAggregationModel", "kind": "TypeAlias" },
   { "name": "gridAggregationModelSelector", "kind": "Variable" },
+  { "name": "GridAggregationParams", "kind": "Interface" },
   { "name": "GridAggregationPosition", "kind": "TypeAlias" },
   { "name": "GridAggregationRule", "kind": "Interface" },
   { "name": "GridAggregationRules", "kind": "TypeAlias" },
@@ -528,6 +529,7 @@
   { "name": "GridRowProApi", "kind": "Interface" },
   { "name": "GridRowProPrivateApi", "kind": "Interface" },
   { "name": "GridRowProps", "kind": "Interface" },
+  { "name": "GridRowReorderCell", "kind": "Function" },
   { "name": "GridRowScrollEndParams", "kind": "Interface" },
   { "name": "gridRowsDataRowIdToIdLookupSelector", "kind": "Variable" },
   { "name": "GridRowSelectionApi", "kind": "Interface" },
@@ -648,6 +650,7 @@
   { "name": "renderEditDateCell", "kind": "Variable" },
   { "name": "renderEditInputCell", "kind": "Variable" },
   { "name": "renderEditSingleSelectCell", "kind": "Variable" },
+  { "name": "renderRowReorderCell", "kind": "Variable" },
   { "name": "RowPropsOverrides", "kind": "Interface" },
   { "name": "selectedGridRowsCountSelector", "kind": "Variable" },
   { "name": "selectedGridRowsSelector", "kind": "Variable" },

diff --git a/scripts/x-data-grid-pro.exports.json b/scripts/x-data-grid-pro.exports.json
@@ -482,6 +482,7 @@
   { "name": "GridRowProApi", "kind": "Interface" },
   { "name": "GridRowProPrivateApi", "kind": "Interface" },
   { "name": "GridRowProps", "kind": "Interface" },
+  { "name": "GridRowReorderCell", "kind": "Function" },
   { "name": "GridRowScrollEndParams", "kind": "Interface" },
   { "name": "gridRowsDataRowIdToIdLookupSelector", "kind": "Variable" },
   { "name": "GridRowSelectionApi", "kind": "Interface" },
@@ -600,6 +601,7 @@
   { "name": "renderEditDateCell", "kind": "Variable" },
   { "name": "renderEditInputCell", "kind": "Variable" },
   { "name": "renderEditSingleSelectCell", "kind": "Variable" },
+  { "name": "renderRowReorderCell", "kind": "Variable" },
   { "name": "RowPropsOverrides", "kind": "Interface" },
   { "name": "selectedGridRowsCountSelector", "kind": "Variable" },
   { "name": "selectedGridRowsSelector", "kind": "Variable" },