#2424 Improve row edit validation api - add rowIndex to rowEditValida…

…tor, add newData to onRowEditSave (#5938)
primefaces · Feb 11, 2024 · 5fab88f · 5fab88f
1 parent d6f49ca
commit 5fab88f
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 5 deletions.
diff --git a/components/doc/common/apidoc/index.json b/components/doc/common/apidoc/index.json
@@ -17327,7 +17327,7 @@
                                 {
                                     "name": "event",
                                     "optional": false,
-                                    "type": "DataTableRowEditSaveEvent",
+                                    "type": "DataTableRowEditSaveEvent<TValue>",
                                     "description": "Custom row edit save event."
                                 }
                             ],
@@ -18617,6 +18617,13 @@
                             "readonly": false,
                             "type": "boolean",
                             "description": "Whether the row is valid or not."
+                        },
+                        {
+                            "name": "newData",
+                            "optional": false,
+                            "readonly": false,
+                            "type": "DataTableRowData<TValue>",
+                            "description": "Editing row data."
                         }
                     ],
                     "callbacks": [],
@@ -18751,6 +18758,13 @@
                             "readonly": false,
                             "type": "DataTableProps<TValue>",
                             "description": "The props of the datatable."
+                        },
+                        {
+                            "name": "rowIndex",
+                            "optional": false,
+                            "readonly": false,
+                            "type": "number",
+                            "description": "Index of validated row"
                         }
                     ],
                     "callbacks": []
@@ -20270,7 +20284,7 @@
                                 {
                                     "name": "event",
                                     "optional": false,
-                                    "type": "DataTableRowEditSaveEvent",
+                                    "type": "DataTableRowEditSaveEvent<TValue>",
                                     "description": "Custom row edit save event."
                                 }
                             ],

diff --git a/components/lib/datatable/BodyRow.js b/components/lib/datatable/BodyRow.js
@@ -358,13 +358,14 @@ export const BodyRow = React.memo((props) => {
 
     const onEditSave = (e) => {
         const { originalEvent: event, newData } = e;
-        const valid = props.rowEditValidator ? props.rowEditValidator(newData, { props: props.tableProps }) : true;
+        const valid = props.rowEditValidator ? props.rowEditValidator(newData, { props: props.tableProps, rowIndex: props.rowIndex }) : true;
 
         if (props.onRowEditSave) {
             props.onRowEditSave({
                 originalEvent: event,
                 data: props.rowData,
                 index: props.rowIndex,
+                newData,
                 valid
             });
         }

diff --git a/components/lib/datatable/datatable.d.ts b/components/lib/datatable/datatable.d.ts
@@ -511,11 +511,15 @@ interface DataTableRowEditEvent extends DataTableRowEvent {
  * @see {@link DataTableProps.onRowEditSave}
  * @extends DataTableRowEditEvent
  */
-interface DataTableRowEditSaveEvent extends DataTableRowEditEvent {
+interface DataTableRowEditSaveEvent<TValue extends DataTableValueArray> extends DataTableRowEditEvent {
     /**
      * Whether the row is valid or not.
      */
     valid: boolean;
+    /**
+     * Editing row data.
+     */
+    newData: DataTableRowData<TValue>;
 }
 
 /**
@@ -732,6 +736,10 @@ interface DataTableRowEditValidatorOptions<TValue extends DataTableValueArray> {
      * The props of the datatable.
      */
     props: DataTableProps<TValue>;
+    /**
+     * Index of validated row
+     */
+    rowIndex: number;
 }
 
 /**
@@ -1556,7 +1564,7 @@ interface DataTableBaseProps<TValue extends DataTableValueArray> extends Omit<Re
      * Callback to invoke when the save icon is clicked on row editing mode.
      * @param {DataTableRowEditSaveEvent} event - Custom row edit save event.
      */
-    onRowEditSave?(event: DataTableRowEditSaveEvent): void;
+    onRowEditSave?(event: DataTableRowEditSaveEvent<TValue>): void;
     /**
      * Callback to invoke when a row is expanded.
      * @param {DataTableRowEvent} event - Custom row event.