@tanstack/table-core 8.10.0 → 8.10.2

package/src/features/Filters.ts

@@ -65,49 +65,196 @@ export type FilterFnOption<TData extends RowData> =
   | FilterFn<TData>
 
 export interface FiltersColumnDef<TData extends RowData> {
+  /**
+   * The filter function to use with this column. Can be the name of a built-in filter function or a custom filter function.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#filterfn)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)
+   */
   filterFn?: FilterFnOption<TData>
+  /**
+   * Enables/disables the **column** filter for this column.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#enablecolumnfilter)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)
+   */
   enableColumnFilter?: boolean
+  /**
+   * Enables/disables the **global** filter for this column.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#enableglobalfilter)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)
+   */
   enableGlobalFilter?: boolean
 }
 
 export interface FiltersColumn<TData extends RowData> {
+  _getFacetedMinMaxValues?: () => undefined | [number, number]
+  _getFacetedRowModel?: () => RowModel<TData>
+  _getFacetedUniqueValues?: () => Map<any, number>
+  /**
+   * Returns an automatically calculated filter function for the column based off of the columns first known value.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#getautofilterfn)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)
+   */
   getAutoFilterFn: () => FilterFn<TData> | undefined
-  getFilterFn: () => FilterFn<TData> | undefined
-  setFilterValue: (updater: Updater<any>) => void
+  /**
+   * Returns whether or not the column can be **column** filtered.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#getcanfilter)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)
+   */
   getCanFilter: () => boolean
+  /**
+   * Returns whether or not the column can be **globally** filtered. Set to `false` to disable a column from being scanned during global filtering.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#getcanglobalfilter)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)
+   */
   getCanGlobalFilter: () => boolean
+  /**
+   * A function that **computes and returns** a min/max tuple derived from `column.getFacetedRowModel`. Useful for displaying faceted result values.
+   * > ⚠️ Requires that you pass a valid `getFacetedMinMaxValues` function to `options.getFacetedMinMaxValues`. A default implementation is provided via the exported `getFacetedMinMaxValues` function.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#getfacetedminmaxvalues)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)
+   */
+  getFacetedMinMaxValues: () => undefined | [number, number]
+  /**
+   * Returns the row model with all other column filters applied, excluding its own filter. Useful for displaying faceted result counts.
+   * > ⚠️ Requires that you pass a valid `getFacetedRowModel` function to `options.facetedRowModel`. A default implementation is provided via the exported `getFacetedRowModel` function.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#getfacetedrowmodel)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)
+   */
   getFacetedRowModel: () => RowModel<TData>
-  _getFacetedRowModel?: () => RowModel<TData>
-  getIsFiltered: () => boolean
-  getFilterValue: () => unknown
-  getFilterIndex: () => number
+  /**
+   * A function that **computes and returns** a `Map` of unique values and their occurrences derived from `column.getFacetedRowModel`. Useful for displaying faceted result values.
+   * > ⚠️ Requires that you pass a valid `getFacetedUniqueValues` function to `options.getFacetedUniqueValues`. A default implementation is provided via the exported `getFacetedUniqueValues` function.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#getfaceteduniquevalues)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)
+   */
   getFacetedUniqueValues: () => Map<any, number>
-  _getFacetedUniqueValues?: () => Map<any, number>
-  getFacetedMinMaxValues: () => undefined | [number, number]
-  _getFacetedMinMaxValues?: () => undefined | [number, number]
+  /**
+   * Returns the filter function (either user-defined or automatic, depending on configuration) for the columnId specified.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#getfilterfn)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)
+   */
+  getFilterFn: () => FilterFn<TData> | undefined
+  /**
+   * Returns the index (including `-1`) of the column filter in the table's `state.columnFilters` array.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#getfilterindex)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)
+   */
+  getFilterIndex: () => number
+  /**
+   * Returns the current filter value for the column.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#getfiltervalue)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)
+   */
+  getFilterValue: () => unknown
+  /**
+   * Returns whether or not the column is currently filtered.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#getisfiltered)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)
+   */
+  getIsFiltered: () => boolean
+  /**
+   * A function that sets the current filter value for the column. You can pass it a value or an updater function for immutability-safe operations on existing values.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#setfiltervalue)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)
+   */
+  setFilterValue: (updater: Updater<any>) => void
 }
 
 export interface FiltersRow<TData extends RowData> {
+  /**
+   * The column filters map for the row. This object tracks whether a row is passing/failing specific filters by their column ID.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#columnfilters)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)
+   */
   columnFilters: Record<string, boolean>
+  /**
+   * The column filters meta map for the row. This object tracks any filter meta for a row as optionally provided during the filtering process.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#columnfiltersmeta)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)
+   */
   columnFiltersMeta: Record<string, FilterMeta>
 }
 
 interface FiltersOptionsBase<TData extends RowData> {
+  /**
+   * Enables/disables all filtering for the table.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#enablefilters)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)
+   */
   enableFilters?: boolean
-  manualFiltering?: boolean
+  /**
+   * By default, filtering is done from parent rows down (so if a parent row is filtered out, all of its children will be filtered out as well). Setting this option to `true` will cause filtering to be done from leaf rows up (which means parent rows will be included so long as one of their child or grand-child rows is also included).
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#filterfromleafrows)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)
+   */
   filterFromLeafRows?: boolean
-  maxLeafRowFilterDepth?: number
+  /**
+   * If provided, this function is called **once** per table and should return a **new function** which will calculate and return the row model for the table when it's filtered.
+   * - For server-side filtering, this function is unnecessary and can be ignored since the server should already return the filtered row model.
+   * - For client-side filtering, this function is required. A default implementation is provided via any table adapter's `{ getFilteredRowModel }` export.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#getfilteredrowmodel)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)
+   */
   getFilteredRowModel?: (table: Table<any>) => () => RowModel<any>
+  /**
+   * Disables the `getFilteredRowModel` from being used to filter data. This may be useful if your table needs to dynamically support both client-side and server-side filtering.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#manualfiltering)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)
+   */
+  manualFiltering?: boolean
+  /**
+   * By default, filtering is done for all rows (max depth of 100), no matter if they are root level parent rows or the child leaf rows of a parent row. Setting this option to `0` will cause filtering to only be applied to the root level parent rows, with all sub-rows remaining unfiltered. Similarly, setting this option to `1` will cause filtering to only be applied to child leaf rows 1 level deep, and so on.
+
+   * This is useful for situations where you want a row's entire child hierarchy to be visible regardless of the applied filter.
+    * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#maxleafrowfilterdepth)
+    * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)
+   */
+  maxLeafRowFilterDepth?: number
 
   // Column
-  onColumnFiltersChange?: OnChangeFn<ColumnFiltersState>
+  /**
+   * Enables/disables **column** filtering for all columns.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#enablecolumnfilters)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)
+   */
   enableColumnFilters?: boolean
+  /**
+   * If provided, this function will be called with an `updaterFn` when `state.columnFilters` 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/filters#oncolumnfilterschange)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)
+   */
+  onColumnFiltersChange?: OnChangeFn<ColumnFiltersState>
 
   // Global
-  globalFilterFn?: FilterFnOption<TData>
-  onGlobalFilterChange?: OnChangeFn<any>
+  /**
+   * Enables/disables **global** filtering for all columns.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#enableglobalfilter)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)
+   */
   enableGlobalFilter?: boolean
+  /**
+   * If provided, this function will be called with the column and should return `true` or `false` to indicate whether this column should be used for global filtering.
+   * 
+   * This is useful if the column can contain data that is not `string` or `number` (i.e. `undefined`).
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#getcolumncanglobalfilter)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)
+   */
   getColumnCanGlobalFilter?: (column: Column<TData, unknown>) => boolean
+  /**
+   * The filter function to use for global filtering.
+   * - A `string` referencing a built-in filter function
+   * - A `string` that references a custom filter functions provided via the `tableOptions.filterFns` option
+   * - A custom filter function
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#globalfilterfn)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)
+   */
+  globalFilterFn?: FilterFnOption<TData>
+  /**
+   * If provided, this function will be called with an `updaterFn` when `state.globalFilter` 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/filters#onglobalfilterchange)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)
+   */
+  onGlobalFilterChange?: OnChangeFn<any>
 
   // Faceting
   getFacetedRowModel?: (
@@ -137,26 +284,80 @@ export interface FiltersOptions<TData extends RowData>
     ResolvedFilterFns {}
 
 export interface FiltersInstance<TData extends RowData> {
+  /**
+   * Sets or updates the `state.columnFilters` state.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#setcolumnfilters)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)
+   */
   setColumnFilters: (updater: Updater<ColumnFiltersState>) => void
-
+  /**
+   * Resets the **columnFilters** state to `initialState.columnFilters`, or `true` can be passed to force a default blank state reset to `[]`.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#resetcolumnfilters)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)
+   */
   resetColumnFilters: (defaultState?: boolean) => void
 
   // Column Filters
-  getPreFilteredRowModel: () => RowModel<TData>
-  getFilteredRowModel: () => RowModel<TData>
   _getFilteredRowModel?: () => RowModel<TData>
+  /**
+   * Returns the row model for the table after **column** filtering has been applied.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#getfilteredrowmodel)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)
+   */
+  getFilteredRowModel: () => RowModel<TData>
+  /**
+   * Returns the row model for the table before any **column** filtering has been applied.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#getprefilteredrowmodel)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)
+   */
+  getPreFilteredRowModel: () => RowModel<TData>
 
   // Global Filters
-  setGlobalFilter: (updater: Updater<any>) => void
-  resetGlobalFilter: (defaultState?: boolean) => void
-  getGlobalAutoFilterFn: () => FilterFn<TData> | undefined
-  getGlobalFilterFn: () => FilterFn<TData> | undefined
-  getGlobalFacetedRowModel: () => RowModel<TData>
+  _getGlobalFacetedMinMaxValues?: () => undefined | [number, number]
   _getGlobalFacetedRowModel?: () => RowModel<TData>
-  getGlobalFacetedUniqueValues: () => Map<any, number>
   _getGlobalFacetedUniqueValues?: () => Map<any, number>
+  /**
+   * Currently, this function returns the built-in `includesString` filter function. In future releases, it may return more dynamic filter functions based on the nature of the data provided.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#getglobalautofilterfn)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)
+   */
+  getGlobalAutoFilterFn: () => FilterFn<TData> | undefined
+  /**
+   * Returns the faceted min and max values for the global filter.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#getglobalfacetedminmaxvalues)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)
+   */
   getGlobalFacetedMinMaxValues: () => undefined | [number, number]
-  _getGlobalFacetedMinMaxValues?: () => undefined | [number, number]
+  /**
+   * Returns the row model for the table after **global** filtering has been applied.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#getglobalfacetedrowmodel)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)
+   */
+  getGlobalFacetedRowModel: () => RowModel<TData>
+  /**
+   * Returns the faceted unique values for the global filter.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#getglobalfaceteduniquevalues)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)
+   */
+  getGlobalFacetedUniqueValues: () => Map<any, number>
+  /**
+   * Returns the filter function (either user-defined or automatic, depending on configuration) for the global filter.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#getglobalfilterfn)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)
+   */
+  getGlobalFilterFn: () => FilterFn<TData> | undefined
+  /**
+   * Resets the **globalFilter** state to `initialState.globalFilter`, or `true` can be passed to force a default blank state reset to `undefined`.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#resetglobalfilter)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)
+   */
+  resetGlobalFilter: (defaultState?: boolean) => void
+  /**
+   * Sets or updates the `state.globalFilter` state.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#setglobalfilter)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)
+   */
+  setGlobalFilter: (updater: Updater<any>) => void
 }
 
 //

package/src/features/Grouping.ts

@@ -35,50 +35,164 @@ export type AggregationFnOption<TData extends RowData> =
   | AggregationFn<TData>
 
 export interface GroupingColumnDef<TData extends RowData, TValue> {
-  aggregationFn?: AggregationFnOption<TData>
+  /**
+   * The cell to display each row for the column if the cell is an aggregate. If a function is passed, it will be passed a props object with the context of the cell and should return the property type for your adapter (the exact type depends on the adapter being used).
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#aggregatedcell)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/grouping)
+   */
   aggregatedCell?: ColumnDefTemplate<
     ReturnType<Cell<TData, TValue>['getContext']>
   >
+  /**
+   * The resolved aggregation function for the column.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#aggregationfn)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/grouping)
+   */
+  aggregationFn?: AggregationFnOption<TData>
+  /**
+   * Enables/disables grouping for this column.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#enablegrouping)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/grouping)
+   */
   enableGrouping?: boolean
+  /**
+   * Specify a value to be used for grouping rows on this column. If this option is not specified, the value derived from `accessorKey` / `accessorFn` will be used instead.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#getgroupingvalue)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/grouping)
+   */
   getGroupingValue?: (row: TData) => any
 }
 
 export interface GroupingColumn<TData extends RowData> {
+  /**
+   * Returns the aggregation function for the column.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#getaggregationfn)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/grouping)
+   */
+  getAggregationFn: () => AggregationFn<TData> | undefined
+  /**
+   * Returns the automatically inferred aggregation function for the column.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#getautoaggregationfn)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/grouping)
+   */
+  getAutoAggregationFn: () => AggregationFn<TData> | undefined
+  /**
+   * Returns whether or not the column can be grouped.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#getcangroup)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/grouping)
+   */
   getCanGroup: () => boolean
-  getIsGrouped: () => boolean
+  /**
+   * Returns the index of the column in the grouping state.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#getgroupedindex)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/grouping)
+   */
   getGroupedIndex: () => number
-  toggleGrouping: () => void
+  /**
+   * Returns whether or not the column is currently grouped.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#getisgrouped)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/grouping)
+   */
+  getIsGrouped: () => boolean
+  /**
+   * Returns a function that toggles the grouping state of the column. This is useful for passing to the `onClick` prop of a button.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#gettogglegroupinghandler)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/grouping)
+   */
   getToggleGroupingHandler: () => () => void
-  getAutoAggregationFn: () => AggregationFn<TData> | undefined
-  getAggregationFn: () => AggregationFn<TData> | undefined
+  /**
+   * Toggles the grouping state of the column.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#togglegrouping)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/grouping)
+   */
+  toggleGrouping: () => void
 }
 
 export interface GroupingRow {
+  _groupingValuesCache: Record<string, any>
+  /**
+   * Returns the grouping value for any row and column (including leaf rows).
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#getgroupingvalue)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/grouping)
+   */
+  getGroupingValue: (columnId: string) => unknown
+  /**
+   * Returns whether or not the row is currently grouped.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#getisgrouped)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/grouping)
+   */
+  getIsGrouped: () => boolean
+  /**
+   * If this row is grouped, this is the id of the column that this row is grouped by.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#groupingcolumnid)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/grouping)
+   */
   groupingColumnId?: string
+  /**
+   * If this row is grouped, this is the unique/shared value for the `groupingColumnId` for all of the rows in this group.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#groupingvalue)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/grouping)
+   */
   groupingValue?: unknown
-  getIsGrouped: () => boolean
-  getGroupingValue: (columnId: string) => unknown
-  _groupingValuesCache: Record<string, any>
 }
 
 export interface GroupingCell {
+  /**
+   * Returns whether or not the cell is currently aggregated.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#getisaggregated)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/grouping)
+   */
+  getIsAggregated: () => boolean
+  /**
+   * Returns whether or not the cell is currently grouped.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#getisgrouped)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/grouping)
+   */
   getIsGrouped: () => boolean
+  /**
+   * Returns whether or not the cell is currently a placeholder cell.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#getisplaceholder)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/grouping)
+   */
   getIsPlaceholder: () => boolean
-  getIsAggregated: () => boolean
 }
 
 export interface ColumnDefaultOptions {
-  // Column
-  onGroupingChange: OnChangeFn<GroupingState>
   enableGrouping: boolean
+  onGroupingChange: OnChangeFn<GroupingState>
 }
 
 interface GroupingOptionsBase {
-  manualGrouping?: boolean
-  onGroupingChange?: OnChangeFn<GroupingState>
+  /**
+   * Enables/disables grouping for the table.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#enablegrouping)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/grouping)
+   */
   enableGrouping?: boolean
+  /**
+   * Returns the row model after grouping has taken place, but no further.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#getgroupedrowmodel)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/grouping)
+   */
   getGroupedRowModel?: (table: Table<any>) => () => RowModel<any>
+  /**
+   * Grouping 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/grouping#groupedcolumnmode)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/grouping)
+   */
   groupedColumnMode?: false | 'reorder' | 'remove'
+  /**
+   * Enables manual grouping. If this option is set to `true`, the table will not automatically group rows using `getGroupedRowModel()` and instead will expect you to manually group the rows before passing them to the table. This is useful if you are doing server-side grouping and aggregation.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#manualgrouping)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/grouping)
+   */
+  manualGrouping?: boolean
+  /**
+   * If this function is provided, it will be called when the grouping 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.grouping` option.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#ongroupingchange)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/grouping)
+   */
+  onGroupingChange?: OnChangeFn<GroupingState>
 }
 
 type ResolvedAggregationFns = keyof AggregationFns extends never
@@ -96,11 +210,31 @@ export interface GroupingOptions
 export type GroupingColumnMode = false | 'reorder' | 'remove'
 
 export interface GroupingInstance<TData extends RowData> {
-  setGrouping: (updater: Updater<GroupingState>) => void
-  resetGrouping: (defaultState?: boolean) => void
-  getPreGroupedRowModel: () => RowModel<TData>
-  getGroupedRowModel: () => RowModel<TData>
   _getGroupedRowModel?: () => RowModel<TData>
+  /**
+   * Returns the row model for the table after grouping has been applied.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#getgroupedrowmodel)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/grouping)
+   */
+  getGroupedRowModel: () => RowModel<TData>
+  /**
+   * Returns the row model for the table before any grouping has been applied.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#getpregroupedrowmodel)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/grouping)
+   */
+  getPreGroupedRowModel: () => RowModel<TData>
+  /**
+   * Resets the **grouping** state to `initialState.grouping`, or `true` can be passed to force a default blank state reset to `[]`.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#resetgrouping)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/grouping)
+   */
+  resetGrouping: (defaultState?: boolean) => void
+  /**
+   * Updates the grouping state of the table via an update function or value.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#setgrouping)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/grouping)
+   */
+  setGrouping: (updater: Updater<GroupingState>) => void
 }
 
 //

package/src/features/Ordering.ts

@@ -12,6 +12,11 @@ export interface ColumnOrderTableState {
 export type ColumnOrderState = string[]
 
 export interface ColumnOrderOptions {
+  /**
+   * If provided, this function will be called with an `updaterFn` when `state.columnOrder` 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/column-ordering#oncolumnorderchange)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-ordering)
+   */
   onColumnOrderChange?: OnChangeFn<ColumnOrderState>
 }
 
@@ -20,11 +25,21 @@ export interface ColumnOrderDefaultOptions {
 }
 
 export interface ColumnOrderInstance<TData extends RowData> {
-  setColumnOrder: (updater: Updater<ColumnOrderState>) => void
-  resetColumnOrder: (defaultState?: boolean) => void
   _getOrderColumnsFn: () => (
     columns: Column<TData, unknown>[]
   ) => Column<TData, unknown>[]
+  /**
+   * Resets the **columnOrder** state to `initialState.columnOrder`, or `true` can be passed to force a default blank state reset to `[]`.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-ordering#resetcolumnorder)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-ordering)
+   */
+  resetColumnOrder: (defaultState?: boolean) => void
+  /**
+   * Sets or updates the `state.columnOrder` state.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-ordering#setcolumnorder)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-ordering)
+   */
+  setColumnOrder: (updater: Updater<ColumnOrderState>) => void
 }
 
 //