chore: _rowModels refactor (#5649)

* start row model refactor to be like feature options

* update some examples

* update react examples with new row models

Author: KevinVandy

docs/api/features/column-filtering.md

@@ -357,7 +357,7 @@ Example:
 import { getFilteredRowModel } from '@tanstack/[adapter]-table'
 
 
-  getFilteredRowModel: getFilteredRowModel(),
+  getFilteredRowModel: createFilteredRowModel(),
 })
 ```
 

docs/api/features/global-filtering.md

@@ -197,7 +197,7 @@ Example:
 ```tsx
 import { getFilteredRowModel } from '@tanstack/[adapter]-table'
 
-  getFilteredRowModel: getFilteredRowModel(),
+  getFilteredRowModel: createFilteredRowModel(),
 })
 ```
 

docs/api/features/pagination.md

@@ -30,7 +30,7 @@ export type PaginationInitialTableState = {
 manualPagination?: boolean
 ```
 
-Enables manual pagination. If this option is set to `true`, the table will not automatically paginate rows using `getPaginationRowModel()` and instead will expect you to manually paginate the rows before passing them to the table. This is useful if you are doing server-side pagination and aggregation.
+Enables manual pagination. If this option is set to `true`, the table will not automatically paginate rows using `getPaginatedRowModel()` and instead will expect you to manually paginate the rows before passing them to the table. This is useful if you are doing server-side pagination and aggregation.
 
 ### `pageCount`
 
@@ -66,10 +66,10 @@ onPaginationChange?: OnChangeFn<PaginationState>
 
 If this function is provided, it will be called when the pagination state changes and you will be expected to manage the state yourself. You can pass the managed state back to the table via the `tableOptions.state.pagination` option.
 
-### `getPaginationRowModel`
+### `getPaginatedRowModel`
 
 ```tsx
-getPaginationRowModel?: (table: Table<TData>) => () => RowModel<TData>
+getPaginatedRowModel?: (table: Table<TData>) => () => RowModel<TData>
 ```
 
 Returns the row model after pagination has taken place, but no further.
@@ -198,10 +198,10 @@ getPrePaginationRowModel: () => RowModel<TData>
 
 Returns the row model for the table before any pagination has been applied.
 
-### `getPaginationRowModel`
+### `getPaginatedRowModel`
 
 ```tsx
-getPaginationRowModel: () => RowModel<TData>
+getPaginatedRowModel: () => RowModel<TData>
 ```
 
 Returns the row model for the table after pagination has been applied.

docs/framework/angular/angular-table.md

@@ -22,7 +22,7 @@ export class AppComponent {
   table = injectTable(() => ({
     data: this.data(),
     columns: defaultColumns,
-    getCoreRowModel: getCoreRowModel(),
+    getCoreRowModel: createCoreRowModel(),
   }))
 }
 

docs/framework/lit/guide/table-state.md

@@ -90,8 +90,8 @@ class MyComponent extends LitElement {
           this._sorting = updaterOrValue
         }
       },
-      getSortedRowModel: getSortedRowModel(),
-      getCoreRowModel: getCoreRowModel(),
+      getSortedRowModel: createSortedRowModel(),
+      getCoreRowModel: createCoreRowModel(),
     })
 
     return html`...`
