docs:api

mui · Mar 20, 2024 · 47e5f89 · 47e5f89
1 parent 699bb1f
commit 47e5f89
Show file tree

Hide file tree

Showing 8 changed files with 45 additions and 5 deletions.
diff --git a/docs/pages/x/api/data-grid/grid-actions-col-def.json b/docs/pages/x/api/data-grid/grid-actions-col-def.json
@@ -44,6 +44,7 @@
       "default": "false",
       "isOptional": true
     },
+    "display": { "type": { "description": "'text' | 'flex'" }, "isOptional": true },
     "editable": { "type": { "description": "boolean" }, "default": "false", "isOptional": true },
     "field": { "type": { "description": "string" } },
     "filterable": { "type": { "description": "boolean" }, "default": "true", "isOptional": true },
@@ -61,6 +62,12 @@
       "type": { "description": "GetApplyQuickFilterFn&lt;R, V&gt;" },
       "isOptional": true
     },
+    "getSortComparator": {
+      "type": {
+        "description": "(sortDirection: GridSortDirection) =&gt; GridComparatorFn&lt;V&gt; | undefined"
+      },
+      "isOptional": true
+    },
     "groupable": { "type": { "description": "boolean" }, "default": "true", "isOptional": true },
     "groupingValueGetter": {
       "type": { "description": "GridGroupingValueGetter&lt;R&gt;" },
@@ -112,7 +119,7 @@
       "isOptional": true
     },
     "renderHeaderFilter": {
-      "type": { "description": "(params: GridHeaderFilterCellProps) =&gt; React.ReactNode" },
+      "type": { "description": "(params: GridRenderHeaderFilterProps) =&gt; React.ReactNode" },
       "isOptional": true,
       "isProPlan": true
     },

diff --git a/docs/pages/x/api/data-grid/grid-api.json b/docs/pages/x/api/data-grid/grid-api.json
@@ -15,8 +15,7 @@
     },
     "applySorting": { "type": { "description": "() =&gt; void" } },
     "autosizeColumns": {
-      "type": { "description": "(options?: GridAutosizeOptions) =&gt; Promise&lt;void&gt;" },
-      "isProPlan": true
+      "type": { "description": "(options?: GridAutosizeOptions) =&gt; Promise&lt;void&gt;" }
     },
     "deleteFilterItem": { "type": { "description": "(item: GridFilterItem) =&gt; void" } },
     "exportDataAsCsv": { "type": { "description": "(options?: GridCsvExportOptions) =&gt; void" } },
@@ -238,6 +237,7 @@
       "type": { "description": "(id: GridRowId, isExpanded: boolean) =&gt; void" },
       "isProPlan": true
     },
+    "setRowCount": { "type": { "description": "(rowCount: number) =&gt; void" } },
     "setRowGroupingCriteriaIndex": {
       "type": {
         "description": "(groupingCriteriaField: string, groupingIndex: number) =&gt; void"

diff --git a/docs/pages/x/api/data-grid/grid-col-def.json b/docs/pages/x/api/data-grid/grid-col-def.json
@@ -44,6 +44,7 @@
       "default": "false",
       "isOptional": true
     },
+    "display": { "type": { "description": "'text' | 'flex'" }, "isOptional": true },
     "editable": { "type": { "description": "boolean" }, "default": "false", "isOptional": true },
     "field": { "type": { "description": "string" } },
     "filterable": { "type": { "description": "boolean" }, "default": "true", "isOptional": true },
@@ -56,6 +57,12 @@
       "type": { "description": "GetApplyQuickFilterFn&lt;R, V&gt;" },
       "isOptional": true
     },
+    "getSortComparator": {
+      "type": {
+        "description": "(sortDirection: GridSortDirection) =&gt; GridComparatorFn&lt;V&gt; | undefined"
+      },
+      "isOptional": true
+    },
     "groupable": { "type": { "description": "boolean" }, "default": "true", "isOptional": true },
     "groupingValueGetter": {
       "type": { "description": "GridGroupingValueGetter&lt;R&gt;" },
@@ -107,7 +114,7 @@
       "isOptional": true
     },
     "renderHeaderFilter": {
-      "type": { "description": "(params: GridHeaderFilterCellProps) =&gt; React.ReactNode" },
+      "type": { "description": "(params: GridRenderHeaderFilterProps) =&gt; React.ReactNode" },
       "isOptional": true,
       "isProPlan": true
     },

diff --git a/docs/pages/x/api/data-grid/grid-single-select-col-def.json b/docs/pages/x/api/data-grid/grid-single-select-col-def.json
@@ -44,6 +44,7 @@
       "default": "false",
       "isOptional": true
     },
+    "display": { "type": { "description": "'text' | 'flex'" }, "isOptional": true },
     "editable": { "type": { "description": "boolean" }, "default": "false", "isOptional": true },
     "field": { "type": { "description": "string" } },
     "filterable": { "type": { "description": "boolean" }, "default": "true", "isOptional": true },
@@ -64,6 +65,12 @@
       "type": { "description": "(value: ValueOptions) =&gt; any" },
       "isOptional": true
     },
