@tanstack/table-core 9.0.0-alpha.47 → 9.0.0-alpha.48

package/src/features/column-pinning/columnPinningFeature.utils.ts

@@ -22,13 +22,14 @@ import type {
 // State
 
 /**
- * Returns the default column pinning state.
+ * Creates the default column pinning state.
  *
- * Feature constructors use this value to initialize the table state or option defaults when no user value is provided.
+ * Both pinning regions start empty. Reset APIs use this value when
+ * `defaultState` is `true`.
  *
  * @example
  * ```ts
- * const initialValue = getDefaultColumnPinningState()
+ * const pinning = getDefaultColumnPinningState()
  * ```
  */
 export function getDefaultColumnPinningState(): ColumnPinningState {
@@ -41,9 +42,11 @@ export function getDefaultColumnPinningState(): ColumnPinningState {
 // Column APIs
 
 /**
- * Pin. for a column.
+ * Moves this column's leaf column ids into a pinning region.
  *
- * This is the static implementation behind the matching column instance API.
+ * Pinning a group column pins all of its leaves. The leaf ids are first removed
+ * from both regions, then appended to the requested `'left'` or `'right'`
+ * region. Passing `false` unpins them back to the center.
  *
  * @example
  * ```ts
@@ -92,13 +95,14 @@ export function column_pin<
 }
 
 /**
- * Returns whether a column can use pin.
+ * Checks whether this column or any of its leaf columns can be pinned.
  *
- * This combines column options, table options, and any required accessor or feature state for the capability.
+ * Column-level `enablePinning` and table `enableColumnPinning` both default to
+ * `true`; at least one leaf column must allow pinning.
  *
  * @example
  * ```ts
- * const value = column_getCanPin(column)
+ * const canPin = column_getCanPin(column)
  * ```
  */
 export function column_getCanPin<
@@ -118,13 +122,14 @@ export function column_getCanPin<
 }
 
 /**
- * Returns is pinned for a column.
+ * Reads this column's current pinning region.
  *
- * This derives the value from the column definition, table options, and the feature state atoms registered on the table.
+ * Group columns report `'left'` or `'right'` when any leaf column is pinned in
+ * that region. Unpinned columns return `false`.
  *
  * @example
  * ```ts
- * const value = column_getIsPinned(column)
+ * const position = column_getIsPinned(column)
  * ```
  */
 export function column_getIsPinned<
@@ -146,13 +151,14 @@ export function column_getIsPinned<
 }
 
 /**
- * Returns pinned index for a column.
+ * Finds this column's index within its pinned region.
  *
- * This derives the value from the column definition, table options, and the feature state atoms registered on the table.
+ * Unpinned columns return `0`; pinned columns return their position in
+ * `state.columnPinning.left` or `state.columnPinning.right`.
  *
  * @example
  * ```ts
- * const value = column_getPinnedIndex(column)
+ * const index = column_getPinnedIndex(column)
  * ```
  */
 export function column_getPinnedIndex<
@@ -171,13 +177,13 @@ export function column_getPinnedIndex<
 // Row APIs
 
 /**
- * Returns center visible cells for a row.
+ * Collects visible cells whose columns are not pinned left or right.
  *
- * This is the static implementation behind the matching row instance API and may read row caches or table state atoms.
+ * The result preserves the row's visible-cell order for center columns.
  *
  * @example
  * ```ts
- * const value = row_getCenterVisibleCells(row)
+ * const centerCells = row_getCenterVisibleCells(row)
  * ```
  */
 export function row_getCenterVisibleCells<
@@ -196,13 +202,14 @@ export function row_getCenterVisibleCells<
 }
 
 /**
- * Returns left visible cells for a row.
+ * Collects visible cells for columns pinned to the left region.
  *
- * This is the static implementation behind the matching row instance API and may read row caches or table state atoms.
+ * Cells are returned in `state.columnPinning.left` order and are marked with
+ * `cell.position = 'left'`.
  *
  * @example
  * ```ts
- * const value = row_getLeftVisibleCells(row)
+ * const leftCells = row_getLeftVisibleCells(row)
  * ```
  */
 export function row_getLeftVisibleCells<
@@ -231,13 +238,14 @@ export function row_getLeftVisibleCells<
 }
 
 /**
- * Returns right visible cells for a row.
+ * Collects visible cells for columns pinned to the right region.
  *
- * This is the static implementation behind the matching row instance API and may read row caches or table state atoms.
+ * Cells are returned in `state.columnPinning.right` order and are marked with
+ * `cell.position = 'right'`.
  *
  * @example
  * ```ts
- * const value = row_getRightVisibleCells(row)
+ * const rightCells = row_getRightVisibleCells(row)
  * ```
  */
 export function row_getRightVisibleCells<
