@tanstack/table-core 9.0.0-alpha.42 → 9.0.0-alpha.46

package/src/features/row-expanding/rowExpandingFeature.utils.ts

@@ -8,10 +8,30 @@ import type {
   ExpandedStateList,
 } from './rowExpandingFeature.types'
 
+/**
+ * Returns the default expanded state.
+ *
+ * Feature constructors use this value to initialize the table state or option defaults when no user value is provided.
+ *
+ * @example
+ * ```ts
+ * const initialValue = getDefaultExpandedState()
+ * ```
+ */
 export function getDefaultExpandedState(): ExpandedState {
   return {}
 }
 
+/**
+ * Schedules an automatic reset for expanded.
+ *
+ * The reset only runs when the related feature options allow automatic resets for the current table state change.
+ *
+ * @example
+ * ```ts
+ * table_autoResetExpanded(table)
+ * ```
+ */
 export function table_autoResetExpanded<
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -25,6 +45,16 @@ export function table_autoResetExpanded<
   }
 }
 
+/**
+ * Updates the table's expanded state slice.
+ *
+ * The updater follows TanStack Table updater semantics and is routed through the corresponding `on*Change` option or backing atom.
+ *
+ * @example
+ * ```ts
+ * table_setExpanded(table, (old) => old)
+ * ```
+ */
 export function table_setExpanded<
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -32,6 +62,16 @@ export function table_setExpanded<
   table.options.onExpandedChange?.(updater)
 }
 
+/**
+ * Toggles all rows expanded for the table.
+ *
+ * This is the table-level convenience API used by UI controls that affect many columns or rows at once.
+ *
+ * @example
+ * ```ts
+ * table_toggleAllRowsExpanded(table)
+ * ```
+ */
 export function table_toggleAllRowsExpanded<
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -43,6 +83,17 @@ export function table_toggleAllRowsExpanded<
   }
 }
 
+/**
+ * Resets the table's expanded state slice.
+ *
+ * By default the reset uses `table.initialState`; when supported, a blank/default reset bypasses the saved initial value.
+ *
+ * @example
+ * ```ts
+ * table_resetExpanded(table)
+ * table_resetExpanded(table, true)
+ * ```
+ */
 export function table_resetExpanded<
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -53,6 +104,16 @@ export function table_resetExpanded<
   )
 }
 
+/**
+ * Returns can some rows expand for the table.
+ *
+ * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ *
+ * @example
+ * ```ts
+ * const value = table_getCanSomeRowsExpand(table)
+ * ```
+ */
 export function table_getCanSomeRowsExpand<
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -62,6 +123,16 @@ export function table_getCanSomeRowsExpand<
     .flatRows.some((row) => row_getCanExpand(row))
 }
 
+/**
+ * Returns an event handler for all rows expanded handler.
+ *
+ * The handler calls the matching table toggle API and can be attached directly to checkbox or button UI.
+ *
+ * @example
+ * ```ts
+ * const value = table_getToggleAllRowsExpandedHandler(table)
+ * ```
+ */
 export function table_getToggleAllRowsExpandedHandler<
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -72,6 +143,16 @@ export function table_getToggleAllRowsExpandedHandler<
   }
 }
 
+/**
+ * Returns is some rows expanded for the table.
+ *
+ * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ *
+ * @example
+ * ```ts
+ * const value = table_getIsSomeRowsExpanded(table)
+ * ```
+ */
 export function table_getIsSomeRowsExpanded<
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -80,6 +161,16 @@ export function table_getIsSomeRowsExpanded<
   return expanded === true || Object.values(expanded).some(Boolean)
 }
 
+/**
+ * Returns is all rows expanded for the table.
+ *
+ * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ *
+ * @example
+ * ```ts
+ * const value = table_getIsAllRowsExpanded(table)
+ * ```
+ */
 export function table_getIsAllRowsExpanded<
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -104,6 +195,16 @@ export function table_getIsAllRowsExpanded<
   return true
 }
 
+/**
+ * Returns expanded depth for the table.
+ *
+ * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ *
+ * @example
+ * ```ts
+ * const value = table_getExpandedDepth(table)
+ * ```
+ */
 export function table_getExpandedDepth<
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -123,6 +224,16 @@ export function table_getExpandedDepth<
   return maxDepth
 }
 
+/**
+ * Toggles expanded for a row.
+ *
+ * The update is routed through the table state updater for the owning feature state slice.
+ *
+ * @example
+ * ```ts
+ * row_toggleExpanded(row)
+ * ```
+ */
 export function row_toggleExpanded<
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -158,6 +269,16 @@ export function row_toggleExpanded<
   })
 }
 
