From 4652dad350e49769fe03837c54bfd18713c7f5eb Mon Sep 17 00:00:00 2001
From: DorijanH <dhaspl@gmail.com>
Date: Tue, 16 Jan 2024 10:21:50 +0100
Subject: [PATCH] feat(react-mui-hooks/usedatagrid): Renamed filterChanged prop
 to refreshTable

---
 apps/docs/components/ExampleUseDataGrid.tsx           |  2 +-
 ...id] `filterChanged` prop renamed to `refreshTable` |  0
 packages/react-mui-hooks/hooks/useDataGrid.tsx        | 11 ++++++-----
 packages/react-mui-hooks/temp/react-mui-hooks.api.md  |  2 +-
 4 files changed, 8 insertions(+), 7 deletions(-)
 create mode 100644 packages/react-mui-hooks/changes/Changed [useDataGrid] `filterChanged` prop renamed to `refreshTable`

diff --git a/apps/docs/components/ExampleUseDataGrid.tsx b/apps/docs/components/ExampleUseDataGrid.tsx
index c8bbf426..acfb052a 100644
--- a/apps/docs/components/ExampleUseDataGrid.tsx
+++ b/apps/docs/components/ExampleUseDataGrid.tsx
@@ -46,7 +46,7 @@ export function ExampleUseDataGrid() {
     });
 
     useEffect(() => {
-        dataGrid.filterChanged();
+        dataGrid.refreshTable();
     }, []);
 
     return (
diff --git a/packages/react-mui-hooks/changes/Changed [useDataGrid] `filterChanged` prop renamed to `refreshTable` b/packages/react-mui-hooks/changes/Changed [useDataGrid] `filterChanged` prop renamed to `refreshTable`
new file mode 100644
index 00000000..e69de29b
diff --git a/packages/react-mui-hooks/hooks/useDataGrid.tsx b/packages/react-mui-hooks/hooks/useDataGrid.tsx
index a1efa001..449ed9eb 100644
--- a/packages/react-mui-hooks/hooks/useDataGrid.tsx
+++ b/packages/react-mui-hooks/hooks/useDataGrid.tsx
@@ -327,7 +327,7 @@ export type UseDataGridProps = {
  */
 export type UseDataGridResponse = {
     props: ComponentPropsWithRef<typeof DataGridPro>,
-    filterChanged: (keepPage?: boolean) => void,
+    refreshTable: (keepPage?: boolean) => void,
     isSelectAll: boolean,
     setIsSelectAll: (value: boolean) => void,
     isAnySelected: boolean,
@@ -406,10 +406,11 @@ export function useDataGrid({
     }, [pageSize, sortModel, filterModel, onPage, loading]);
 
     /**
-     * Handles filter changed. This will go back to first page and request page.
-     * @param keepPage - If set to true, when filter is changed, page will remain selected; returns to first page if set to false.
+     * Handles the table refresh. This will go back to the first page and request a new one.
+     *
+     * @param keepPage - If set to true, when table is refreshed, page will remain selected; returns to first page if set to false.
      */
-    const handleFilterChanged = (keepPage = false) => {
+    const handleTableRefresh = (keepPage = false) => {
         if (!keepPage) setPageIndex(-1);
 
         handleLoadPage(keepPage ? pageIndex : -1, true);
@@ -727,7 +728,7 @@ export function useDataGrid({
             slotProps,
             keepNonExistentRowsSelected
         },
-        filterChanged: handleFilterChanged,
+        refreshTable: handleTableRefresh,
         isSelectAll: isAllItemsSelected,
         setIsSelectAll: setIsAllItemsSelected,
         isAnySelected: customSelectionModel.length > 0,
diff --git a/packages/react-mui-hooks/temp/react-mui-hooks.api.md b/packages/react-mui-hooks/temp/react-mui-hooks.api.md
index 730e65b3..31916df4 100644
--- a/packages/react-mui-hooks/temp/react-mui-hooks.api.md
+++ b/packages/react-mui-hooks/temp/react-mui-hooks.api.md
@@ -74,7 +74,7 @@ export type UseDataGridProps = {
 // @public
 export type UseDataGridResponse = {
     props: ComponentPropsWithRef<typeof DataGridPro>;
-    filterChanged: (keepPage?: boolean) => void;
+    refreshTable: (keepPage?: boolean) => void;
     isSelectAll: boolean;
     setIsSelectAll: (value: boolean) => void;
     isAnySelected: boolean;