@@ -268,13 +276,14 @@ export function row_getRightVisibleCells<
 // Table APIs
 
 /**
- * Updates the table's column pinning state slice.
+ * Routes a column pinning updater through the table's pinning change handler.
  *
- * The updater follows TanStack Table updater semantics and is routed through the corresponding `on*Change` option or backing atom.
+ * The updater may be a next `{ left, right }` state or a function of the
+ * previous state, matching the instance `table.setColumnPinning` behavior.
  *
  * @example
  * ```ts
- * table_setColumnPinning(table, (old) => old)
+ * table_setColumnPinning(table, (old) => ({ ...old, left: ['select'] }))
  * ```
  */
 export function table_setColumnPinning<
@@ -288,9 +297,11 @@ export function table_setColumnPinning<
 }
 
 /**
- * Resets the table's column pinning state slice.
+ * Resets `columnPinning` to the configured initial state or feature default.
  *
- * By default the reset uses `table.initialState`; when supported, a blank/default reset bypasses the saved initial value.
+ * With no argument, the reset clones `table.initialState.columnPinning` when it
+ * exists. Passing `true` ignores initial state and resets to empty left/right
+ * arrays.
  *
  * @example
  * ```ts
@@ -313,13 +324,14 @@ export function table_resetColumnPinning<
 }
 
 /**
- * Returns is some columns pinned for the table.
+ * Checks whether any columns are pinned.
  *
- * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ * Omit `position` to check both sides, or pass `'left'`/`'right'` to inspect a
+ * single pinning region.
  *
  * @example
  * ```ts
- * const value = table_getIsSomeColumnsPinned(table)
+ * const hasPinnedColumns = table_getIsSomeColumnsPinned(table)
  * ```
  */
 export function table_getIsSomeColumnsPinned<
@@ -337,13 +349,14 @@ export function table_getIsSomeColumnsPinned<
 // header groups
 
 /**
- * Returns left header groups for the table.
+ * Builds header groups for visible columns pinned to the left region.
  *
- * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ * The leaf columns are read in `state.columnPinning.left` order and then passed
+ * through the same header-group builder as the unpinned table.
  *
  * @example
  * ```ts
- * const value = table_getLeftHeaderGroups(table)
+ * const headerGroups = table_getLeftHeaderGroups(table)
  * ```
  */
 export function table_getLeftHeaderGroups<
@@ -374,13 +387,14 @@ export function table_getLeftHeaderGroups<
 }
 
 /**
- * Returns right header groups for the table.
+ * Builds header groups for visible columns pinned to the right region.
  *
- * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ * The leaf columns are read in `state.columnPinning.right` order and then
+ * passed through the same header-group builder as the unpinned table.
  *
  * @example
  * ```ts
- * const value = table_getRightHeaderGroups(table)
+ * const headerGroups = table_getRightHeaderGroups(table)
  * ```
  */
 export function table_getRightHeaderGroups<
@@ -411,13 +425,14 @@ export function table_getRightHeaderGroups<
 }
 
 /**
- * Returns center header groups for the table.
+ * Builds header groups for visible columns that are not pinned.
  *
- * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ * Left- and right-pinned column ids are removed from the visible leaf column
+ * list before header groups are built for the center region.
  *
  * @example
  * ```ts
- * const value = table_getCenterHeaderGroups(table)
+ * const headerGroups = table_getCenterHeaderGroups(table)
  * ```
  */
 export function table_getCenterHeaderGroups<
@@ -445,13 +460,13 @@ export function table_getCenterHeaderGroups<
 // footer groups
 
 /**
- * Returns left footer groups for the table.
+ * Builds footer groups for the left pinned region.
  *
- * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ * Footer groups reuse the left header groups in reverse order.
  *
  * @example
  * ```ts
- * const value = table_getLeftFooterGroups(table)
+ * const footerGroups = table_getLeftFooterGroups(table)
  * ```
  */
 export function table_getLeftFooterGroups<
@@ -467,13 +482,13 @@ export function table_getLeftFooterGroups<
 }
 
 /**
- * Returns right footer groups for the table.
+ * Builds footer groups for the right pinned region.
  *
- * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ * Footer groups reuse the right header groups in reverse order.
  *
  * @example
  * ```ts
- * const value = table_getRightFooterGroups(table)
+ * const footerGroups = table_getRightFooterGroups(table)
  * ```
  */
 export function table_getRightFooterGroups<
