Merge pull request #1483 from Availity/docs/table-sorting

docs(table): add pageSize to CurrentTableState type
Availity · Nov 4, 2024 · eb33145 · eb33145
2 parents 1d87537 + 84fe340
commit eb33145
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 1 deletion.
diff --git a/docusaurus/docs/components/table/index.md b/docusaurus/docs/components/table/index.md
@@ -149,7 +149,7 @@ This determines whether the table is sortable or not.
 
 #### `initialState?: object`
 
-This object definition sets the initial state of the table, including the default sort by definition.
+This object definition sets the initial state of the table, including the default sort by definition and page size. Ex. `initialState: { sortBy: [{ id: 'firstName', desc: false }], pageSize: 5 }`;
 
 #### `additionalContent?: ReactNode`
 

diff --git a/packages/table/src/types/ReactTable.ts b/packages/table/src/types/ReactTable.ts
@@ -100,4 +100,5 @@ export type TableInstance<T extends IdType> = UseSortByInstanceProps<T> &
 export type CurrentTableState<T extends IdType> = TableState &
   Partial<UseRowSelectState<T>> & {
     sortBy?: TableSort[];
+    pageSize?: number;
   };