+/**
+ * Returns is expanded for a row.
+ *
+ * This is the static implementation behind the matching row instance API and may read row caches or table state atoms.
+ *
+ * @example
+ * ```ts
+ * const value = row_getIsExpanded(row)
+ * ```
+ */
 export function row_getIsExpanded<
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -170,6 +291,16 @@ export function row_getIsExpanded<
   )
 }
 
+/**
+ * Returns whether a row can use expand.
+ *
+ * This evaluates row data, table options, and feature-specific enablement rules.
+ *
+ * @example
+ * ```ts
+ * const value = row_getCanExpand(row)
+ * ```
+ */
 export function row_getCanExpand<
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -180,6 +311,16 @@ export function row_getCanExpand<
   )
 }
 
+/**
+ * Returns is all parents expanded for a row.
+ *
+ * This is the static implementation behind the matching row instance API and may read row caches or table state atoms.
+ *
+ * @example
+ * ```ts
+ * const value = row_getIsAllParentsExpanded(row)
+ * ```
+ */
 export function row_getIsAllParentsExpanded<
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -195,6 +336,16 @@ export function row_getIsAllParentsExpanded<
   return isFullyExpanded
 }
 
+/**
+ * Returns an event handler for toggling expanded handler.
+ *
+ * The handler is intended for direct use in row-level controls such as expansion or selection buttons.
+ *
+ * @example
+ * ```ts
+ * const value = row_getToggleExpandedHandler(row)
+ * ```
+ */
 export function row_getToggleExpandedHandler<
   TFeatures extends TableFeatures,
   TData extends RowData,

package/src/features/row-pagination/createPaginatedRowModel.ts

@@ -7,6 +7,11 @@ import type { Table, Table_Internal } from '../../types/Table'
 import type { Row } from '../../types/Row'
 import type { RowData } from '../../types/type-utils'
 
+/**
+ * Creates a memoized paginated row model factory.
+ *
+ * The factory reads the relevant table state atoms and options, then returns a row model function used by the table row-model pipeline.
+ */
 export function createPaginatedRowModel<
   TFeatures extends TableFeatures,
   TData extends RowData = any,

package/src/features/row-pagination/rowPaginationFeature.ts

@@ -39,6 +39,11 @@ export interface RowPaginationFeatureConstructors<
   // TableState: TableState_RowPagination
 }
 
+/**
+ * Creates the stock row pagination feature.
+ *
+ * The returned feature registers its state defaults, option defaults, and instance APIs so it can be included in a `tableFeatures({ ... })` call.
+ */
 export function constructRowPaginationFeature<
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -116,6 +121,9 @@ export function constructRowPaginationFeature<
 }
 
 /**
- * The (Row) Pagination feature adds pagination state and APIs to the table object.
+ * The stock row pagination feature.
+ *
+ * Register this feature to add pagination state, page navigation APIs, and
+ * pagination-aware row model helpers to a table.
  */
 export const rowPaginationFeature = constructRowPaginationFeature()

package/src/features/row-pagination/rowPaginationFeature.types.ts

@@ -22,7 +22,9 @@ export interface TableOptions_RowPagination {
    */
   manualPagination?: boolean
   /**
-   * 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.
+   * Called with an updater when pagination state changes. Pair this with
+   * `state.pagination` when using external state; external atoms can own the
+   * slice without this callback.
    */
   onPaginationChange?: OnChangeFn<PaginationState>
   /**
@@ -89,19 +91,20 @@ export interface Table_RowPagination<
    */
   resetPageSize: (defaultState?: boolean) => void
   /**
-   * Resets the **pagination** state to `initialState.pagination`, or `true` can be passed to force a default blank state reset to `[]`.
+   * Resets pagination state to `initialState.pagination`. Pass `true` to reset
+   * to the feature default of `{ pageIndex: 0, pageSize: 10 }`.
    */
   resetPagination: (defaultState?: boolean) => void
   /**
-   * Updates the page index using the provided function or value in the `state.pagination.pageIndex` state.
+   * Updates `pagination.pageIndex` using a value or updater.
    */
   setPageIndex: (updater: Updater<number>) => void
   /**
-   * Updates the page size using the provided function or value in the `state.pagination.pageSize` state.
+   * Updates `pagination.pageSize` using a value or updater.
    */
   setPageSize: (updater: Updater<number>) => void
   /**
-   * Sets or updates the `state.pagination` state.
+   * Sets pagination state using a value or updater.
    */
   setPagination: (updater: Updater<PaginationState>) => void
 }
