generate proptypes and api docs

mui · Oct 4, 2024 · c81f2f8 · c81f2f8
1 parent 6b1c212
commit c81f2f8
Show file tree

Hide file tree

Showing 10 changed files with 16 additions and 22 deletions.
diff --git a/docs/data/data-grid/events/events.json b/docs/data/data-grid/events/events.json
@@ -130,7 +130,7 @@
   {
     "projects": ["x-data-grid", "x-data-grid-pro", "x-data-grid-premium"],
     "name": "columnHeaderContextMenu",
-    "description": "Fired when a column header is double-clicked.",
+    "description": "Fired when the user attempts to open a context menu in the column header.",
     "params": "GridColumnHeaderParams",
     "event": "MuiEvent<React.MouseEvent<HTMLElement>>",
     "componentProp": "onColumnHeaderContextMenu"

diff --git a/docs/pages/x/api/data-grid/data-grid-premium.json b/docs/pages/x/api/data-grid/data-grid-premium.json
@@ -311,8 +311,8 @@
     "onColumnHeaderContextMenu": {
       "type": { "name": "func" },
       "signature": {
-        "type": "function(params: GridColumnHeaderParams, event: MuiEvent<React.MouseEvent>, details: GridCallbackDetails) => void",
-        "describedArgs": ["params", "event", "details"]
+        "type": "function(params: GridColumnHeaderParams, event: MuiEvent<React.MouseEvent>) => void",
+        "describedArgs": ["params", "event"]
       }
     },
     "onColumnHeaderDoubleClick": {

diff --git a/docs/pages/x/api/data-grid/data-grid-pro.json b/docs/pages/x/api/data-grid/data-grid-pro.json
@@ -265,8 +265,8 @@
     "onColumnHeaderContextMenu": {
       "type": { "name": "func" },
       "signature": {
-        "type": "function(params: GridColumnHeaderParams, event: MuiEvent<React.MouseEvent>, details: GridCallbackDetails) => void",
-        "describedArgs": ["params", "event", "details"]
+        "type": "function(params: GridColumnHeaderParams, event: MuiEvent<React.MouseEvent>) => void",
+        "describedArgs": ["params", "event"]
       }
     },
     "onColumnHeaderDoubleClick": {

diff --git a/docs/pages/x/api/data-grid/data-grid.json b/docs/pages/x/api/data-grid/data-grid.json
@@ -224,8 +224,8 @@
     "onColumnHeaderContextMenu": {
       "type": { "name": "func" },
       "signature": {
-        "type": "function(params: GridColumnHeaderParams, event: MuiEvent<React.MouseEvent>, details: GridCallbackDetails) => void",
-        "describedArgs": ["params", "event", "details"]
+        "type": "function(params: GridColumnHeaderParams, event: MuiEvent<React.MouseEvent>) => void",
+        "describedArgs": ["params", "event"]
       }
     },
     "onColumnHeaderDoubleClick": {

diff --git a/docs/translations/api-docs/data-grid/data-grid-premium/data-grid-premium.json b/docs/translations/api-docs/data-grid/data-grid-premium/data-grid-premium.json
@@ -331,11 +331,10 @@
       }
     },
     "onColumnHeaderContextMenu": {
-      "description": "Callback fired when a double click event comes from a column header element.",
+      "description": "Callback fired when a contextmenu event comes from a column header element.",
       "typeDescriptions": {
         "params": "With all properties from GridColumnHeaderParams.",
-        "event": "The event object.",
-        "details": "Additional details for this callback."
+        "event": "The event object."
       }
     },
     "onColumnHeaderDoubleClick": {

diff --git a/docs/translations/api-docs/data-grid/data-grid-pro/data-grid-pro.json b/docs/translations/api-docs/data-grid/data-grid-pro/data-grid-pro.json
@@ -288,11 +288,10 @@
       }
     },
     "onColumnHeaderContextMenu": {
-      "description": "Callback fired when a double click event comes from a column header element.",
+      "description": "Callback fired when a contextmenu event comes from a column header element.",
       "typeDescriptions": {
         "params": "With all properties from GridColumnHeaderParams.",
-        "event": "The event object.",
-        "details": "Additional details for this callback."
+        "event": "The event object."
       }
     },
     "onColumnHeaderDoubleClick": {

diff --git a/docs/translations/api-docs/data-grid/data-grid/data-grid.json b/docs/translations/api-docs/data-grid/data-grid/data-grid.json
@@ -231,11 +231,10 @@
       }
     },
     "onColumnHeaderContextMenu": {
-      "description": "Callback fired when a double click event comes from a column header element.",
+      "description": "Callback fired when a contextmenu event comes from a column header element.",
       "typeDescriptions": {
         "params": "With all properties from GridColumnHeaderParams.",
-        "event": "The event object.",
-        "details": "Additional details for this callback."
+        "event": "The event object."
       }
     },
     "onColumnHeaderDoubleClick": {

diff --git a/packages/x-data-grid-premium/src/DataGridPremium/DataGridPremium.tsx b/packages/x-data-grid-premium/src/DataGridPremium/DataGridPremium.tsx
@@ -637,10 +637,9 @@ DataGridPremiumRaw.propTypes = {
    */
   onColumnHeaderClick: PropTypes.func,
   /**
-   * Callback fired when a double click event comes from a column header element.
+   * Callback fired when a contextmenu event comes from a column header element.
    * @param {GridColumnHeaderParams} params With all properties from [[GridColumnHeaderParams]].
    * @param {MuiEvent<React.MouseEvent>} event The event object.
-   * @param {GridCallbackDetails} details Additional details for this callback.
    */
   onColumnHeaderContextMenu: PropTypes.func,
   /**

diff --git a/packages/x-data-grid-pro/src/DataGridPro/DataGridPro.tsx b/packages/x-data-grid-pro/src/DataGridPro/DataGridPro.tsx
@@ -564,10 +564,9 @@ DataGridProRaw.propTypes = {
    */
   onColumnHeaderClick: PropTypes.func,
   /**
-   * Callback fired when a double click event comes from a column header element.
+   * Callback fired when a contextmenu event comes from a column header element.
    * @param {GridColumnHeaderParams} params With all properties from [[GridColumnHeaderParams]].
    * @param {MuiEvent<React.MouseEvent>} event The event object.
-   * @param {GridCallbackDetails} details Additional details for this callback.
    */
   onColumnHeaderContextMenu: PropTypes.func,
   /**

diff --git a/packages/x-data-grid/src/DataGrid/DataGrid.tsx b/packages/x-data-grid/src/DataGrid/DataGrid.tsx
@@ -478,10 +478,9 @@ DataGridRaw.propTypes = {
    */
   onColumnHeaderClick: PropTypes.func,
   /**
-   * Callback fired when a double click event comes from a column header element.
+   * Callback fired when a contextmenu event comes from a column header element.
    * @param {GridColumnHeaderParams} params With all properties from [[GridColumnHeaderParams]].
    * @param {MuiEvent<React.MouseEvent>} event The event object.
-   * @param {GridCallbackDetails} details Additional details for this callback.
    */
   onColumnHeaderContextMenu: PropTypes.func,
   /**