@tanstack/table-core 8.10.1 → 8.10.2

package/src/core/table.ts

@@ -34,14 +34,14 @@ import { Sorting } from '../features/Sorting'
 import { Visibility } from '../features/Visibility'
 
 export interface TableFeature {
-  getDefaultOptions?: (table: any) => any
-  getInitialState?: (initialState?: InitialTableState) => any
-  createTable?: (table: any) => any
-  getDefaultColumnDef?: () => any
+  createCell?: (cell: any, column: any, row: any, table: any) => any
   createColumn?: (column: any, table: any) => any
   createHeader?: (column: any, table: any) => any
-  createCell?: (cell: any, column: any, row: any, table: any) => any
   createRow?: (row: any, table: any) => any
+  createTable?: (table: any) => any
+  getDefaultColumnDef?: () => any
+  getDefaultOptions?: (table: any) => any
+  getInitialState?: (initialState?: InitialTableState) => any
 }
 
 const features = [
@@ -63,50 +63,211 @@ const features = [
 export interface CoreTableState {}
 
 export interface CoreOptions<TData extends RowData> {
+  /**
+   * Set this option to override any of the `autoReset...` feature options.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/table#autoresetall)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/tables)
+   */
+  autoResetAll?: boolean
+  /**
+   * The array of column defs to use for the table.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/table#columns)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/tables)
+   */
+  columns: ColumnDef<TData, any>[]
+  /**
+   * The data for the table to display. This array should match the type you provided to `table.setRowType<...>`. Columns can access this data via string/index or a functional accessor. When the `data` option changes reference, the table will reprocess the data.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/table#data)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/tables)
+   */
   data: TData[]
-  state: Partial<TableState>
-  onStateChange: (updater: Updater<TableState>) => void
+  /**
+   * Set this option to `true` to output all debugging information to the console.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/table#debugall)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/tables)
+   */
   debugAll?: boolean
-  debugTable?: boolean
-  debugHeaders?: boolean
+  /**
+   * Set this option to `true` to output column debugging information to the console.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/table#debugcolumns)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/tables)
+   */
   debugColumns?: boolean
+  /**
+   * Set this option to `true` to output header debugging information to the console.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/table#debugheaders)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/tables)
+   */
+  debugHeaders?: boolean
+  /**
+   * Set this option to `true` to output row debugging information to the console.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/table#debugrows)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/tables)
+   */
   debugRows?: boolean
+  /**
+   * Set this option to `true` to output table debugging information to the console.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/table#debugtable)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/tables)
+   */
+  debugTable?: boolean
+  /**
+   * Default column options to use for all column defs supplied to the table.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/table#defaultcolumn)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/tables)
+   */
+  defaultColumn?: Partial<ColumnDef<TData, unknown>>
+  /**
+   * This required option is a factory for a function that computes and returns the core row model for the table.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/table#getcorerowmodel)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/tables)
+   */
+  getCoreRowModel: (table: Table<any>) => () => RowModel<any>
+  /**
+   * This optional function is used to derive a unique ID for any given row. If not provided the rows index is used (nested rows join together with `.` using their grandparents' index eg. `index.index.index`). If you need to identify individual rows that are originating from any server-side operations, it's suggested you use this function to return an ID that makes sense regardless of network IO/ambiguity eg. a userId, taskId, database ID field, etc.
+   * @example getRowId: row => row.userId
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/table#getrowid)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/tables)
+   */
+  getRowId?: (originalRow: TData, index: number, parent?: Row<TData>) => string
+  /**
+   * This optional function is used to access the sub rows for any given row. If you are using nested rows, you will need to use this function to return the sub rows object (or undefined) from the row.
+   * @example getSubRows: row => row.subRows
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/table#getsubrows)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/tables)
+   */
+  getSubRows?: (originalRow: TData, index: number) => undefined | TData[]
+  /**
+   * Use this option to optionally pass initial state to the table. This state will be used when resetting various table states either automatically by the table (eg. `options.autoResetPageIndex`) or via functions like `table.resetRowSelection()`. Most reset function allow you optionally pass a flag to reset to a blank/default state instead of the initial state.
+   *
+   * Table state will not be reset when this object changes, which also means that the initial state object does not need to be stable.
+   *
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/table#initialstate)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/tables)
+   */
   initialState?: InitialTableState
-  autoResetAll?: boolean
+  /**
+   * This option is used to optionally implement the merging of table options.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/table#mergeoptions)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/tables)
+   */
   mergeOptions?: (
     defaultOptions: TableOptions<TData>,
     options: Partial<TableOptions<TData>>
   ) => TableOptions<TData>
+  /**
+   * You can pass any object to `options.meta` and access it anywhere the `table` is available via `table.options.meta`.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/table#meta)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/tables)
+   */
   meta?: TableMeta<TData>
-  getCoreRowModel: (table: Table<any>) => () => RowModel<any>
-  getSubRows?: (originalRow: TData, index: number) => undefined | TData[]
-  getRowId?: (originalRow: TData, index: number, parent?: Row<TData>) => string
-  columns: ColumnDef<TData, any>[]
-  defaultColumn?: Partial<ColumnDef<TData, unknown>>
+  /**
+   * The `onStateChange` option can be used to optionally listen to state changes within the table.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/table#onstatechange)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/tables)
+   */
+  onStateChange: (updater: Updater<TableState>) => void
+  /**
+   * Value used when the desired value is not found in the data.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/table#renderfallbackvalue)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/tables)
+   */
   renderFallbackValue: any
+  /**
+   * The `state` option can be used to optionally _control_ part or all of the table state. The state you pass here will merge with and overwrite the internal automatically-managed state to produce the final state for the table. You can also listen to state changes via the `onStateChange` option.
+   * > Note: Any state passed in here will override both the internal state and any other `initialState` you provide.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/table#state)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/tables)
+   */
+  state: Partial<TableState>
 }
 
 export interface CoreInstance<TData extends RowData> {
-  initialState: TableState
-  reset: () => void
-  options: RequiredKeys<TableOptionsResolved<TData>, 'state'>
-  setOptions: (newOptions: Updater<TableOptionsResolved<TData>>) => void
-  getState: () => TableState
-  setState: (updater: Updater<TableState>) => void
   _features: readonly TableFeature[]
-  _queue: (cb: () => void) => void
-  _getRowId: (_: TData, index: number, parent?: Row<TData>) => string
-  getCoreRowModel: () => RowModel<TData>
+  _getAllFlatColumnsById: () => Record<string, Column<TData, unknown>>
+  _getColumnDefs: () => ColumnDef<TData, unknown>[]
   _getCoreRowModel?: () => RowModel<TData>
-  getRowModel: () => RowModel<TData>
-  getRow: (id: string, searchAll?: boolean) => Row<TData>
   _getDefaultColumnDef: () => Partial<ColumnDef<TData, unknown>>
-  _getColumnDefs: () => ColumnDef<TData, unknown>[]
-  _getAllFlatColumnsById: () => Record<string, Column<TData, unknown>>
+  _getRowId: (_: TData, index: number, parent?: Row<TData>) => string
+  _queue: (cb: () => void) => void
+  /**
+   * Returns all columns in the table in their normalized and nested hierarchy.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/table#getallcolumns)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/tables)
+   */
   getAllColumns: () => Column<TData, unknown>[]
+  /**
+   * Returns all columns in the table flattened to a single level.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/table#getallflatcolumns)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/tables)
+   */
   getAllFlatColumns: () => Column<TData, unknown>[]
+  /**
+   * Returns all leaf-node columns in the table flattened to a single level. This does not include parent columns.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/table#getallleafcolumns)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/tables)
+   */
   getAllLeafColumns: () => Column<TData, unknown>[]
+  /**
+   * Returns a single column by its ID.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/table#getcolumn)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/tables)
+   */
   getColumn: (columnId: string) => Column<TData, unknown> | undefined
+  /**
+   * Returns the core row model before any processing has been applied.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/table#getcorerowmodel)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/tables)
+   */
+  getCoreRowModel: () => RowModel<TData>
+  /**
+   * Returns the row with the given ID.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/table#getrow)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/tables)
+   */
+  getRow: (id: string, searchAll?: boolean) => Row<TData>
+  /**
+   * Returns the final model after all processing from other used features has been applied. This is the row model that is most commonly used for rendering.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/table#getrowmodel)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/tables)
+   */
+  getRowModel: () => RowModel<TData>
+  /**
+   * Call this function to get the table's current state. It's recommended to use this function and its state, especially when managing the table state manually. It is the exact same state used internally by the table for every feature and function it provides.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/table#getstate)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/tables)
+   */
+  getState: () => TableState
+  /**
+   * This is the resolved initial state of the table.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/table#initialstate)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/tables)
+   */
+  initialState: TableState
+  /**
+   * A read-only reference to the table's current options.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/table#options)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/tables)
+   */
+  options: RequiredKeys<TableOptionsResolved<TData>, 'state'>
+  /**
+   * Call this function to reset the table state to the initial state.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/table#reset)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/tables)
+   */
+  reset: () => void
+  /**
+   * This function can be used to update the table options.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/table#setoptions)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/tables)
+   */
+  setOptions: (newOptions: Updater<TableOptionsResolved<TData>>) => void
+  /**
+   * Call this function to update the table state.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/table#setstate)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/tables)
+   */
+  setState: (updater: Updater<TableState>) => void
 }
 
 export function createTable<TData extends RowData>(

package/src/features/ColumnSizing.ts

@@ -13,59 +13,182 @@ export interface ColumnSizingTableState {
 export type ColumnSizingState = Record<string, number>
 
 export interface ColumnSizingInfoState {
-  startOffset: null | number
-  startSize: null | number
+  columnSizingStart: [string, number][]
   deltaOffset: null | number
   deltaPercentage: null | number
   isResizingColumn: false | string
-  columnSizingStart: [string, number][]
+  startOffset: null | number
+  startSize: null | number
 }
 
 export type ColumnResizeMode = 'onChange' | 'onEnd'
 
 export interface ColumnSizingOptions {
-  enableColumnResizing?: boolean
+  /**
+   * Determines when the columnSizing state is updated. `onChange` updates the state when the user is dragging the resize handle. `onEnd` updates the state when the user releases the resize handle.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#columnresizemode)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-sizing)
+   */
   columnResizeMode?: ColumnResizeMode
+  /**
+   * Enables or disables column resizing for the column.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#enablecolumnresizing)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-sizing)
+   */
+  enableColumnResizing?: boolean
+  /**
+   * If provided, this function will be called with an `updaterFn` when `state.columnSizing` changes. This overrides the default internal state management, so you will also need to supply `state.columnSizing` from your own managed state.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#oncolumnsizingchange)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-sizing)
+   */
   onColumnSizingChange?: OnChangeFn<ColumnSizingState>
+  /**
+   * If provided, this function will be called with an `updaterFn` when `state.columnSizingInfo` changes. This overrides the default internal state management, so you will also need to supply `state.columnSizingInfo` from your own managed state.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#oncolumnsizinginfochange)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-sizing)
+   */
   onColumnSizingInfoChange?: OnChangeFn<ColumnSizingInfoState>
 }
 
-export interface ColumnSizingDefaultOptions {
-  columnResizeMode: ColumnResizeMode
-  onColumnSizingChange: OnChangeFn<ColumnSizingState>
-  onColumnSizingInfoChange: OnChangeFn<ColumnSizingInfoState>
-}
+export type ColumnSizingDefaultOptions = Pick<
+  ColumnSizingOptions,
+  'columnResizeMode' | 'onColumnSizingChange' | 'onColumnSizingInfoChange'
+>
 
 export interface ColumnSizingInstance {
-  setColumnSizing: (updater: Updater<ColumnSizingState>) => void
-  setColumnSizingInfo: (updater: Updater<ColumnSizingInfoState>) => void
-  resetColumnSizing: (defaultState?: boolean) => void
-  resetHeaderSizeInfo: (defaultState?: boolean) => void
-  getTotalSize: () => number
-  getLeftTotalSize: () => number
+  /**
+   * If pinning, returns the total size of the center portion of the table by calculating the sum of the sizes of all unpinned/center leaf-columns.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#getcentertotalsize)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-sizing)
+   */
   getCenterTotalSize: () => number
+  /**
+   * Returns the total size of the left portion of the table by calculating the sum of the sizes of all left leaf-columns.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#getlefttotalsize)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-sizing)
+   */
+  getLeftTotalSize: () => number
+  /**
+   * Returns the total size of the right portion of the table by calculating the sum of the sizes of all right leaf-columns.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#getrighttotalsize)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-sizing)
+   */
   getRightTotalSize: () => number
+  /**
+   * Returns the total size of the table by calculating the sum of the sizes of all leaf-columns.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#gettotalsize)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-sizing)
+   */
+  getTotalSize: () => number
+  /**
+   * Resets column sizing to its initial state. If `defaultState` is `true`, the default state for the table will be used instead of the initialValue provided to the table.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#resetcolumnsizing)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-sizing)
+   */
+  resetColumnSizing: (defaultState?: boolean) => void
+  /**
+   * Resets column sizing info to its initial state. If `defaultState` is `true`, the default state for the table will be used instead of the initialValue provided to the table.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#resetheadersizeinfo)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-sizing)
+   */
+  resetHeaderSizeInfo: (defaultState?: boolean) => void
+  /**
+   * Sets the column sizing state using an updater function or a value. This will trigger the underlying `onColumnSizingChange` function if one is passed to the table options, otherwise the state will be managed automatically by the table.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#setcolumnsizing)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-sizing)
+   */
+  setColumnSizing: (updater: Updater<ColumnSizingState>) => void
+  /**
+   * Sets the column sizing info state using an updater function or a value. This will trigger the underlying `onColumnSizingInfoChange` function if one is passed to the table options, otherwise the state will be managed automatically by the table.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#setcolumnsizinginfo)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-sizing)
+   */
+  setColumnSizingInfo: (updater: Updater<ColumnSizingInfoState>) => void
 }
 
 export interface ColumnSizingColumnDef {
+  /**
+   * Enables or disables column resizing for the column.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#enableresizing)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-sizing)
+   */
   enableResizing?: boolean
-  size?: number
-  minSize?: number
+  /**
+   * The maximum allowed size for the column
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#maxsize)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-sizing)
+   */
   maxSize?: number
+  /**
+   * The minimum allowed size for the column
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#minsize)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-sizing)
+   */
+  minSize?: number
+  /**
+   * The desired size for the column
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#size)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-sizing)
+   */
+  size?: number
 }
 
 export interface ColumnSizingColumn {
-  getSize: () => number
-  getStart: (position?: ColumnPinningPosition) => number
+  /**
+   * Returns `true` if the column can be resized.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#getcanresize)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-sizing)
+   */
   getCanResize: () => boolean
+  /**
+   * Returns `true` if the column is currently being resized.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#getisresizing)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-sizing)
+   */
   getIsResizing: () => boolean
+  /**
+   * Returns the current size of the column.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#getsize)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-sizing)
+   */
+  getSize: () => number
+  /**
+   * Returns the offset measurement along the row-axis (usually the x-axis for standard tables) for the header. This is effectively a sum of the offset measurements of all preceding headers.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#getstart)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-sizing)
+   */
+  getStart: (position?: ColumnPinningPosition) => number
+  /**
+   * Resets the column to its initial size.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#resetsize)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-sizing)
+   */
   resetSize: () => void
 }
 
 export interface ColumnSizingHeader {
+  /**
+   * Returns an event handler function that can be used to resize the header. It can be used as an:
+   * - `onMouseDown` handler
+   * - `onTouchStart` handler
+   *
+   * The dragging and release events are automatically handled for you.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#getresizehandler)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-sizing)
+   */
+  getResizeHandler: () => (event: unknown) => void
+  /**
+   * Returns the current size of the header.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#getsize)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-sizing)
+   */
   getSize: () => number
+  /**
+   * Returns the offset measurement along the row-axis (usually the x-axis for standard tables) for the header. This is effectively a sum of the offset measurements of all preceding headers.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#getstart)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-sizing)
+   */
   getStart: (position?: ColumnPinningPosition) => number
-  getResizeHandler: () => (event: unknown) => void
 }
 
 //

package/src/features/Expanding.ts

@@ -10,37 +10,152 @@ export interface ExpandedTableState {
 }
 
 export interface ExpandedRow {
-  toggleExpanded: (expanded?: boolean) => void
-  getIsExpanded: () => boolean
+  /**
+   * Returns whether the row can be expanded.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/expanding#getcanexpand)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/expanding)
+   */
   getCanExpand: () => boolean
+  /**
+   * Returns whether all parent rows of the row are expanded.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/expanding#getisallparentsexpanded)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/expanding)
+   */
   getIsAllParentsExpanded: () => boolean
+  /**
+   * Returns whether the row is expanded.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/expanding#getisexpanded)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/expanding)
+   */
+  getIsExpanded: () => boolean
+  /**
+   * Returns a function that can be used to toggle the expanded state of the row. This function can be used to bind to an event handler to a button.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/expanding#gettoggleexpandedhandler)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/expanding)
+   */
   getToggleExpandedHandler: () => () => void
+  /**
+   * Toggles the expanded state (or sets it if `expanded` is provided) for the row.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/expanding#toggleexpanded)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/expanding)
+   */
+  toggleExpanded: (expanded?: boolean) => void
 }
 
 export interface ExpandedOptions<TData extends RowData> {
-  manualExpanding?: boolean
-  onExpandedChange?: OnChangeFn<ExpandedState>
+  /**
+   * Enable this setting to automatically reset the expanded state of the table when expanding state changes.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/expanding#autoresetexpanded)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/expanding)
+   */
   autoResetExpanded?: boolean
+  /**
+   * Enable/disable expanding for all rows.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/expanding#enableexpanding)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/expanding)
+   */
   enableExpanding?: boolean
+  /**
+   * This function is responsible for returning the expanded row model. If this function is not provided, the table will not expand rows. You can use the default exported `getExpandedRowModel` function to get the expanded row model or implement your own.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/expanding#getexpandedrowmodel)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/expanding)
+   */
   getExpandedRowModel?: (table: Table<any>) => () => RowModel<any>
+  /**
+   * If provided, allows you to override the default behavior of determining whether a row is currently expanded.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/expanding#getisrowexpanded)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/expanding)
+   */
   getIsRowExpanded?: (row: Row<TData>) => boolean
+  /**
+   * If provided, allows you to override the default behavior of determining whether a row can be expanded.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/expanding#getrowcanexpand)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/expanding)
+   */
   getRowCanExpand?: (row: Row<TData>) => boolean
+  /**
+   * Enables manual row expansion. If this is set to `true`, `getExpandedRowModel` will not be used to expand rows and you would be expected to perform the expansion in your own data model. This is useful if you are doing server-side expansion.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/expanding#manualexpanding)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/expanding)
+   */
+  manualExpanding?: boolean
+  /**
+   * This function is called when the `expanded` table state changes. If a function is provided, you will be responsible for managing this state on your own. To pass the managed state back to the table, use the `tableOptions.state.expanded` option.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/expanding#onexpandedchange)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/expanding)
+   */
+  onExpandedChange?: OnChangeFn<ExpandedState>
+  /**
+   * If `true` expanded rows will be paginated along with the rest of the table (which means expanded rows may span multiple pages). If `false` expanded rows will not be considered for pagination (which means expanded rows will always render on their parents page. This also means more rows will be rendered than the set page size)
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/expanding#paginateexpandedrows)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/expanding)
+   */
   paginateExpandedRows?: boolean
 }
 
 export interface ExpandedInstance<TData extends RowData> {
   _autoResetExpanded: () => void
-  setExpanded: (updater: Updater<ExpandedState>) => void
-  toggleAllRowsExpanded: (expanded?: boolean) => void
-  resetExpanded: (defaultState?: boolean) => void
+  _getExpandedRowModel?: () => RowModel<TData>
+  /**
+   * Returns whether there are any rows that can be expanded.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/expanding#getcansomerowsexpand)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/expanding)
+   */
   getCanSomeRowsExpand: () => boolean
-  getToggleAllRowsExpandedHandler: () => (event: unknown) => void
-  getIsSomeRowsExpanded: () => boolean
-  getIsAllRowsExpanded: () => boolean
+  /**
+   * Returns the maximum depth of the expanded rows.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/expanding#getexpandeddepth)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/expanding)
+   */
   getExpandedDepth: () => number
+  /**
+   * Returns the row model after expansion has been applied.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/expanding#getexpandedrowmodel)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/expanding)
+   */
   getExpandedRowModel: () => RowModel<TData>
-  _getExpandedRowModel?: () => RowModel<TData>
+  /**
+   * Returns whether all rows are currently expanded.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/expanding#getisallrowsexpanded)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/expanding)
+   */
+  getIsAllRowsExpanded: () => boolean
+  /**
+   * Returns whether there are any rows that are currently expanded.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/expanding#getissomerowsexpanded)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/expanding)
+   */
+  getIsSomeRowsExpanded: () => boolean
+  /**
+   * Returns the row model before expansion has been applied.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/expanding#getpreexpandedrowmodel)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/expanding)
+   */
   getPreExpandedRowModel: () => RowModel<TData>
+  /**
+   * Returns a handler that can be used to toggle the expanded state of all rows. This handler is meant to be used with an `input[type=checkbox]` element.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/expanding#gettoggleallrowsexpandedhandler)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/expanding)
+   */
+  getToggleAllRowsExpandedHandler: () => (event: unknown) => void
+  /**
+   * Resets the expanded state of the table to the initial state.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/expanding#resetexpanded)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/expanding)
+   */
+  resetExpanded: (defaultState?: boolean) => void
+  /**
+   * Updates the expanded state of the table via an update function or value.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/expanding#setexpanded)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/expanding)
+   */
+  setExpanded: (updater: Updater<ExpandedState>) => void
+  /**
+   * Toggles the expanded state for all rows.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/expanding#toggleallrowsexpanded)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/expanding)
+   */
+  toggleAllRowsExpanded: (expanded?: boolean) => void
 }
 
 //