@@ -125,8 +128,9 @@ export interface CreateRowModel_Paginated<
   TData extends RowData,
 > {
   /**
-   * Returns the row model after pagination has taken place, but no further.
-   * Pagination columns are automatically reordered by default to the start of the columns list. If you would rather remove them or leave them as-is, set the appropriate mode here.
+   * Factory used to retrieve the paginated row model. If using server-side
+   * pagination, this is not required. To use client-side pagination, pass
+   * `createPaginatedRowModel()` or implement your own factory.
    */
   paginatedRowModel?: (
     table: Table<TFeatures, TData>,

package/src/features/row-pagination/rowPaginationFeature.utils.ts

@@ -7,6 +7,16 @@ import type { PaginationState } from './rowPaginationFeature.types'
 const defaultPageIndex = 0
 const defaultPageSize = 10
 
+/**
+ * Returns the default pagination state.
+ *
+ * Feature constructors use this value to initialize the table state or option defaults when no user value is provided.
+ *
+ * @example
+ * ```ts
+ * const initialValue = getDefaultPaginationState()
+ * ```
+ */
 export function getDefaultPaginationState(): PaginationState {
   return {
     pageIndex: defaultPageIndex,
@@ -14,6 +24,16 @@ export function getDefaultPaginationState(): PaginationState {
   }
 }
 
+/**
+ * Schedules an automatic reset for page index.
+ *
+ * The reset only runs when the related feature options allow automatic resets for the current table state change.
+ *
+ * @example
+ * ```ts
+ * table_autoResetPageIndex(table)
+ * ```
+ */
 export function table_autoResetPageIndex<
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -27,6 +47,16 @@ export function table_autoResetPageIndex<
   }
 }
 
+/**
+ * Updates the table's pagination state slice.
+ *
+ * The updater follows TanStack Table updater semantics and is routed through the corresponding `on*Change` option or backing atom.
+ *
+ * @example
+ * ```ts
+ * table_setPagination(table, (old) => old)
+ * ```
+ */
 export function table_setPagination<
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -40,6 +70,17 @@ export function table_setPagination<
   return table.options.onPaginationChange?.(safeUpdater)
 }
 
+/**
+ * Resets the table's pagination state slice.
+ *
+ * By default the reset uses `table.initialState`; when supported, a blank/default reset bypasses the saved initial value.
+ *
+ * @example
+ * ```ts
+ * table_resetPagination(table)
+ * table_resetPagination(table, true)
+ * ```
+ */
 export function table_resetPagination<
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -54,6 +95,16 @@ export function table_resetPagination<
   )
 }
 
+/**
+ * Updates the table's page index state slice.
+ *
+ * The updater follows TanStack Table updater semantics and is routed through the corresponding `on*Change` option or backing atom.
+ *
+ * @example
+ * ```ts
+ * table_setPageIndex(table, (old) => old)
+ * ```
+ */
 export function table_setPageIndex<
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -76,6 +127,17 @@ export function table_setPageIndex<
   })
 }
 
+/**
+ * Resets the table's page index state slice.
+ *
+ * By default the reset uses `table.initialState`; when supported, a blank/default reset bypasses the saved initial value.
+ *
+ * @example
+ * ```ts
+ * table_resetPageIndex(table)
+ * table_resetPageIndex(table, true)
+ * ```
+ */
 export function table_resetPageIndex<
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -89,6 +151,17 @@ export function table_resetPageIndex<
   table_setPageIndex(table, newPageIndex)
 }
 
+/**
+ * Resets the table's page size state slice.
+ *
+ * By default the reset uses `table.initialState`; when supported, a blank/default reset bypasses the saved initial value.
+ *
+ * @example
+ * ```ts
+ * table_resetPageSize(table)
+ * table_resetPageSize(table, true)
+ * ```
+ */
 export function table_resetPageSize<
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -102,6 +175,16 @@ export function table_resetPageSize<
   table_setPageSize(table, newPageSize)
 }
 
+/**
+ * Updates the table's page size state slice.
+ *
+ * The updater follows TanStack Table updater semantics and is routed through the corresponding `on*Change` option or backing atom.
+ *
+ * @example
+ * ```ts
+ * table_setPageSize(table, (old) => old)
+ * ```
+ */
 export function table_setPageSize<
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -119,6 +202,16 @@ export function table_setPageSize<
   })
 }
 
+/**
+ * Returns page options for the table.
+ *
+ * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ *
+ * @example
+ * ```ts
+ * const value = table_getPageOptions(table)
+ * ```
+ */
 export function table_getPageOptions<
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -131,6 +224,16 @@ export function table_getPageOptions<
   return pageOptions
 }
 