@@ -489,13 +504,13 @@ export function table_getRightFooterGroups<
 }
 
 /**
- * Returns center footer groups for the table.
+ * Builds footer groups for the center, unpinned region.
  *
- * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ * Footer groups reuse the center header groups in reverse order.
  *
  * @example
  * ```ts
- * const value = table_getCenterFooterGroups(table)
+ * const footerGroups = table_getCenterFooterGroups(table)
  * ```
  */
 export function table_getCenterFooterGroups<
@@ -513,13 +528,13 @@ export function table_getCenterFooterGroups<
 // flat headers
 
 /**
- * Returns left flat headers for the table.
+ * Flattens every header from the left pinned header groups.
  *
- * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ * Parent headers and placeholder headers are included.
  *
  * @example
  * ```ts
- * const value = table_getLeftFlatHeaders(table)
+ * const headers = table_getLeftFlatHeaders(table)
  * ```
  */
 export function table_getLeftFlatHeaders<
@@ -542,13 +557,13 @@ export function table_getLeftFlatHeaders<
 }
 
 /**
- * Returns right flat headers for the table.
+ * Flattens every header from the right pinned header groups.
  *
- * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ * Parent headers and placeholder headers are included.
  *
  * @example
  * ```ts
- * const value = table_getRightFlatHeaders(table)
+ * const headers = table_getRightFlatHeaders(table)
  * ```
  */
 export function table_getRightFlatHeaders<
@@ -571,13 +586,13 @@ export function table_getRightFlatHeaders<
 }
 
 /**
- * Returns center flat headers for the table.
+ * Flattens every header from the center header groups.
  *
- * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ * Parent headers and placeholder headers are included.
  *
  * @example
  * ```ts
- * const value = table_getCenterFlatHeaders(table)
+ * const headers = table_getCenterFlatHeaders(table)
  * ```
  */
 export function table_getCenterFlatHeaders<
@@ -602,13 +617,13 @@ export function table_getCenterFlatHeaders<
 // leaf headers
 
 /**
- * Returns left leaf headers for the table.
+ * Collects leaf headers for the left pinned region.
  *
- * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ * Parent headers are filtered out from the left flat header list.
  *
  * @example
  * ```ts
- * const value = table_getLeftLeafHeaders(table)
+ * const headers = table_getLeftLeafHeaders(table)
  * ```
  */
 export function table_getLeftLeafHeaders<
@@ -623,13 +638,13 @@ export function table_getLeftLeafHeaders<
 }
 
 /**
- * Returns right leaf headers for the table.
+ * Collects leaf headers for the right pinned region.
  *
- * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ * Parent headers are filtered out from the right flat header list.
  *
  * @example
  * ```ts
- * const value = table_getRightLeafHeaders(table)
+ * const headers = table_getRightLeafHeaders(table)
  * ```
  */
 export function table_getRightLeafHeaders<
@@ -644,13 +659,13 @@ export function table_getRightLeafHeaders<
 }
 
 /**
- * Returns center leaf headers for the table.
+ * Collects leaf headers for the center, unpinned region.
  *
- * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ * Parent headers are filtered out from the center flat header list.
  *
  * @example
  * ```ts
- * const value = table_getCenterLeafHeaders(table)
+ * const headers = table_getCenterLeafHeaders(table)
  * ```
  */
 export function table_getCenterLeafHeaders<
@@ -667,13 +682,14 @@ export function table_getCenterLeafHeaders<
 // leaf columns
 
 /**
- * Returns left leaf columns for the table.
+ * Resolves leaf columns pinned to the left region.
  *
- * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ * The result follows `state.columnPinning.left` order and skips stale ids that
+ * no longer correspond to a leaf column.
  *
  * @example
  * ```ts
- * const value = table_getLeftLeafColumns(table)
+ * const columns = table_getLeftLeafColumns(table)
  * ```
  */
 export function table_getLeftLeafColumns<
@@ -692,13 +708,14 @@ export function table_getLeftLeafColumns<
 }
 
 /**
- * Returns right leaf columns for the table.
+ * Resolves leaf columns pinned to the right region.
  *
- * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ * The result follows `state.columnPinning.right` order and skips stale ids that
+ * no longer correspond to a leaf column.
  *
  * @example
  * ```ts
- * const value = table_getRightLeafColumns(table)
+ * const columns = table_getRightLeafColumns(table)
  * ```
  */
 export function table_getRightLeafColumns<
@@ -717,13 +734,13 @@ export function table_getRightLeafColumns<
 }
 
 /**
- * Returns center leaf columns for the table.
+ * Resolves leaf columns that are not pinned to either side.
  *
- * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ * Left- and right-pinned ids are removed from `table.getAllLeafColumns()`.
  *
  * @example
  * ```ts
- * const value = table_getCenterLeafColumns(table)
+ * const columns = table_getCenterLeafColumns(table)
  * ```
  */
 export function table_getCenterLeafColumns<
