[DataGrid] Rename Checkbox component and props slots to BaseCheckbox (#…

…3142)
mui · Nov 9, 2021 · 005df0e · 005df0e
1 parent 3d532fb
commit 005df0e
Show file tree

Hide file tree

Showing 13 changed files with 15 additions and 15 deletions.
diff --git a/docs/pages/api-docs/data-grid/data-grid-pro.json b/docs/pages/api-docs/data-grid/data-grid-pro.json
@@ -168,10 +168,10 @@
     "throttleRowsMs": { "type": { "name": "number" }, "default": "0" }
   },
   "slots": {
+    "BaseCheckbox": { "default": "Checkbox", "type": { "name": "elementType" } },
     "BooleanCellFalseIcon": { "default": "GridCloseIcon", "type": { "name": "elementType" } },
     "BooleanCellTrueIcon": { "default": "GridCheckIcon", "type": { "name": "elementType" } },
     "Cell": { "type": { "name": "elementType" } },
-    "Checkbox": { "default": "Checkbox", "type": { "name": "elementType" } },
     "ColumnFilteredIcon": { "default": "GridFilterAltIcon", "type": { "name": "elementType" } },
     "ColumnMenu": { "default": "GridColumnMenu", "type": { "name": "elementType" } },
     "ColumnMenuIcon": {

diff --git a/docs/pages/api-docs/data-grid/data-grid.json b/docs/pages/api-docs/data-grid/data-grid.json
@@ -140,10 +140,10 @@
     }
   },
   "slots": {
+    "BaseCheckbox": { "default": "Checkbox", "type": { "name": "elementType" } },
     "BooleanCellFalseIcon": { "default": "GridCloseIcon", "type": { "name": "elementType" } },
     "BooleanCellTrueIcon": { "default": "GridCheckIcon", "type": { "name": "elementType" } },
     "Cell": { "type": { "name": "elementType" } },
-    "Checkbox": { "default": "Checkbox", "type": { "name": "elementType" } },
     "ColumnFilteredIcon": { "default": "GridFilterAltIcon", "type": { "name": "elementType" } },
     "ColumnMenu": { "default": "GridColumnMenu", "type": { "name": "elementType" } },
     "ColumnMenuIcon": {

diff --git a/docs/translations/api-docs/data-grid/data-grid-pro-pt.json b/docs/translations/api-docs/data-grid/data-grid-pro-pt.json
@@ -387,7 +387,7 @@
   },
   "slotDescriptions": {
     "Cell": "Component rendered for each cell.",
-    "Checkbox": "The custom Checkbox component used in the grid for both header and cells.",
+    "BaseCheckbox": "The custom Checkbox component used in the grid for both header and cells.",
     "ColumnMenu": "Column menu component rendered by clicking on the 3 dots &quot;kebab&quot; icon in column headers.",
     "ErrorOverlay": "Error overlay component rendered above the grid when an error is caught.",
     "Footer": "Footer component rendered at the bottom of the grid viewport.",

diff --git a/docs/translations/api-docs/data-grid/data-grid-pro-zh.json b/docs/translations/api-docs/data-grid/data-grid-pro-zh.json
@@ -387,7 +387,7 @@
   },
   "slotDescriptions": {
     "Cell": "Component rendered for each cell.",
-    "Checkbox": "The custom Checkbox component used in the grid for both header and cells.",
+    "BaseCheckbox": "The custom Checkbox component used in the grid for both header and cells.",
     "ColumnMenu": "Column menu component rendered by clicking on the 3 dots &quot;kebab&quot; icon in column headers.",
     "ErrorOverlay": "Error overlay component rendered above the grid when an error is caught.",
     "Footer": "Footer component rendered at the bottom of the grid viewport.",

diff --git a/docs/translations/api-docs/data-grid/data-grid-pro.json b/docs/translations/api-docs/data-grid/data-grid-pro.json
@@ -387,7 +387,7 @@
   },
   "slotDescriptions": {
     "Cell": "Component rendered for each cell.",
-    "Checkbox": "The custom Checkbox component used in the grid for both header and cells.",
+    "BaseCheckbox": "The custom Checkbox component used in the grid for both header and cells.",
     "ColumnMenu": "Column menu component rendered by clicking on the 3 dots &quot;kebab&quot; icon in column headers.",
     "ErrorOverlay": "Error overlay component rendered above the grid when an error is caught.",
     "Footer": "Footer component rendered at the bottom of the grid viewport.",

diff --git a/docs/translations/api-docs/data-grid/data-grid-pt.json b/docs/translations/api-docs/data-grid/data-grid-pt.json
@@ -373,7 +373,7 @@
   },
   "slotDescriptions": {
     "Cell": "Component rendered for each cell.",
-    "Checkbox": "The custom Checkbox component used in the grid for both header and cells.",
+    "BaseCheckbox": "The custom Checkbox component used in the grid for both header and cells.",
     "ColumnMenu": "Column menu component rendered by clicking on the 3 dots &quot;kebab&quot; icon in column headers.",
     "ErrorOverlay": "Error overlay component rendered above the grid when an error is caught.",
     "Footer": "Footer component rendered at the bottom of the grid viewport.",

diff --git a/docs/translations/api-docs/data-grid/data-grid-zh.json b/docs/translations/api-docs/data-grid/data-grid-zh.json
@@ -373,7 +373,7 @@
   },
   "slotDescriptions": {
     "Cell": "Component rendered for each cell.",
-    "Checkbox": "The custom Checkbox component used in the grid for both header and cells.",
+    "BaseCheckbox": "The custom Checkbox component used in the grid for both header and cells.",
     "ColumnMenu": "Column menu component rendered by clicking on the 3 dots &quot;kebab&quot; icon in column headers.",
     "ErrorOverlay": "Error overlay component rendered above the grid when an error is caught.",
     "Footer": "Footer component rendered at the bottom of the grid viewport.",

diff --git a/docs/translations/api-docs/data-grid/data-grid.json b/docs/translations/api-docs/data-grid/data-grid.json
@@ -373,7 +373,7 @@
   },
   "slotDescriptions": {
     "Cell": "Component rendered for each cell.",
-    "Checkbox": "The custom Checkbox component used in the grid for both header and cells.",
+    "BaseCheckbox": "The custom Checkbox component used in the grid for both header and cells.",
     "ColumnMenu": "Column menu component rendered by clicking on the 3 dots &quot;kebab&quot; icon in column headers.",
     "ErrorOverlay": "Error overlay component rendered above the grid when an error is caught.",
     "Footer": "Footer component rendered at the bottom of the grid viewport.",

diff --git a/packages/grid/_modules_/grid/components/columnSelection/GridCellCheckboxRenderer.tsx b/packages/grid/_modules_/grid/components/columnSelection/GridCellCheckboxRenderer.tsx
@@ -73,7 +73,7 @@ const GridCellCheckboxForwardRef = React.forwardRef<HTMLInputElement, GridCellPa
       !rootProps.isRowSelectable || rootProps.isRowSelectable(apiRef.current.getRowParams(id));
 
     return (
-      <rootProps.components.Checkbox
+      <rootProps.components.BaseCheckbox
         ref={handleRef}
         tabIndex={tabIndex}
         checked={!!value}
@@ -84,7 +84,7 @@ const GridCellCheckboxForwardRef = React.forwardRef<HTMLInputElement, GridCellPa
         inputProps={{ 'aria-label': 'Select Row checkbox' }}
         onKeyDown={handleKeyDown}
         disabled={!isSelectable}
-        {...rootProps.componentsProps?.checkbox}
+        {...rootProps.componentsProps?.baseCheckbox}
       />
     );
   },

diff --git a/packages/grid/_modules_/grid/components/columnSelection/GridHeaderCheckbox.tsx b/packages/grid/_modules_/grid/components/columnSelection/GridHeaderCheckbox.tsx
@@ -118,7 +118,7 @@ const GridHeaderCheckbox = React.forwardRef<HTMLInputElement, GridColumnHeaderPa
     }, [apiRef, handleSelectionChange]);
 
     return (
-      <rootProps.components.Checkbox
+      <rootProps.components.BaseCheckbox
         ref={ref}
         indeterminate={isIndeterminate}
         checked={isChecked}
@@ -128,7 +128,7 @@ const GridHeaderCheckbox = React.forwardRef<HTMLInputElement, GridColumnHeaderPa
         inputProps={{ 'aria-label': 'Select All Rows checkbox' }}
         tabIndex={tabIndex}
         onKeyDown={handleKeyDown}
-        {...rootProps.componentsProps?.checkbox}
+        {...rootProps.componentsProps?.baseCheckbox}
       />
     );
   },

