[DataGrid] Export GridColumnHeadersProps (#13229)

mui · May 24, 2024 · 6d95073 · 6d95073
1 parent 81f6db7
commit 6d95073
Show file tree

Hide file tree

Showing 11 changed files with 12 additions and 6 deletions.
diff --git a/docs/pages/x/api/data-grid/data-grid-premium.json b/docs/pages/x/api/data-grid/data-grid-premium.json
@@ -673,7 +673,7 @@
     {
       "name": "columnHeaders",
       "description": "Component responsible for rendering the column headers.",
-      "default": "DataGridColumnHeaders",
+      "default": "GridColumnHeaders",
       "class": "MuiDataGridPremium-columnHeaders"
     },
     {

diff --git a/docs/pages/x/api/data-grid/data-grid-pro.json b/docs/pages/x/api/data-grid/data-grid-pro.json
@@ -608,7 +608,7 @@
     {
       "name": "columnHeaders",
       "description": "Component responsible for rendering the column headers.",
-      "default": "DataGridColumnHeaders",
+      "default": "GridColumnHeaders",
       "class": "MuiDataGridPro-columnHeaders"
     },
     {

diff --git a/docs/pages/x/api/data-grid/data-grid.json b/docs/pages/x/api/data-grid/data-grid.json
@@ -506,7 +506,7 @@
     {
       "name": "columnHeaders",
       "description": "Component responsible for rendering the column headers.",
-      "default": "DataGridColumnHeaders",
+      "default": "GridColumnHeaders",
       "class": "MuiDataGrid-columnHeaders"
     },
     {

diff --git a/packages/x-data-grid-premium/src/index.ts b/packages/x-data-grid-premium/src/index.ts
@@ -25,6 +25,7 @@ export * from './models';
 export * from './components';
 
 export { GridColumnHeaders } from '@mui/x-data-grid-pro';
+export type { GridColumnHeadersProps } from '@mui/x-data-grid-pro';
 
 export type {
   DataGridPremiumProps,

diff --git a/packages/x-data-grid-pro/src/components/GridColumnHeaders.tsx b/packages/x-data-grid-pro/src/components/GridColumnHeaders.tsx
@@ -9,11 +9,11 @@ const Filler = styled('div')({
   backgroundColor: 'var(--DataGrid-containerBackground)',
 });
 
-interface DataGridProColumnHeadersProps
+export interface GridColumnHeadersProps
   extends React.HTMLAttributes<HTMLDivElement>,
     UseGridColumnHeadersProps {}
 
-const GridColumnHeaders = React.forwardRef<HTMLDivElement, DataGridProColumnHeadersProps>(
+const GridColumnHeaders = React.forwardRef<HTMLDivElement, GridColumnHeadersProps>(
   function GridColumnHeaders(props, ref) {
     const {
       style,

diff --git a/packages/x-data-grid-pro/src/index.ts b/packages/x-data-grid-pro/src/index.ts
@@ -38,3 +38,4 @@ export {
 } from './components/reexports';
 
 export { GridColumnHeaders } from './components/GridColumnHeaders';
+export type { GridColumnHeadersProps } from './components/GridColumnHeaders';
diff --git a/packages/x-data-grid/src/index.ts b/packages/x-data-grid/src/index.ts
@@ -20,6 +20,7 @@ export type { GridToolbarExportProps } from './components/toolbar/GridToolbarExp
 export type { GridExportFormat, GridExportExtension } from './models/gridExport';
 
 export { GridColumnHeaders } from './components/GridColumnHeaders';
+export type { GridColumnHeadersProps } from './components/GridColumnHeaders';
 
 /**
  * Reexportable components.

diff --git a/packages/x-data-grid/src/models/gridSlotsComponent.ts b/packages/x-data-grid/src/models/gridSlotsComponent.ts
@@ -100,7 +100,7 @@ export interface GridSlotsComponent extends GridBaseSlots, GridIconSlotsComponen
   columnMenu: React.JSXElementConstructor<GridSlotProps['columnMenu']>;
   /**
    * Component responsible for rendering the column headers.
-   * @default DataGridColumnHeaders
+   * @default GridColumnHeaders
    */
   columnHeaders: React.JSXElementConstructor<GridSlotProps['columnHeaders']>;
   /**

diff --git a/scripts/x-data-grid-premium.exports.json b/scripts/x-data-grid-premium.exports.json
@@ -175,6 +175,7 @@
   { "name": "GridColumnHeaderSeparatorSides", "kind": "Enum" },
   { "name": "GridColumnHeaderSortIcon", "kind": "Variable" },
   { "name": "GridColumnHeaderSortIconProps", "kind": "Interface" },
+  { "name": "GridColumnHeadersProps", "kind": "Interface" },
   { "name": "GridColumnHeaderTitle", "kind": "Function" },
   { "name": "GridColumnHeaderTitleProps", "kind": "Interface" },
   { "name": "GridColumnIcon", "kind": "Variable" },

diff --git a/scripts/x-data-grid-pro.exports.json b/scripts/x-data-grid-pro.exports.json
@@ -151,6 +151,7 @@
   { "name": "GridColumnHeaderSeparatorSides", "kind": "Enum" },
   { "name": "GridColumnHeaderSortIcon", "kind": "Variable" },
   { "name": "GridColumnHeaderSortIconProps", "kind": "Interface" },
+  { "name": "GridColumnHeadersProps", "kind": "Interface" },
   { "name": "GridColumnHeaderTitle", "kind": "Function" },
   { "name": "GridColumnHeaderTitleProps", "kind": "Interface" },
   { "name": "GridColumnIcon", "kind": "Variable" },

diff --git a/scripts/x-data-grid.exports.json b/scripts/x-data-grid.exports.json
@@ -143,6 +143,7 @@
   { "name": "GridColumnHeaderSeparatorSides", "kind": "Enum" },
   { "name": "GridColumnHeaderSortIcon", "kind": "Variable" },
   { "name": "GridColumnHeaderSortIconProps", "kind": "Interface" },
+  { "name": "GridColumnHeadersProps", "kind": "Interface" },
   { "name": "GridColumnHeaderTitle", "kind": "Function" },
   { "name": "GridColumnHeaderTitleProps", "kind": "Interface" },
   { "name": "GridColumnIcon", "kind": "Variable" },