@tanstack/table-core 8.10.1 → 8.10.2

package/src/features/Pagination.ts

@@ -16,11 +16,38 @@ export interface PaginationInitialTableState {
 }
 
 export interface PaginationOptions {
-  pageCount?: number
-  manualPagination?: boolean
-  onPaginationChange?: OnChangeFn<PaginationState>
+  /**
+   * 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.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/pagination#autoresetpageindex)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/pagination)
+   */
   autoResetPageIndex?: boolean
+  /**
+   * 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.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/pagination#getpaginationrowmodel)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/pagination)
+   */
   getPaginationRowModel?: (table: Table<any>) => () => RowModel<any>
+  /**
+   * 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.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/pagination#manualpagination)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/pagination)
+   */
+  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.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/pagination#onpaginationchange)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/pagination)
+   */
+  onPaginationChange?: OnChangeFn<PaginationState>
+  /**
+   * When manually controlling pagination, you should supply a total `pageCount` value to the table if you know it. If you do not know how many pages there are, you can set this to `-1`.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/pagination#pagecount)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/pagination)
+   */
+  pageCount?: number
 }
 
 export interface PaginationDefaultOptions {
@@ -29,22 +56,97 @@ export interface PaginationDefaultOptions {
 
 export interface PaginationInstance<TData extends RowData> {
   _autoResetPageIndex: () => void
-  setPagination: (updater: Updater<PaginationState>) => void
-  resetPagination: (defaultState?: boolean) => void
-  setPageIndex: (updater: Updater<number>) => void
+  _getPaginationRowModel?: () => RowModel<TData>
+  /**
+   * Returns whether the table can go to the next page.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/pagination#getcannextpage)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/pagination)
+   */
+  getCanNextPage: () => boolean
+  /**
+   * Returns whether the table can go to the previous page.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/pagination#getcanpreviouspage)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/pagination)
+   */
+  getCanPreviousPage: () => boolean
+  /**
+   * Returns the page count. If manually paginating or controlling the pagination state, this will come directly from the `options.pageCount` table option, otherwise it will be calculated from the table data using the total row count and current page size.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/pagination#getpagecount)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/pagination)
+   */
+  getPageCount: () => number
+  /**
+   * Returns an array of page options (zero-index-based) for the current page size.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/pagination#getpageoptions)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/pagination)
+   */
+  getPageOptions: () => number[]
+  /**
+   * Returns the row model for the table after pagination has been applied.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/pagination#getpaginationrowmodel)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/pagination)
+   */
+  getPaginationRowModel: () => RowModel<TData>
+  /**
+   * Returns the row model for the table before any pagination has been applied.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/pagination#getprepaginationrowmodel)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/pagination)
+   */
+  getPrePaginationRowModel: () => RowModel<TData>
+  /**
+   * Increments the page index by one, if possible.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/pagination#nextpage)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/pagination)
+   */
+  nextPage: () => void
+  /**
+   * Decrements the page index by one, if possible.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/pagination#previouspage)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/pagination)
+   */
+  previousPage: () => void
+  /**
+   * Resets the page index to its initial state. If `defaultState` is `true`, the page index will be reset to `0` regardless of initial state.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/pagination#resetpageindex)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/pagination)
+   */
   resetPageIndex: (defaultState?: boolean) => void
-  setPageSize: (updater: Updater<number>) => void
+  /**
+   * Resets the page size to its initial state. If `defaultState` is `true`, the page size will be reset to `10` regardless of initial state.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/pagination#resetpagesize)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/pagination)
+   */
   resetPageSize: (defaultState?: boolean) => void
+  /**
+   * Resets the **pagination** state to `initialState.pagination`, or `true` can be passed to force a default blank state reset to `[]`.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/pagination#resetpagination)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/pagination)
+   */
+  resetPagination: (defaultState?: boolean) => void
+  /**
+   * Updates the page count using the provided function or value.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/pagination#setpagecount)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/pagination)
+   */
   setPageCount: (updater: Updater<number>) => void
-  getPageOptions: () => number[]
-  getCanPreviousPage: () => boolean
-  getCanNextPage: () => boolean
-  previousPage: () => void
-  nextPage: () => void
-  getPrePaginationRowModel: () => RowModel<TData>
-  getPaginationRowModel: () => RowModel<TData>
-  _getPaginationRowModel?: () => RowModel<TData>
-  getPageCount: () => number
+  /**
+   * Updates the page index using the provided function or value in the `state.pagination.pageIndex` state.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/pagination#setpageindex)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/pagination)
+   */
+  setPageIndex: (updater: Updater<number>) => void
+  /**
+   * Updates the page size using the provided function or value in the `state.pagination.pageSize` state.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/pagination#setpagesize)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/pagination)
+   */
+  setPageSize: (updater: Updater<number>) => void
+  /**
+   * Sets or updates the `state.pagination` state.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/pagination#setpagination)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/pagination)
+   */
+  setPagination: (updater: Updater<PaginationState>) => void
 }
 
 //

package/src/features/Pinning.ts

@@ -19,8 +19,8 @@ export interface ColumnPinningState {
 }
 
 export interface RowPinningState {
-  top?: string[]
   bottom?: string[]
+  top?: string[]
 }
 
 export interface ColumnPinningTableState {
@@ -32,15 +32,45 @@ export interface RowPinningTableState {
 }
 
 export interface ColumnPinningOptions {
-  onColumnPinningChange?: OnChangeFn<ColumnPinningState>
-  enablePinning?: boolean
+  /**
+   * Enables/disables column pinning for the table. Defaults to `true`.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/pinning#enablecolumnpinning)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/pinning)
+   */
   enableColumnPinning?: boolean
+  /**
+   * Enables/disables all pinning for the table. Defaults to `true`.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/pinning#enablepinning)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/pinning)
+   */
+  enablePinning?: boolean
+  /**
+   * If provided, this function will be called with an `updaterFn` when `state.columnPinning` changes. This overrides the default internal state management, so you will also need to supply `state.columnPinning` from your own managed state.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/pinning#oncolumnpinningchange)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/oncolumnpinningchange)
+   */
+  onColumnPinningChange?: OnChangeFn<ColumnPinningState>
 }
 
 export interface RowPinningOptions<TData extends RowData> {
-  onRowPinningChange?: OnChangeFn<RowPinningState>
+  /**
+   * Enables/disables row pinning for the table. Defaults to `true`.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/pinning#enablerowpinning)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/pinning)
+   */
   enableRowPinning?: boolean | ((row: Row<TData>) => boolean)
+  /**
+   * When `false`, pinned rows will not be visible if they are filtered or paginated out of the table. When `true`, pinned rows will always be visible regardless of filtering or pagination. Defaults to `true`.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/pinning#keeppinnedrows)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/pinning)
+   */
   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.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/pinning#onrowpinningchange)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/onrowpinningchange)
+   */
+  onRowPinningChange?: OnChangeFn<RowPinningState>
 }
 
 export interface ColumnPinningDefaultOptions {
@@ -52,26 +82,86 @@ export interface RowPinningDefaultOptions {
 }
 
 export interface ColumnPinningColumnDef {
+  /**
+   * Enables/disables column pinning for this column. Defaults to `true`.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/pinning#enablepinning-1)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/pinning)
+   */
   enablePinning?: boolean
 }
 
 export interface ColumnPinningColumn {
+  /**
+   * Returns whether or not the column can be pinned.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/pinning#getcanpin)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/pinning)
+   */
   getCanPin: () => boolean
-  getPinnedIndex: () => number
+  /**
+   * Returns the pinned position of the column. (`'left'`, `'right'` or `false`)
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/pinning#getispinned)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/pinning)
+   */
   getIsPinned: () => ColumnPinningPosition
+  /**
+   * Returns the numeric pinned index of the column within a pinned column group.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/pinning#getpinnedindex)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/pinning)
+   */
+  getPinnedIndex: () => number
+  /**
+   * Pins a column to the `'left'` or `'right'`, or unpins the column to the center if `false` is passed.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/pinning#pin)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/pinning)
+   */
   pin: (position: ColumnPinningPosition) => void
 }
 
 export interface ColumnPinningRow<TData extends RowData> {
-  getLeftVisibleCells: () => Cell<TData, unknown>[]
+  /**
+   * Returns all center pinned (unpinned) leaf cells in the row.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/pinning#getcentervisiblecells)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/pinning)
+   */
   getCenterVisibleCells: () => Cell<TData, unknown>[]
+  /**
+   * Returns all left pinned leaf cells in the row.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/pinning#getleftvisiblecells)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/pinning)
+   */
+  getLeftVisibleCells: () => Cell<TData, unknown>[]
+  /**
+   * Returns all right pinned leaf cells in the row.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/pinning#getrightvisiblecells)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/pinning)
+   */
   getRightVisibleCells: () => Cell<TData, unknown>[]
 }
 
 export interface RowPinningRow {
+  /**
+   * Returns whether or not the row can be pinned.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/pinning#getcanpin-1)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/pinning)
+   */
   getCanPin: () => boolean
+  /**
+   * Returns the pinned position of the row. (`'top'`, `'bottom'` or `false`)
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/pinning#getispinned-1)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/pinning)
+   */
   getIsPinned: () => RowPinningPosition
+  /**
+   * Returns the numeric pinned index of the row within a pinned row group.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/pinning#getpinnedindex-1)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/pinning)
+   */
   getPinnedIndex: () => number
+  /**
+   * Pins a row to the `'top'` or `'bottom'`, or unpins the row to the center if `false` is passed.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/pinning#pin-1)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/pinning)
+   */
   pin: (
     position: RowPinningPosition,
     includeLeafRows?: boolean,
@@ -80,22 +170,82 @@ export interface RowPinningRow {
 }
 
 export interface ColumnPinningInstance<TData extends RowData> {
-  setColumnPinning: (updater: Updater<ColumnPinningState>) => void
-  resetColumnPinning: (defaultState?: boolean) => void
+  /**
+   * Returns all center pinned (unpinned) leaf columns.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/pinning#getcenterleafcolumns)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/pinning)
+   */
+  getCenterLeafColumns: () => Column<TData, unknown>[]
+  /**
+   * Returns whether or not any columns are pinned. Optionally specify to only check for pinned columns in either the `left` or `right` position.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/pinning#getissomecolumnspinned)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/pinning)
+   */
   getIsSomeColumnsPinned: (position?: ColumnPinningPosition) => boolean
+  /**
+   * Returns all left pinned leaf columns.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/pinning#getleftleafcolumns)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/pinning)
+   */
   getLeftLeafColumns: () => Column<TData, unknown>[]
+  /**
+   * Returns all right pinned leaf columns.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/pinning#getrightleafcolumns)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/pinning)
+   */
   getRightLeafColumns: () => Column<TData, unknown>[]
-  getCenterLeafColumns: () => Column<TData, unknown>[]
+  /**
+   * Resets the **columnPinning** state to `initialState.columnPinning`, or `true` can be passed to force a default blank state reset to `{ left: [], right: [], }`.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/pinning#resetcolumnpinning)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/pinning)
+   */
+  resetColumnPinning: (defaultState?: boolean) => void
+  /**
+   * Sets or updates the `state.columnPinning` state.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/pinning#setcolumnpinning)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/pinning)
+   */
+  setColumnPinning: (updater: Updater<ColumnPinningState>) => void
 }
 
 export interface RowPinningInstance<TData extends RowData> {
-  setRowPinning: (updater: Updater<RowPinningState>) => void
-  resetRowPinning: (defaultState?: boolean) => void
-  getIsSomeRowsPinned: (position?: RowPinningPosition) => boolean
   _getPinnedRows: (position: 'top' | 'bottom') => Row<TData>[]
-  getTopRows: () => Row<TData>[]
+  /**
+   * Returns all bottom pinned rows.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/pinning#getbottomrows)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/pinning)
+   */
   getBottomRows: () => Row<TData>[]
+  /**
+   * Returns all rows that are not pinned to the top or bottom.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/pinning#getcenterrows)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/pinning)
+   */
   getCenterRows: () => Row<TData>[]
+  /**
+   * Returns whether or not any rows are pinned. Optionally specify to only check for pinned rows in either the `top` or `bottom` position.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/pinning#getissomerowspinned)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/pinning)
+   */
+  getIsSomeRowsPinned: (position?: RowPinningPosition) => boolean
+  /**
+   * Returns all top pinned rows.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/pinning#gettoprows)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/pinning)
+   */
+  getTopRows: () => Row<TData>[]
+  /**
+   * Resets the **rowPinning** state to `initialState.rowPinning`, or `true` can be passed to force a default blank state reset to `{ top: [], bottom: [], }`.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/pinning#resetrowpinning)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/pinning)
+   */
+  resetRowPinning: (defaultState?: boolean) => void
+  /**
+   * Sets or updates the `state.rowPinning` state.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/pinning#setrowpinning)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/pinning)
+   */
+  setRowPinning: (updater: Updater<RowPinningState>) => void
 }
 
 //

package/src/features/RowSelection.ts

@@ -9,9 +9,32 @@ export interface RowSelectionTableState {
 }
 
 export interface RowSelectionOptions<TData extends RowData> {
-  enableRowSelection?: boolean | ((row: Row<TData>) => boolean)
+  /**
+   * - Enables/disables multiple row selection for all rows in the table OR
+   * - A function that given a row, returns whether to enable/disable multiple row selection for that row's children/grandchildren
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/row-selection#enablemultirowselection)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/row-selection)
+   */
   enableMultiRowSelection?: boolean | ((row: Row<TData>) => boolean)
+  /**
+   * - Enables/disables row selection for all rows in the table OR
+   * - A function that given a row, returns whether to enable/disable row selection for that row
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/row-selection#enablerowselection)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/row-selection)
+   */
+  enableRowSelection?: boolean | ((row: Row<TData>) => boolean)
+  /**
+   * Enables/disables automatic sub-row selection when a parent row is selected, or a function that enables/disables automatic sub-row selection for each row.
+   * (Use in combination with expanding or grouping features)
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/row-selection#enablesubrowselection)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/row-selection)
+   */
   enableSubRowSelection?: boolean | ((row: Row<TData>) => boolean)
+  /**
+   * If provided, this function will be called with an `updaterFn` when `state.rowSelection` changes. This overrides the default internal state management, so you will need to persist the state change either fully or partially outside of the table.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/row-selection#onrowselectionchange)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/row-selection)
+   */
   onRowSelectionChange?: OnChangeFn<RowSelectionState>
   // enableGroupingRowSelection?:
   //   | boolean
@@ -27,31 +50,141 @@ export interface RowSelectionOptions<TData extends RowData> {
 }
 
 export interface RowSelectionRow {
-  getIsSelected: () => boolean
-  getIsSomeSelected: () => boolean
-  getIsAllSubRowsSelected: () => boolean
-  getCanSelect: () => boolean
+  /**
+   * Returns whether or not the row can multi-select.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/row-selection#getcanmultiselect)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/row-selection)
+   */
   getCanMultiSelect: () => boolean
+  /**
+   * Returns whether or not the row can be selected.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/row-selection#getcanselect)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/row-selection)
+   */
+  getCanSelect: () => boolean
+  /**
+   * Returns whether or not the row can select sub rows automatically when the parent row is selected.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/row-selection#getcanselectsubrows)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/row-selection)
+   */
   getCanSelectSubRows: () => boolean
-  toggleSelected: (value?: boolean) => void
+  /**
+   * Returns whether or not all of the row's sub rows are selected.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/row-selection#getisallsubrowsselected)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/row-selection)
+   */
+  getIsAllSubRowsSelected: () => boolean
+  /**
+   * Returns whether or not the row is selected.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/row-selection#getisselected)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/row-selection)
+   */
+  getIsSelected: () => boolean
+  /**
+   * Returns whether or not some of the row's sub rows are selected.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/row-selection#getissomeselected)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/row-selection)
+   */
+  getIsSomeSelected: () => boolean
+  /**
+   * Returns a handler that can be used to toggle the row.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/row-selection#gettoggleselectedhandler)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/row-selection)
+   */
   getToggleSelectedHandler: () => (event: unknown) => void
+  /**
+   * Selects/deselects the row.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/row-selection#toggleselected)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/row-selection)
+   */
+  toggleSelected: (value?: boolean, opts?: { selectChildren?: boolean }) => void
 }
 
 export interface RowSelectionInstance<TData extends RowData> {
-  getToggleAllRowsSelectedHandler: () => (event: unknown) => void
-  getToggleAllPageRowsSelectedHandler: () => (event: unknown) => void
-  setRowSelection: (updater: Updater<RowSelectionState>) => void
-  resetRowSelection: (defaultState?: boolean) => void
-  getIsAllRowsSelected: () => boolean
+  /**
+   * Returns the row model of all rows that are selected after filtering has been applied.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/row-selection#getfilteredselectedrowmodel)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/row-selection)
+   */
+  getFilteredSelectedRowModel: () => RowModel<TData>
+  /**
+   * Returns the row model of all rows that are selected after grouping has been applied.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/row-selection#getgroupedselectedrowmodel)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/row-selection)
+   */
+  getGroupedSelectedRowModel: () => RowModel<TData>
+  /**
+   * Returns whether or not all rows on the current page are selected.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/row-selection#getisallpagerowsselected)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/row-selection)
+   */
   getIsAllPageRowsSelected: () => boolean
-  getIsSomeRowsSelected: () => boolean
+  /**
+   * Returns whether or not all rows in the table are selected.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/row-selection#getisallrowsselected)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/row-selection)
+   */
+  getIsAllRowsSelected: () => boolean
+  /**
+   * Returns whether or not all rows on the current page are selected.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/row-selection#getissomepagerowsselected)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/row-selection)
+   */
   getIsSomePageRowsSelected: () => boolean
-  toggleAllRowsSelected: (value?: boolean) => void
-  toggleAllPageRowsSelected: (value?: boolean) => void
+  /**
+   * Returns whether or not all rows in the table are selected.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/row-selection#getissomerowsselected)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/row-selection)
+   */
+  getIsSomeRowsSelected: () => boolean
+  /**
+   * Returns the core row model of all rows before row selection has been applied.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/row-selection#getpreselectedrowmodel)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/row-selection)
+   */
   getPreSelectedRowModel: () => RowModel<TData>
+  /**
+   * Returns the row model of all rows that are selected.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/row-selection#getselectedrowmodel)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/row-selection)
+   */
   getSelectedRowModel: () => RowModel<TData>
-  getFilteredSelectedRowModel: () => RowModel<TData>
-  getGroupedSelectedRowModel: () => RowModel<TData>
+  /**
+   * Returns a handler that can be used to toggle all rows on the current page.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/row-selection#gettoggleallpagerowsselectedhandler)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/row-selection)
+   */
+  getToggleAllPageRowsSelectedHandler: () => (event: unknown) => void
+  /**
+   * Returns a handler that can be used to toggle all rows in the table.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/row-selection#gettoggleallrowsselectedhandler)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/row-selection)
+   */
+  getToggleAllRowsSelectedHandler: () => (event: unknown) => void
+  /**
+   * Resets the **rowSelection** state to the `initialState.rowSelection`, or `true` can be passed to force a default blank state reset to `{}`.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/row-selection#resetrowselection)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/row-selection)
+   */
+  resetRowSelection: (defaultState?: boolean) => void
+  /**
+   * Sets or updates the `state.rowSelection` state.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/row-selection#setrowselection)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/row-selection)
+   */
+  setRowSelection: (updater: Updater<RowSelectionState>) => void
+  /**
+   * Selects/deselects all rows on the current page.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/row-selection#toggleallpagerowsselected)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/row-selection)
+   */
+  toggleAllPageRowsSelected: (value?: boolean) => void
+  /**
+   * Selects/deselects all rows in the table.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/row-selection#toggleallrowsselected)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/row-selection)
+   */
+  toggleAllRowsSelected: (value?: boolean) => void
 }
 
 //
@@ -342,7 +475,7 @@ export const RowSelection: TableFeature = {
     row: Row<TData>,
     table: Table<TData>
   ): void => {
-    row.toggleSelected = value => {
+    row.toggleSelected = (value, opts) => {
       const isSelected = row.getIsSelected()
 
       table.setRowSelection(old => {
@@ -354,7 +487,9 @@ export const RowSelection: TableFeature = {
 
         const selectedRowIds = { ...old }
 
-        mutateRowIsSelected(selectedRowIds, row.id, value, table)
+        if (opts?.selectChildren ?? true) {
+          mutateRowIsSelected(selectedRowIds, row.id, value, table)
+        }
 
         return selectedRowIds
       })
@@ -497,7 +632,7 @@ export function isSubRowSelected<TData extends RowData>(
   table: Table<TData>
 ): boolean | 'some' | 'all' {
   if (!row.subRows?.length) return false
-  
+
   let allChildrenSelected = true
   let someSelected = false