From c81f2f88d7d24466608631364d2ce7a65475b5cd Mon Sep 17 00:00:00 2001 From: Musk Zhang Date: Fri, 4 Oct 2024 23:47:06 +0800 Subject: [PATCH] generate proptypes and api docs --- docs/data/data-grid/events/events.json | 2 +- docs/pages/x/api/data-grid/data-grid-premium.json | 4 ++-- docs/pages/x/api/data-grid/data-grid-pro.json | 4 ++-- docs/pages/x/api/data-grid/data-grid.json | 4 ++-- .../data-grid/data-grid-premium/data-grid-premium.json | 5 ++--- .../api-docs/data-grid/data-grid-pro/data-grid-pro.json | 5 ++--- .../translations/api-docs/data-grid/data-grid/data-grid.json | 5 ++--- .../src/DataGridPremium/DataGridPremium.tsx | 3 +-- packages/x-data-grid-pro/src/DataGridPro/DataGridPro.tsx | 3 +-- packages/x-data-grid/src/DataGrid/DataGrid.tsx | 3 +-- 10 files changed, 16 insertions(+), 22 deletions(-) diff --git a/docs/data/data-grid/events/events.json b/docs/data/data-grid/events/events.json index 4dc84a1ebd025..a2831d2974c28 100644 --- 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>", "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 index 3ccc3500c3734..eaf4225a6bc54 100644 --- 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, details: GridCallbackDetails) => void", - "describedArgs": ["params", "event", "details"] + "type": "function(params: GridColumnHeaderParams, event: MuiEvent) => 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 index 19b74a2e90c9f..3159d306cca73 100644 --- 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, details: GridCallbackDetails) => void", - "describedArgs": ["params", "event", "details"] + "type": "function(params: GridColumnHeaderParams, event: MuiEvent) => 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 index 4236d23c47dc5..ea08b157a8bcc 100644 --- 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, details: GridCallbackDetails) => void", - "describedArgs": ["params", "event", "details"] + "type": "function(params: GridColumnHeaderParams, event: MuiEvent) => 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 index a1515bb3d791a..087857ca51024 100644 --- 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 index 6316cbfc46c19..ed22eed2e9d61 100644 --- 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 index 0a60a76a0ad90..fc5c8f38080da 100644 --- 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 index 406b28ca35020..9dbc60dd31973 100644 --- 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} 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 index c70c16aaae4df..74015fc3f5a59 100644 --- 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} 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 index bb5901a0f4211..8fbe9009c8ff4 100644 --- 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} event The event object. - * @param {GridCallbackDetails} details Additional details for this callback. */ onColumnHeaderContextMenu: PropTypes.func, /**