+/**
+ * Returns can previous page for the table.
+ *
+ * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ *
+ * @example
+ * ```ts
+ * const value = table_getCanPreviousPage(table)
+ * ```
+ */
 export function table_getCanPreviousPage<
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -138,6 +241,16 @@ export function table_getCanPreviousPage<
   return (table.atoms.pagination?.get()?.pageIndex ?? 0) > 0
 }
 
+/**
+ * Returns can next page for the table.
+ *
+ * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ *
+ * @example
+ * ```ts
+ * const value = table_getCanNextPage(table)
+ * ```
+ */
 export function table_getCanNextPage<
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -157,6 +270,17 @@ export function table_getCanNextPage<
   return pageIndex < pageCount - 1
 }
 
+/**
+ * Moves the table to the previous page.
+ *
+ * This delegates to `table_setPageIndex` so pagination state ownership and
+ * updater semantics remain consistent.
+ *
+ * @example
+ * ```ts
+ * table_previousPage(table)
+ * ```
+ */
 export function table_previousPage<
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -164,6 +288,17 @@ export function table_previousPage<
   return table_setPageIndex(table, (old) => old - 1)
 }
 
+/**
+ * Moves the table to the next page.
+ *
+ * This delegates to `table_setPageIndex` so pagination state ownership and
+ * updater semantics remain consistent.
+ *
+ * @example
+ * ```ts
+ * table_nextPage(table)
+ * ```
+ */
 export function table_nextPage<
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -173,6 +308,16 @@ export function table_nextPage<
   })
 }
 
+/**
+ * Moves the table to the first page.
+ *
+ * This is a convenience wrapper around `table_setPageIndex(table, 0)`.
+ *
+ * @example
+ * ```ts
+ * table_firstPage(table)
+ * ```
+ */
 export function table_firstPage<
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -180,6 +325,16 @@ export function table_firstPage<
   return table_setPageIndex(table, 0)
 }
 
+/**
+ * Moves the table to the last known page.
+ *
+ * The target page is derived from `table_getPageCount(table) - 1`.
+ *
+ * @example
+ * ```ts
+ * table_lastPage(table)
+ * ```
+ */
 export function table_lastPage<
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -187,6 +342,16 @@ export function table_lastPage<
   return table_setPageIndex(table, table_getPageCount(table) - 1)
 }
 
+/**
+ * Returns page count for the table.
+ *
+ * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ *
+ * @example
+ * ```ts
+ * const value = table_getPageCount(table)
+ * ```
+ */
 export function table_getPageCount<
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -200,6 +365,16 @@ export function table_getPageCount<
   )
 }
 
+/**
+ * Returns row count for the table.
+ *
+ * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ *
+ * @example
+ * ```ts
+ * const value = table_getRowCount(table)
+ * ```
+ */
 export function table_getRowCount<
   TFeatures extends TableFeatures,
   TData extends RowData,

package/src/features/row-pinning/rowPinningFeature.ts

@@ -35,6 +35,11 @@ export interface RowPinningFeatureConstructors<
   // TableState: TableState_RowPinning
 }
 
+/**
+ * Creates the stock row pinning feature.
+ *
+ * The returned feature registers its state defaults, option defaults, and instance APIs so it can be included in a `tableFeatures({ ... })` call.
+ */
 export function constructRowPinningFeature<
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -116,6 +121,9 @@ export function constructRowPinningFeature<
 }
 
 /**
- * The Row Pinning feature adds row pinning state and APIs to the table and row objects.
+ * The stock row pinning feature.
+ *
+ * Register this feature to add row pinning state and APIs for deriving top,
+ * center, and bottom row regions.
  */
 export const rowPinningFeature = constructRowPinningFeature()

package/src/features/row-pinning/rowPinningFeature.types.ts

@@ -26,7 +26,9 @@ export interface TableOptions_RowPinning<
    */
   keepPinnedRows?: boolean
   /**
-   * If provided, this function will be called with an `updaterFn` when `state.rowPinning` changes. This overrides the default internal state management, so you will also need to supply `state.rowPinning` from your own managed state.
+   * Called with an updater when row pinning state changes. Pair this with
+   * `state.rowPinning` when using external state; external atoms can own the
+   * slice without this callback.
    */
   onRowPinningChange?: OnChangeFn<RowPinningState>
 }
@@ -83,7 +85,7 @@ export interface Table_RowPinning<
    */
   resetRowPinning: (defaultState?: boolean) => void
   /**
-   * Sets or updates the `state.rowPinning` state.
+   * Sets row pinning state using a value or updater.
    */
   setRowPinning: (updater: Updater<RowPinningState>) => void
 }