fix: Custom passthrough options for bodyRow (#6902)

primefaces · Jul 18, 2024 · 678b78c · 678b78c
1 parent d1955a3
commit 678b78c
Show file tree

Hide file tree

Showing 2 changed files with 109 additions and 0 deletions.
diff --git a/components/doc/common/apidoc/index.json b/components/doc/common/apidoc/index.json
@@ -19460,6 +19460,87 @@
                     ],
                     "callbacks": []
                 },
+                "DataTableBodyRowContext": {
+                    "description": "Defines current options in DataTable bodyRow.",
+                    "relatedProp": "",
+                    "props": [
+                        {
+                            "name": "selected",
+                            "optional": false,
+                            "readonly": false,
+                            "type": "boolean"
+                        },
+                        {
+                            "name": "selectable",
+                            "optional": false,
+                            "readonly": false,
+                            "type": "boolean"
+                        },
+                        {
+                            "name": "stripedRows",
+                            "optional": false,
+                            "readonly": false,
+                            "type": "boolean"
+                        },
+                        {
+                            "name": "index",
+                            "optional": false,
+                            "readonly": false,
+                            "type": "number"
+                        }
+                    ],
+                    "callbacks": []
+                },
+                "DataTableBodyRowState": {
+                    "description": "Defines current inline state in DataTable bodyRow.",
+                    "relatedProp": "",
+                    "props": [
+                        {
+                            "name": "editing",
+                            "optional": false,
+                            "readonly": false,
+                            "type": "boolean"
+                        }
+                    ],
+                    "callbacks": []
+                },
+                "DataTableBodyRowPassThroughMethodOptions": {
+                    "description": "Custom passthrough(pt) option method for bodyRow.",
+                    "relatedProp": "",
+                    "props": [
+                        {
+                            "name": "hostName",
+                            "optional": false,
+                            "readonly": false,
+                            "type": "string"
+                        },
+                        {
+                            "name": "context",
+                            "optional": false,
+                            "readonly": false,
+                            "type": "DataTableBodyRowContext"
+                        },
+                        {
+                            "name": "parent",
+                            "optional": false,
+                            "readonly": false,
+                            "type": "DataTablePassThroughMethodOptions<TValue>"
+                        },
+                        {
+                            "name": "props",
+                            "optional": false,
+                            "readonly": false,
+                            "type": "DataTableBaseProps<TValue>"
+                        },
+                        {
+                            "name": "state",
+                            "optional": false,
+                            "readonly": false,
+                            "type": "DataTableBodyRowState"
+                        }
+                    ],
+                    "callbacks": []
+                },
                 "DataTableBaseProps": {
                     "description": "Defines valid properties in DataTable component. In addition to these, all properties of HTMLDivElement can be used in this component.",
                     "relatedProp": "",

diff --git a/components/lib/datatable/datatable.d.ts b/components/lib/datatable/datatable.d.ts
@@ -1004,6 +1004,34 @@ export interface DataTablePassThroughOptions {
     hooks?: ComponentHooks;
 }
 
+/**
+ * Defines current options in DataTable bodyRow.
+ */
+export interface DataTableBodyRowContext {
+    selected: boolean;
+    selectable: boolean;
+    stripedRows: boolean;
+    index: number;
+}
+
+/**
+ * Defines current inline state in DataTable bodyRow.
+ */
+export interface DataTableBodyRowState {
+    editing: boolean;
+}
+
+/**
+ * Custom passthrough(pt) option method for bodyRow.
+ */
+export interface DataTableBodyRowPassThroughMethodOptions<TValue extends DataTableValueArray> {
+    hostName: string;
+    context: DataTableBodyRowContext;
+    parent: DataTablePassThroughMethodOptions<TValue>;
+    props: DataTableBaseProps<TValue>;
+    state: DataTableBodyRowState;
+}
+
 type SortOrder = 1 | 0 | -1 | null | undefined;
 
 /**