@@ -117,8 +117,8 @@ render() {
   const table = this.tableController.table({
     columns,
     data,
-    getCoreRowModel: getCoreRowModel(),
-    getSortedRowModel: getSortedRowModel()
+    getCoreRowModel: createCoreRowModel(),
+    getSortedRowModel: createSortedRowModel()
   })
   const state = { ...table.initialState, ...this._tableState };
   table.setOptions(prev => ({
@@ -160,8 +160,8 @@ render() {
         this._sorting = updaterOrValue
       }
     },
-    getSortedRowModel: getSortedRowModel(),
-    getCoreRowModel: getCoreRowModel(),
+    getSortedRowModel: createSortedRowModel(),
+    getCoreRowModel: createCoreRowModel(),
   })
 
   return html`...`;

docs/framework/svelte/svelte-table.md

@@ -66,7 +66,7 @@ Example:
   const table = createTable({
     data: peopleData,
     columns,
-    getCoreRowModel: getCoreRowModel()
+    getCoreRowModel: createCoreRowModel()
   })
 </script>
 

docs/guide/column-faceting.md

@@ -32,8 +32,8 @@ import {
 const table = useTable({
   columns,
   data,
-  getCoreRowModel: getCoreRowModel(),
-  getFacetedRowModel: getFacetedRowModel(), //if you need a list of values for a column (other faceted row models depend on this one)
+  getCoreRowModel: createCoreRowModel(),
+  getFacetedRowModel: createFacetedRowModel(), //if you need a list of values for a column (other faceted row models depend on this one)
   getFacetedMinMaxValues: getFacetedMinMaxValues(), //if you need min/max values
   getFacetedUniqueValues: getFacetedUniqueValues(), //if you need a list of unique values
   //...
@@ -71,8 +71,8 @@ const facetingQuery = useQuery(
 const table = useTable({
   columns,
   data,
-  getCoreRowModel: getCoreRowModel(),
-  getFacetedRowModel: getFacetedRowModel(),
+  getCoreRowModel: createCoreRowModel(),
+  getFacetedRowModel: createFacetedRowModel(),
   getFacetedUniqueValues: (table, columnId) => {
     const uniqueValueMap = new Map<string, number>();
     //...

docs/guide/column-filtering.md

@@ -53,8 +53,8 @@ No `getFilteredRowModel` table option is needed for manual server-side filtering
 const table = useTable({
   data,
   columns,
-  getCoreRowModel: getCoreRowModel(),
-  // getFilteredRowModel: getFilteredRowModel(), // not needed for manual server-side filtering
+  getCoreRowModel: createCoreRowModel(),
+  // getFilteredRowModel: createFilteredRowModel(), // not needed for manual server-side filtering
   manualFiltering: true,
 })
 ```
@@ -71,8 +71,8 @@ import { useTable, getFilteredRowModel } from '@tanstack/react-table'
 const table = useTable({
   data,
   columns,
-  getCoreRowModel: getCoreRowModel(),
-  getFilteredRowModel: getFilteredRowModel(), // needed for client-side filtering
+  getCoreRowModel: createCoreRowModel(),
+  getFilteredRowModel: createFilteredRowModel(), // needed for client-side filtering
 })
 ```
 
@@ -215,8 +215,8 @@ const columns = [
 const table = useTable({
   columns,
   data,
-  getCoreRowModel: getCoreRowModel(),
-  getFilteredRowModel: getFilteredRowModel(),
+  getCoreRowModel: createCoreRowModel(),
+  getFilteredRowModel: createFilteredRowModel(),
   filterFns: { // add a custom global filter function
     myCustomFilterFn: (row, columnId, filterValue) => { // defined inline here
       return // true or false based on your custom logic
@@ -295,9 +295,9 @@ However, if you want to allow sub-rows to be filtered and searched through, rega
 const table = useTable({
   columns,
   data,
-  getCoreRowModel: getCoreRowModel(),
-  getFilteredRowModel: getFilteredRowModel(),
-  getExpandedRowModel: getExpandedRowModel(),
+  getCoreRowModel: createCoreRowModel(),
+  getFilteredRowModel: createFilteredRowModel(),
+  getExpandedRowModel: createExpandedRowModel(),
   filterFromLeafRows: true, // filter and search through sub-rows
 })
 ```
@@ -312,9 +312,9 @@ Use `maxLeafRowFilterDepth: 0` if you want to preserve a parent row's sub-rows f
 const table = useTable({
   columns,
   data,
-  getCoreRowModel: getCoreRowModel(),
-  getFilteredRowModel: getFilteredRowModel(),
-  getExpandedRowModel: getExpandedRowModel(),
+  getCoreRowModel: createCoreRowModel(),
+  getFilteredRowModel: createFilteredRowModel(),
+  getExpandedRowModel: createExpandedRowModel(),
   maxLeafRowFilterDepth: 0, // only filter root level parent rows out
 })
 ```

docs/guide/pagination.md

@@ -49,13 +49,13 @@ Alternatively, instead of paginating the data, you can render all rows of a larg
 If you want to take advantage of the built-in client-side pagination in TanStack Table, you first need to pass in the pagination row model.
 
 ```jsx
-import { useTable, getCoreRowModel, getPaginationRowModel } from '@tanstack/react-table';
+import { useTable, getCoreRowModel, getPaginatedRowModel } from '@tanstack/react-table';
 //...
 const table = useTable({
   columns,
   data,
-  getCoreRowModel: getCoreRowModel(),
-  getPaginationRowModel: getPaginationRowModel(), //load client-side pagination code
+  getCoreRowModel: createCoreRowModel(),
+  getPaginatedRowModel: createPaginatedRowModel(), //load client-side pagination code
 });
 ```
 
@@ -70,13 +70,13 @@ No pagination row model is needed for server-side pagination, but if you have pr
 The table instance will have no way of knowing how many rows/pages there are in total in your back-end unless you tell it. Provide either the `rowCount` or `pageCount` table option to let the table instance know how many pages there are in total. If you provide a `rowCount`, the table instance will calculate the `pageCount` internally from `rowCount` and `pageSize`. Otherwise, you can directly provide the `pageCount` if you already have it. If you don't know the page count, you can just pass in `-1` for the `pageCount`, but the `getCanNextPage` and `getCanPreviousPage` row model functions will always return `true` in this case.
 
 ```jsx
-import { useTable, getCoreRowModel, getPaginationRowModel } from '@tanstack/react-table';
+import { useTable, getCoreRowModel, getPaginatedRowModel } from '@tanstack/react-table';
 //...
 const table = useTable({
   columns,
   data,
-  getCoreRowModel: getCoreRowModel(),
-  // getPaginationRowModel: getPaginationRowModel(), //not needed for server-side pagination
+  getCoreRowModel: createCoreRowModel(),
+  // getPaginatedRowModel: createPaginatedRowModel(), //not needed for server-side pagination
   manualPagination: true, //turn off client-side pagination
   rowCount: dataQuery.data?.rowCount, //pass in the total row count so the table knows how many pages there are (pageCount calculated internally if not provided)
   // pageCount: dataQuery.data?.pageCount, //alternatively directly pass in pageCount instead of rowCount
@@ -97,7 +97,7 @@ The `pagination` state is an object that contains the following properties:
 You can manage the `pagination` state just like any other state in the table instance.
 
 ```jsx
-import { useTable, getCoreRowModel, getPaginationRowModel } from '@tanstack/react-table';
+import { useTable, getCoreRowModel, getPaginatedRowModel } from '@tanstack/react-table';
 //...
 const [pagination, setPagination] = useState({
   pageIndex: 0, //initial page index
@@ -107,8 +107,8 @@ const [pagination, setPagination] = useState({
 const table = useTable({
   columns,
   data,
-  getCoreRowModel: getCoreRowModel(),
-  getPaginationRowModel: getPaginationRowModel(),
+  getCoreRowModel: createCoreRowModel(),
+  getPaginatedRowModel: createPaginatedRowModel(),
   onPaginationChange: setPagination, //update the pagination state when internal APIs mutate the pagination state
   state: {
     //...
@@ -123,8 +123,8 @@ Alternatively, if you have no need for managing the `pagination` state in your o
 const table = useTable({
   columns,
   data,
-  getCoreRowModel: getCoreRowModel(),
-  getPaginationRowModel: getPaginationRowModel(),
+  getCoreRowModel: createCoreRowModel(),
+  getPaginatedRowModel: createPaginatedRowModel(),
   initialState: {
     pagination: {
       pageIndex: 2, //custom initial page index
@@ -148,8 +148,8 @@ By default, `pageIndex` is reset to `0` when page-altering state changes occur,
 const table = useTable({
   columns,
   data,
-  getCoreRowModel: getCoreRowModel(),
-  getPaginationRowModel: getPaginationRowModel(),
+  getCoreRowModel: createCoreRowModel(),
+  getPaginatedRowModel: createPaginatedRowModel(),
   autoResetPageIndex: false, //turn off auto reset of pageIndex
 });
 ```

docs/guide/row-models.md

@@ -11,9 +11,9 @@ import { getCoreRowModel, useTable } from '@tanstack/react-table'
 
 function Component() {
   const table = useTable({
-    data,
     columns,
-    getCoreRowModel: getCoreRowModel(), //row model
+    data,
+    getCoreRowModel: createCoreRowModel(), //row model
   })
 }
 ```
@@ -40,22 +40,22 @@ import {
   getFacetedUniqueValues,
   getFilteredRowModel,
   getGroupedRowModel,
-  getPaginationRowModel,
+  getPaginatedRowModel,
   getSortedRowModel,
 }
 //...
 const table = useTable({
   columns,
   data,
-  getCoreRowModel: getCoreRowModel(),
-  getExpandedRowModel: getExpandedRowModel(),
+  getCoreRowModel: createCoreRowModel(),
+  getExpandedRowModel: createExpandedRowModel(),
   getFacetedMinMaxValues: getFacetedMinMaxValues(),
-  getFacetedRowModel: getFacetedRowModel(),
+  getFacetedRowModel: createFacetedRowModel(),
   getFacetedUniqueValues: getFacetedUniqueValues(),
-  getFilteredRowModel: getFilteredRowModel(),
-  getGroupedRowModel: getGroupedRowModel(),
-  getPaginationRowModel: getPaginationRowModel(),
-  getSortedRowModel: getSortedRowModel(),
+  getFilteredRowModel: createFilteredRowModel(),
+  getGroupedRowModel: createGroupedRowModel(),
+  getPaginatedRowModel: createPaginatedRowModel(),
+  getSortedRowModel: createSortedRowModel(),
 })
 ```
 
@@ -87,7 +87,7 @@ For normal rendering use cases, you will probably only need to use the `table.ge
 - `getExpandedRowModel` - returns a row model that accounts for expanded/hidden sub-rows.
 - `getPreExpandedRowModel` - returns a row model that only includes root level rows with no expanded sub-rows included. Still includes sorting.
 
-- `getPaginationRowModel` - returns a row model that only includes the rows that should be displayed on the current page based on the pagination state.
+- `getPaginatedRowModel` - returns a row model that only includes the rows that should be displayed on the current page based on the pagination state.
 - `getPrePaginationRowModel` - returns a row model without pagination applied (includes all rows).
 
 - `getSelectedRowModel` - returns a row model of all selected rows (but only based on the data that was passed to the table). Runs after getCoreRowModel.
@@ -101,7 +101,7 @@ Knowing how TanStack Table processes rows internally can help you gain a better
 
 Internally, this is the order in which each of the row models are applied to the data, if their respective features are enabled:
 
-`getCoreRowModel` -> `getFilteredRowModel` -> `getGroupedRowModel` -> `getSortedRowModel` -> `getExpandedRowModel` -> `getPaginationRowModel` -> `getRowModel`
+`getCoreRowModel` -> `getFilteredRowModel` -> `getGroupedRowModel` -> `getSortedRowModel` -> `getExpandedRowModel` -> `getPaginatedRowModel` -> `getRowModel`
 
 If in any case the respective feature is disabled or turned off with a `"manual*"` table option, the `getPre*RowModel` will be used instead in that step of the process.