+    "getSortComparator": {
+      "type": {
+        "description": "(sortDirection: GridSortDirection) =&gt; GridComparatorFn&lt;V&gt; | undefined"
+      },
+      "isOptional": true
+    },
     "groupable": { "type": { "description": "boolean" }, "default": "true", "isOptional": true },
     "groupingValueGetter": {
       "type": { "description": "GridGroupingValueGetter&lt;R&gt;" },
@@ -115,7 +122,7 @@
       "isOptional": true
     },
     "renderHeaderFilter": {
-      "type": { "description": "(params: GridHeaderFilterCellProps) =&gt; React.ReactNode" },
+      "type": { "description": "(params: GridRenderHeaderFilterProps) =&gt; React.ReactNode" },
       "isOptional": true,
       "isProPlan": true
     },

diff --git a/docs/translations/api-docs/data-grid/grid-actions-col-def.json b/docs/translations/api-docs/data-grid/grid-actions-col-def.json
@@ -20,6 +20,9 @@
       "description": "If <code>true</code>, this column will not be included in exports."
     },
     "disableReorder": { "description": "If <code>true</code>, this column cannot be reordered." },
+    "display": {
+      "description": "Display mode for the cell:<br /> - &#39;text&#39;: For text-based cells (default)<br /> - &#39;flex&#39;: For cells with HTMLElement children"
+    },
     "editable": { "description": "If <code>true</code>, the cells of the column are editable." },
     "field": {
       "description": "The column identifier. It&#39;s used to map with GridRowModel values."
@@ -31,6 +34,9 @@
     "getApplyQuickFilterFn": {
       "description": "The callback that generates a filtering function for a given quick filter value.<br />This function can return <code>null</code> to skip filtering for this value and column."
     },
+    "getSortComparator": {
+      "description": "Allows to use a different comparator function depending on the sort direction.<br />Takes precedence over <code>sortComparator</code>."
+    },
     "groupable": {
       "description": "If <code>true</code>, the rows can be grouped based on this column values (pro-plan only).<br />Only available in DataGridPremium."
     },

diff --git a/docs/translations/api-docs/data-grid/grid-api.json b/docs/translations/api-docs/data-grid/grid-api.json
@@ -192,6 +192,7 @@
       "description": "Set the quick filter values to the one given by <code>values</code>"
     },
     "setRowChildrenExpansion": { "description": "Expand or collapse a row children." },
+    "setRowCount": { "description": "Sets the <code>rowCount</code> to a new value." },
     "setRowGroupingCriteriaIndex": {
       "description": "Sets the grouping index of a grouping criteria."
     },

diff --git a/docs/translations/api-docs/data-grid/grid-col-def.json b/docs/translations/api-docs/data-grid/grid-col-def.json
@@ -20,6 +20,9 @@
       "description": "If <code>true</code>, this column will not be included in exports."
     },
     "disableReorder": { "description": "If <code>true</code>, this column cannot be reordered." },
+    "display": {
+      "description": "Display mode for the cell:<br /> - &#39;text&#39;: For text-based cells (default)<br /> - &#39;flex&#39;: For cells with HTMLElement children"
+    },
     "editable": { "description": "If <code>true</code>, the cells of the column are editable." },
     "field": {
       "description": "The column identifier. It&#39;s used to map with GridRowModel values."
@@ -30,6 +33,9 @@
     "getApplyQuickFilterFn": {
       "description": "The callback that generates a filtering function for a given quick filter value.<br />This function can return <code>null</code> to skip filtering for this value and column."
     },
+    "getSortComparator": {
+      "description": "Allows to use a different comparator function depending on the sort direction.<br />Takes precedence over <code>sortComparator</code>."
+    },
     "groupable": {
       "description": "If <code>true</code>, the rows can be grouped based on this column values (pro-plan only).<br />Only available in DataGridPremium."
     },

diff --git a/docs/translations/api-docs/data-grid/grid-single-select-col-def.json b/docs/translations/api-docs/data-grid/grid-single-select-col-def.json
@@ -20,6 +20,9 @@
       "description": "If <code>true</code>, this column will not be included in exports."
     },
     "disableReorder": { "description": "If <code>true</code>, this column cannot be reordered." },
+    "display": {
+      "description": "Display mode for the cell:<br /> - &#39;text&#39;: For text-based cells (default)<br /> - &#39;flex&#39;: For cells with HTMLElement children"
+    },
     "editable": { "description": "If <code>true</code>, the cells of the column are editable." },
     "field": {
       "description": "The column identifier. It&#39;s used to map with GridRowModel values."
@@ -34,6 +37,9 @@
       "description": "Used to determine the label displayed for a given value option."
     },
     "getOptionValue": { "description": "Used to determine the value used for a value option." },
+    "getSortComparator": {
+      "description": "Allows to use a different comparator function depending on the sort direction.<br />Takes precedence over <code>sortComparator</code>."
+    },
     "groupable": {
       "description": "If <code>true</code>, the rows can be grouped based on this column values (pro-plan only).<br />Only available in DataGridPremium."
     },