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

package/dist/features/column-pinning/columnPinningFeature.utils.d.ts

@@ -9,20 +9,23 @@ import { Table_Internal } from "../../types/Table.js";
 import { Cell } from "../../types/Cell.js";
 //#region src/features/column-pinning/columnPinningFeature.utils.d.ts
 /**
- * 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()
  * ```
  */
 declare function getDefaultColumnPinningState(): ColumnPinningState;
 /**
- * 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
@@ -31,86 +34,94 @@ declare function getDefaultColumnPinningState(): ColumnPinningState;
  */
 declare function column_pin<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData>(column: Column_Internal<TFeatures, TData, TValue>, position: ColumnPinningPosition): void;
 /**
- * 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)
  * ```
  */
 declare function column_getCanPin<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData>(column: Column_Internal<TFeatures, TData, TValue>): boolean;
 /**
- * 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)
  * ```
  */
 declare function column_getIsPinned<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData>(column: Column_Internal<TFeatures, TData, TValue>): ColumnPinningPosition | false;
 /**
- * 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)
  * ```
  */
 declare function column_getPinnedIndex<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData>(column: Column_Internal<TFeatures, TData, TValue>): number;
 /**
- * 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)
  * ```
  */
 declare function row_getCenterVisibleCells<TFeatures extends TableFeatures, TData extends RowData>(row: Row<TFeatures, TData>): any[];
 /**
- * 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)
  * ```
  */
 declare function row_getLeftVisibleCells<TFeatures extends TableFeatures, TData extends RowData>(row: Row<TFeatures, TData>): Array<Cell<TFeatures, TData, unknown>>;
 /**
- * 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)
  * ```
  */
 declare function row_getRightVisibleCells<TFeatures extends TableFeatures, TData extends RowData>(row: Row<TFeatures, TData>): Cell<TFeatures, TData, unknown>[];
 /**
- * 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'] }))
  * ```
  */
 declare function table_setColumnPinning<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, updater: Updater<ColumnPinningState>): void;
 /**
- * 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
@@ -120,233 +131,242 @@ declare function table_setColumnPinning<TFeatures extends TableFeatures, TData e
  */
 declare function table_resetColumnPinning<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, defaultState?: boolean): void;
 /**
- * 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)
  * ```
  */
 declare function table_getIsSomeColumnsPinned<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, position?: ColumnPinningPosition): boolean;
 /**
- * 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)
  * ```
  */
 declare function table_getLeftHeaderGroups<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): HeaderGroup<TFeatures, TData>[];
 /**
- * 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)
  * ```
  */
 declare function table_getRightHeaderGroups<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): HeaderGroup<TFeatures, TData>[];
 /**
- * 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)
  * ```
  */
 declare function table_getCenterHeaderGroups<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): Array<HeaderGroup<TFeatures, TData>>;
 /**
- * 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)
  * ```
  */
 declare function table_getLeftFooterGroups<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): any[];
 /**
- * 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)
  * ```
  */
 declare function table_getRightFooterGroups<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): any[];
 /**
- * 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)
  * ```
  */
 declare function table_getCenterFooterGroups<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): any[];
 /**
- * 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)
  * ```
  */
 declare function table_getLeftFlatHeaders<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): Header<TFeatures, TData, unknown>[];
 /**
- * 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)
  * ```
  */
 declare function table_getRightFlatHeaders<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): Header<TFeatures, TData, unknown>[];
 /**
- * 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)
  * ```
  */
 declare function table_getCenterFlatHeaders<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): Header<TFeatures, TData, unknown>[];
 /**
- * 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)
  * ```
  */
 declare function table_getLeftLeafHeaders<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): any[];
 /**
- * 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)
  * ```
  */
 declare function table_getRightLeafHeaders<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): any[];
 /**
- * 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)
  * ```
  */
 declare function table_getCenterLeafHeaders<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): any[];
 /**
- * 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)
  * ```
  */
 declare function table_getLeftLeafColumns<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): Column_Internal<TFeatures, TData, unknown>[];
 /**
- * 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)
  * ```
  */
 declare function table_getRightLeafColumns<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): Column_Internal<TFeatures, TData, unknown>[];
 /**
- * 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)
  * ```
  */
 declare function table_getCenterLeafColumns<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): Column<TFeatures, TData, unknown>[];
 /**
- * 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')
  * ```
  */
 declare function table_getPinnedLeafColumns<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, position: ColumnPinningPosition | 'center'): any[];
 /**
- * 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)
  * ```
  */
 declare function table_getLeftVisibleLeafColumns<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): any[];
 /**
- * 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)
  * ```
  */
 declare function table_getRightVisibleLeafColumns<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): any[];
 /**
- * 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)
  * ```
  */
 declare function table_getCenterVisibleLeafColumns<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): any[];
 /**
- * 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')
  * ```
  */
 declare function table_getPinnedVisibleLeafColumns<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, position?: ColumnPinningPosition | 'center'): any[];