@@ -737,13 +754,14 @@ export function table_getCenterLeafColumns<
 }
 
 /**
- * Returns pinned leaf columns for the table.
+ * Resolves leaf columns for a requested pinning region.
  *
- * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ * Pass `'left'`, `'center'`, or `'right'` for a partition, or pass `false` to
+ * read all leaf columns without partitioning.
  *
  * @example
  * ```ts
- * const value = table_getPinnedLeafColumns(table)
+ * const columns = table_getPinnedLeafColumns(table, 'center')
  * ```
  */
 export function table_getPinnedLeafColumns<
@@ -777,13 +795,13 @@ export function table_getPinnedLeafColumns<
 // visible leaf columns
 
 /**
- * Returns left visible leaf columns for the table.
+ * Resolves visible leaf columns pinned to the left region.
  *
- * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ * Hidden pinned columns are filtered out after the left pin order is applied.
  *
  * @example
  * ```ts
- * const value = table_getLeftVisibleLeafColumns(table)
+ * const columns = table_getLeftVisibleLeafColumns(table)
  * ```
  */
 export function table_getLeftVisibleLeafColumns<
@@ -800,13 +818,13 @@ export function table_getLeftVisibleLeafColumns<
 }
 
 /**
- * Returns right visible leaf columns for the table.
+ * Resolves visible leaf columns pinned to the right region.
  *
- * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ * Hidden pinned columns are filtered out after the right pin order is applied.
  *
  * @example
  * ```ts
- * const value = table_getRightVisibleLeafColumns(table)
+ * const columns = table_getRightVisibleLeafColumns(table)
  * ```
  */
 export function table_getRightVisibleLeafColumns<
@@ -823,13 +841,14 @@ export function table_getRightVisibleLeafColumns<
 }
 
 /**
- * Returns center visible leaf columns for the table.
+ * Resolves visible leaf columns that are not pinned.
  *
- * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ * This is the center partition used by layouts that render pinned columns
+ * separately from the scrollable middle region.
  *
  * @example
  * ```ts
- * const value = table_getCenterVisibleLeafColumns(table)
+ * const columns = table_getCenterVisibleLeafColumns(table)
  * ```
  */
 export function table_getCenterVisibleLeafColumns<
@@ -846,13 +865,14 @@ export function table_getCenterVisibleLeafColumns<
 }
 
 /**
- * Returns pinned visible leaf columns for the table.
+ * Resolves visible leaf columns for a requested pinning region.
  *
- * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ * Omit `position` to get all visible leaf columns, or pass `'left'`, `'center'`,
+ * or `'right'` to get one partition.
  *
  * @example
  * ```ts
- * const value = table_getPinnedVisibleLeafColumns(table)
+ * const columns = table_getPinnedVisibleLeafColumns(table, 'left')
  * ```
  */
 export function table_getPinnedVisibleLeafColumns<

package/src/features/column-resizing/columnResizingFeature.types.ts

@@ -47,12 +47,13 @@ export type ColumnResizingDefaultOptions = Pick<
 
 export interface Table_ColumnResizing {
   /**
-   * Resets transient resize interaction state to `initialState.columnResizing`.
-   * Pass `true` to reset to the feature's default blank resize state instead.
+   * Resets `columnResizing` to `initialState.columnResizing`.
+   *
+   * Pass `true` to ignore initial state and reset to the no-drag default state.
    */
   resetHeaderSizeInfo: (defaultState?: boolean) => void
   /**
-   * Sets the transient resize interaction state using a value or updater.
+   * Updates transient resize interaction state with a next state or updater function.
    *
    * The lowercase `c` in this API name matches the current generated v9 table
    * API for the `columnResizing` state slice.
@@ -69,21 +70,20 @@ export interface ColumnDef_ColumnResizing {
 
 export interface Column_ColumnResizing {
   /**
-   * Returns `true` if the column can be resized.
+   * Checks whether this column can start a resize interaction.
    */
   getCanResize: () => boolean
   /**
-   * Returns `true` if the column is currently being resized.
+   * Checks whether this column is the active resize target.
    */
   getIsResizing: () => boolean
 }
 
 export interface Header_ColumnResizing {
   /**
-   * 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.
+   * Creates the `onMouseDown`/`onTouchStart` handler for a resize handle.
+   *
+   * Dragging and release listeners are installed and cleaned up automatically.
    */
   getResizeHandler: (context?: Document) => (event: unknown) => void
 }