diff --git a/packages/grid/_modules_/grid/hooks/utils/useGridProcessedProps.ts b/packages/grid/_modules_/grid/hooks/utils/useGridProcessedProps.ts
@@ -57,7 +57,7 @@ const DEFAULT_GRID_ICON_SLOTS_COMPONENTS: GridIconSlotsComponent = {
 const DEFAULT_GRID_SLOTS_COMPONENTS: GridSlotsComponent = {
   ...DEFAULT_GRID_ICON_SLOTS_COMPONENTS,
   Cell: GridCell,
-  Checkbox: MUICheckbox,
+  BaseCheckbox: MUICheckbox,
   ColumnMenu: GridColumnMenu,
   ErrorOverlay,
   Footer: GridFooter,

diff --git a/packages/grid/_modules_/grid/models/gridSlotsComponent.ts b/packages/grid/_modules_/grid/models/gridSlotsComponent.ts
@@ -14,7 +14,7 @@ export interface GridSlotsComponent extends GridIconSlotsComponent {
    * The custom Checkbox component used in the grid for both header and cells.
    * @default Checkbox
    */
-  Checkbox: React.JSXElementConstructor<any>;
+  BaseCheckbox: React.JSXElementConstructor<any>;
   /**
    * Column menu component rendered by clicking on the 3 dots "kebab" icon in column headers.
    * @default GridColumnMenu

diff --git a/packages/grid/_modules_/grid/models/gridSlotsComponentsProps.ts b/packages/grid/_modules_/grid/models/gridSlotsComponentsProps.ts
@@ -2,7 +2,7 @@
  * Overrideable components props dynamically passed to the component at rendering.
  */
 export interface GridSlotsComponentsProps {
-  checkbox?: any;
+  baseCheckbox?: any;
   cell?: any;
   columnMenu?: any;
   columnsPanel?: any;