[DataGrid] Add new editing API (#3963)

mui · Mar 15, 2022 · 140f394 · 140f394
1 parent 66490b2
commit 140f394
Show file tree

Hide file tree

Showing 52 changed files with 4,028 additions and 267 deletions.
diff --git a/docs/data/data-grid/events/events.json b/docs/data/data-grid/events/events.json
@@ -20,13 +20,13 @@
   {
     "name": "cellEditStart",
     "description": "Fired when the cell turns to edit mode.",
-    "params": "GridCellParams",
+    "params": "GridCellEditStartParams",
     "event": "MuiEvent<React.MouseEvent<HTMLElement> | React.KeyboardEvent<HTMLElement>>"
   },
   {
     "name": "cellEditStop",
     "description": "Fired when the cell turns back to view mode.",
-    "params": "GridCellParams",
+    "params": "GridCellEditStopParams",
     "event": "MuiEvent<MuiBaseEvent>"
   },
   {
@@ -200,13 +200,13 @@
   {
     "name": "rowEditStart",
     "description": "Fired when the row turns to edit mode.",
-    "params": "GridRowParams",
+    "params": "GridRowEditStartParams",
     "event": "MuiEvent<React.MouseEvent<HTMLElement> | React.KeyboardEvent<HTMLElement>>"
   },
   {
     "name": "rowEditStop",
     "description": "Fired when the row turns back to view mode.",
-    "params": "GridRowParams",
+    "params": "GridRowEditStopParams",
     "event": "MuiEvent<MuiBaseEvent>"
   },
   {

diff --git a/docs/pages/api-docs/data-grid/data-grid-pro.json b/docs/pages/api-docs/data-grid/data-grid-pro.json
@@ -61,7 +61,7 @@
     "experimentalFeatures": {
       "type": {
         "name": "shape",
-        "description": "{ preventCommitWhileValidating?: bool, rowGrouping?: bool, warnIfFocusStateIsNotSynced?: bool }"
+        "description": "{ newEditingApi?: bool, preventCommitWhileValidating?: bool, rowGrouping?: bool, warnIfFocusStateIsNotSynced?: bool }"
       }
     },
     "filterMode": {
@@ -170,6 +170,7 @@
         "description": "{ left?: Array&lt;string&gt;, right?: Array&lt;string&gt; }"
       }
     },
+    "processRowUpdate": { "type": { "name": "func" } },
     "rowBuffer": { "type": { "name": "number" }, "default": "3" },
     "rowCount": { "type": { "name": "number" } },
     "rowGroupingColumnMode": {

diff --git a/docs/pages/api-docs/data-grid/data-grid.json b/docs/pages/api-docs/data-grid/data-grid.json
@@ -40,7 +40,7 @@
     "experimentalFeatures": {
       "type": {
         "name": "shape",
-        "description": "{ preventCommitWhileValidating?: bool, warnIfFocusStateIsNotSynced?: bool }"
+        "description": "{ newEditingApi?: bool, preventCommitWhileValidating?: bool, warnIfFocusStateIsNotSynced?: bool }"
       }
     },
     "filterMode": {
@@ -128,6 +128,7 @@
       "type": { "name": "enum", "description": "'client'<br>&#124;&nbsp;'server'" },
       "default": "\"client\""
     },
+    "processRowUpdate": { "type": { "name": "func" } },
     "rowBuffer": { "type": { "name": "number" }, "default": "3" },
     "rowCount": { "type": { "name": "number" } },
     "rowHeight": { "type": { "name": "number" }, "default": "52" },

diff --git a/docs/pages/api-docs/data-grid/grid-api.md b/docs/pages/api-docs/data-grid/grid-api.md
diff --git a/docs/pages/api-docs/data-grid/grid-editing-api.json b/docs/pages/api-docs/data-grid/grid-editing-api.json
@@ -4,12 +4,12 @@
   "properties": [
     {
       "name": "commitCellChange",
-      "description": "Updates the field at the given id with the value stored in the edit row model.",
+      "description": "Updates the field corresponding to the given id with the value stored in the edit row model.",
       "type": "(params: GridCommitCellChangeParams, event?: MuiBaseEvent) => boolean | Promise<boolean>"
     },
     {
       "name": "commitRowChange",
-      "description": "Updates the row at the given id with the values stored in the edit row model.",
+      "description": "Updates the row corresponding to the given id with the values stored in the edit row model.",
       "type": "(id: GridRowId, event?: MuiBaseEvent) => boolean | Promise<boolean>"
     },
     {
@@ -51,6 +51,26 @@
       "name": "setRowMode",
       "description": "Sets the mode of a row.",
       "type": "(id: GridRowId, mode: GridRowMode) => void"
+    },
+    {
+      "name": "startCellEditMode",
+      "description": "Puts the cell corresponding to the given row id and field into edit mode.",
+      "type": "(params: GridStartCellEditModeParams) => void"
+    },
+    {
+      "name": "startRowEditMode",
+      "description": "Puts the row corresponding to the given id into edit mode.",
+      "type": "(params: GridStartRowEditModeParams) => void"
+    },
+    {
+      "name": "stopCellEditMode",
+      "description": "Puts the cell corresponding to the given row id and field into view mode and updates the original row with the new value stored.\nIf <code>params.ignoreModifications</code> is <code>false</code> it will discard the modifications made.",
+      "type": "(params: GridStopCellEditModeParams) => Promise<boolean>"
+    },
+    {
+      "name": "stopRowEditMode",
+      "description": "Puts the row corresponding to the given id and into view mode and updates the original row with the new values stored.\nIf <code>params.ignoreModifications</code> is <code>false</code> it will discard the modifications made.",
+      "type": "(params: GridStopRowEditModeParams) => Promise<boolean>"
     }
   ]
 }
diff --git a/docs/pages/x/api/data-grid/data-grid-pro.json b/docs/pages/x/api/data-grid/data-grid-pro.json
@@ -61,7 +61,7 @@
     "experimentalFeatures": {
       "type": {
         "name": "shape",
-        "description": "{ preventCommitWhileValidating?: bool, rowGrouping?: bool, warnIfFocusStateIsNotSynced?: bool }"
+        "description": "{ newEditingApi?: bool, preventCommitWhileValidating?: bool, rowGrouping?: bool, warnIfFocusStateIsNotSynced?: bool }"
       }
     },
     "filterMode": {
@@ -170,6 +170,7 @@
         "description": "{ left?: Array&lt;string&gt;, right?: Array&lt;string&gt; }"
       }
     },
+    "processRowUpdate": { "type": { "name": "func" } },
     "rowBuffer": { "type": { "name": "number" }, "default": "3" },
     "rowCount": { "type": { "name": "number" } },
     "rowGroupingColumnMode": {

diff --git a/docs/pages/x/api/data-grid/data-grid.json b/docs/pages/x/api/data-grid/data-grid.json
@@ -40,7 +40,7 @@
     "experimentalFeatures": {
       "type": {
         "name": "shape",
-        "description": "{ preventCommitWhileValidating?: bool, warnIfFocusStateIsNotSynced?: bool }"
+        "description": "{ newEditingApi?: bool, preventCommitWhileValidating?: bool, warnIfFocusStateIsNotSynced?: bool }"
       }
     },
     "filterMode": {
@@ -128,6 +128,7 @@
       "type": { "name": "enum", "description": "'client'<br>&#124;&nbsp;'server'" },
       "default": "\"client\""
     },
+    "processRowUpdate": { "type": { "name": "func" } },
     "rowBuffer": { "type": { "name": "number" }, "default": "3" },
     "rowCount": { "type": { "name": "number" } },
     "rowHeight": { "type": { "name": "number" }, "default": "52" },