Merge pull request #102 from Kuechlin/fix-auto-reset-pagination-defaults

fix: autoResetPageIndex default value
Kuechlin · Sep 21, 2022 · eb6125e · eb6125e
2 parents f3fb786 + 8a8f888
commit eb6125e
Show file tree

Hide file tree

Showing 4 changed files with 32 additions and 13 deletions.
diff --git a/docs/pages/Demo.tsx b/docs/pages/Demo.tsx
@@ -107,6 +107,7 @@ export default function Demo() {
     showEmpty: false,
     iconColor: theme.primaryColor,
     paginationCompactMode: false,
+    autoResetPageIndex: true,
   });
 
   const onPageChange = (e: DataGridPaginationState) => {
@@ -152,6 +153,7 @@ export default function Demo() {
           highlightOnHover={state.highlightOnHover}
           loading={state.loading}
           iconColor={state.iconColor}
+          autoResetPageIndex={state.autoResetPageIndex}
           onPageChange={onPageChange}
           onSort={onSort}
           onFilter={onFilter}
@@ -350,17 +352,28 @@ export default function Demo() {
               })
             }
           />
-          {state.withPagination ? (
-            <Switch
-              label="Compact pagination"
-              checked={state.paginationCompactMode}
-              onChange={(e) =>
-                update({
-                  paginationCompactMode: e.target.checked,
-                })
-              }
-            />
-          ) : null}
+          {state.withPagination && (
+            <>
+              <Switch
+                label="Compact pagination"
+                checked={state.paginationCompactMode}
+                onChange={(e) =>
+                  update({
+                    paginationCompactMode: e.target.checked,
+                  })
+                }
+              />
+              <Switch
+                label="Auto reset page index"
+                checked={state.autoResetPageIndex}
+                onChange={(e) =>
+                  update({
+                    autoResetPageIndex: e.target.checked,
+                  })
+                }
+              />
+            </>
+          )}
           <div>
             <Text weight="bold">Font Size</Text>
             <Slider

diff --git a/docs/pages/Properties.tsx b/docs/pages/Properties.tsx
@@ -179,6 +179,12 @@ export default function Properties() {
                 type: '"default" | "compact"',
                 description: '"compact" mode will only show pagination step without page size and current page info',
               },
+              {
+                name: 'autoResetPageIndex',
+                type: 'boolean',
+                description:
+                  'If set to false, pagination will NOT be reset to the first page when page-altering state changes eg. data is updated, filters change, grouping changes, etc.',
+              },
             ],
           },
           {

diff --git a/src/DataGrid.tsx b/src/DataGrid.tsx
@@ -114,7 +114,7 @@ export function DataGrid<TData extends RowData>({
     enableRowSelection: !!withRowSelection,
     columnResizeMode: 'onChange',
     manualPagination: !!total, // when external data, handle pagination manually
-    autoResetPageIndex: !!autoResetPageIndex,
+    autoResetPageIndex: autoResetPageIndex,
 
     getCoreRowModel: getCoreRowModel(),
     getFilteredRowModel: getFilteredRowModel(),

diff --git a/src/types.ts b/src/types.ts
@@ -89,7 +89,7 @@ export interface DataGridProps<TData extends RowData>
   paginationMode?: PaginationMode;
 
   /**
-   * If set to true, pagination will be reset to the first page when page-altering state changes eg. data is updated, filters change, grouping changes, etc.
+   * If set to false, pagination will NOT be reset to the first page when page-altering state changes eg. data is updated, filters change, grouping changes, etc.
    */
   autoResetPageIndex?: boolean;