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

package/dist/features/column-visibility/columnVisibilityFeature.utils.d.cts

@@ -7,20 +7,22 @@ import { Table_Internal } from "../../types/Table.cjs";
 import { Cell } from "../../types/Cell.cjs";
 //#region src/features/column-visibility/columnVisibilityFeature.utils.d.ts
 /**
- * Returns the default column visibility state.
+ * Creates the default column visibility state.
  *
- * Feature constructors use this value to initialize the table state or option defaults when no user value is provided.
+ * The feature default is an empty object, where missing column ids are treated
+ * as visible. Reset APIs use this value when `defaultState` is `true`.
  *
  * @example
  * ```ts
- * const initialValue = getDefaultColumnVisibilityState()
+ * const visibility = getDefaultColumnVisibilityState()
  * ```
  */
 declare function getDefaultColumnVisibilityState(): ColumnVisibilityState;
 /**
- * Toggles visibility for a column.
+ * Updates this column's visibility when hiding is allowed.
  *
- * The update is applied through the owning table state slice and respects the feature options for that column.
+ * Passing `visible` stores that value. Omitting it flips the column's current
+ * visibility state. Columns that cannot hide are left unchanged.
  *
  * @example
  * ```ts
@@ -29,86 +31,105 @@ declare function getDefaultColumnVisibilityState(): ColumnVisibilityState;
  */
 declare function column_toggleVisibility<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData>(column: Column_Internal<TFeatures, TData, TValue>, visible?: boolean): void;
 /**
- * Returns is visible for a column.
+ * Checks whether this column is visible.
  *
- * This derives the value from the column definition, table options, and the feature state atoms registered on the table.
+ * Leaf columns read `state.columnVisibility[column.id]`, where missing entries
+ * default to visible. Parent columns are visible when at least one child column
+ * is visible.
  *
  * @example
  * ```ts
- * const value = column_getIsVisible(column)
+ * const visible = column_getIsVisible(column)
  * ```
  */
 declare function column_getIsVisible<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData>(column: Column_Internal<TFeatures, TData, TValue>): boolean;
 /**
- * Returns whether a column can use hide.
+ * Checks whether this column is allowed to be hidden.
  *
- * This combines column options, table options, and any required accessor or feature state for the capability.
+ * Both `columnDef.enableHiding` and table `enableHiding` default to `true`.
  *
  * @example
  * ```ts
- * const value = column_getCanHide(column)
+ * const canHide = column_getCanHide(column)
  * ```
  */
 declare function column_getCanHide<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData>(column: Column_Internal<TFeatures, TData, TValue>): boolean;
 /**
- * Returns an event handler for toggling visibility handler.
+ * Creates a checkbox-style handler that writes this column's visibility.
  *
- * The handler is intended for direct use in column header controls such as buttons or checkboxes.
+ * The handler reads `event.target.checked`, so it is intended for visibility
+ * controls whose checked state means "visible".
  *
  * @example
  * ```ts
- * const value = column_getToggleVisibilityHandler(column)
+ * const onChange = column_getToggleVisibilityHandler(column)
  * ```
  */
 declare function column_getToggleVisibilityHandler<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData>(column: Column_Internal<TFeatures, TData, TValue>): (e: unknown) => void;
 /**
- * Returns visible cells for a row.
+ * Collects the cells from this row whose columns are visible.
  *
- * This is the static implementation behind the matching row instance API and may read row caches or table state atoms.
+ * When column pinning is active, the result is ordered as left-pinned cells,
+ * center cells, then right-pinned cells.
  *
  * @example
  * ```ts
- * const value = row_getVisibleCells(row)
+ * const visibleCells = row_getVisibleCells(row)
  * ```
  */
 declare function row_getVisibleCells<TFeatures extends TableFeatures, TData extends RowData>(row: Row<TFeatures, TData>): Array<Cell<TFeatures, TData, unknown>>;
 /**
- * Returns visible flat columns for the table.
+ * Builds a lookup map of this row's visible cells keyed by column id.
  *
- * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ * Hidden columns are omitted from the map.
  *
  * @example
  * ```ts
- * const value = table_getVisibleFlatColumns(table)
+ * const visibleCellsById = row_getVisibleCellsByColumnId(row)
+ * ```
+ */
+declare function row_getVisibleCellsByColumnId<TFeatures extends TableFeatures, TData extends RowData>(row: Row<TFeatures, TData>): Record<string, Cell<TFeatures, TData, unknown>>;
+/**
+ * Filters the flat column list down to visible columns.
+ *
+ * Parent/group columns are included when `column_getIsVisible` considers them
+ * visible.
+ *
+ * @example
+ * ```ts
+ * const columns = table_getVisibleFlatColumns(table)
  * ```
  */
 declare function table_getVisibleFlatColumns<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): Column<TFeatures, TData, unknown>[];
 /**
- * Returns visible leaf columns for the table.
+ * Filters leaf columns down to those currently visible.
  *
- * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ * This is the column list most row rendering code uses before pinning-specific
+ * partitioning.
  *
  * @example
  * ```ts
- * const value = table_getVisibleLeafColumns(table)
+ * const columns = table_getVisibleLeafColumns(table)
  * ```
  */
 declare function table_getVisibleLeafColumns<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): Column<TFeatures, TData, unknown>[];
 /**
- * Updates the table's column visibility state slice.
+ * Routes a column visibility updater through the table's visibility 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 visibility map or a function of the previous map,
+ * matching the instance `table.setColumnVisibility` behavior.
  *
  * @example
  * ```ts
- * table_setColumnVisibility(table, (old) => old)
+ * table_setColumnVisibility(table, (old) => ({ ...old, age: false }))
  * ```
  */
 declare function table_setColumnVisibility<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, updater: Updater<ColumnVisibilityState>): void;
 /**
- * Resets the table's column visibility state slice.
+ * Resets `columnVisibility` 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.columnVisibility` when
+ * it exists. Passing `true` ignores initial state and resets to `{}`.
  *
  * @example
  * ```ts
@@ -118,9 +139,9 @@ declare function table_setColumnVisibility<TFeatures extends TableFeatures, TDat
  */
 declare function table_resetColumnVisibility<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, defaultState?: boolean): void;
 /**
- * Toggles all columns visible for the table.
+ * Shows or hides every hideable leaf column.
  *
- * This is the table-level convenience API used by UI controls that affect many columns or rows at once.
+ * Columns that cannot hide stay visible when toggling all columns off.
  *
  * @example
  * ```ts
@@ -129,38 +150,40 @@ declare function table_resetColumnVisibility<TFeatures extends TableFeatures, TD
  */
 declare function table_toggleAllColumnsVisible<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, value?: boolean): void;
 /**
- * Returns is all columns visible for the table.
+ * Checks whether every leaf column is currently visible.
  *
- * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ * Non-hideable columns are naturally visible because missing visibility entries
+ * default to `true`.
  *
  * @example
  * ```ts
- * const value = table_getIsAllColumnsVisible(table)
+ * const allVisible = table_getIsAllColumnsVisible(table)
  * ```
  */
 declare function table_getIsAllColumnsVisible<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): boolean;
 /**
- * Returns is some columns visible for the table.
+ * Checks whether at least one leaf column is currently visible.
  *
- * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ * This is useful for tri-state "show all columns" controls.
  *
  * @example
  * ```ts
- * const value = table_getIsSomeColumnsVisible(table)
+ * const someVisible = table_getIsSomeColumnsVisible(table)
  * ```
  */
 declare function table_getIsSomeColumnsVisible<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): boolean;
 /**
- * Returns an event handler for all columns visibility handler.
+ * Creates a checkbox-style handler that shows or hides all columns.
  *
- * The handler calls the matching table toggle API and can be attached directly to checkbox or button UI.
+ * The handler reads `event.target.checked`, so it is intended for controls whose
+ * checked state means "all columns visible".
  *
  * @example
  * ```ts
- * const value = table_getToggleAllColumnsVisibilityHandler(table)
+ * const onChange = table_getToggleAllColumnsVisibilityHandler(table)
  * ```
  */
 declare function table_getToggleAllColumnsVisibilityHandler<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): (e: unknown) => void;
 //#endregion
-export { column_getCanHide, column_getIsVisible, column_getToggleVisibilityHandler, column_toggleVisibility, getDefaultColumnVisibilityState, row_getVisibleCells, table_getIsAllColumnsVisible, table_getIsSomeColumnsVisible, table_getToggleAllColumnsVisibilityHandler, table_getVisibleFlatColumns, table_getVisibleLeafColumns, table_resetColumnVisibility, table_setColumnVisibility, table_toggleAllColumnsVisible };
+export { column_getCanHide, column_getIsVisible, column_getToggleVisibilityHandler, column_toggleVisibility, getDefaultColumnVisibilityState, row_getVisibleCells, row_getVisibleCellsByColumnId, table_getIsAllColumnsVisible, table_getIsSomeColumnsVisible, table_getToggleAllColumnsVisibilityHandler, table_getVisibleFlatColumns, table_getVisibleLeafColumns, table_resetColumnVisibility, table_setColumnVisibility, table_toggleAllColumnsVisible };
 //# sourceMappingURL=columnVisibilityFeature.utils.d.cts.map

package/dist/features/column-visibility/columnVisibilityFeature.utils.d.ts

@@ -7,20 +7,22 @@ import { Table_Internal } from "../../types/Table.js";
 import { Cell } from "../../types/Cell.js";
 //#region src/features/column-visibility/columnVisibilityFeature.utils.d.ts
 /**
- * Returns the default column visibility state.
+ * Creates the default column visibility state.
  *
- * Feature constructors use this value to initialize the table state or option defaults when no user value is provided.
+ * The feature default is an empty object, where missing column ids are treated
+ * as visible. Reset APIs use this value when `defaultState` is `true`.
  *
  * @example
  * ```ts
- * const initialValue = getDefaultColumnVisibilityState()
+ * const visibility = getDefaultColumnVisibilityState()
  * ```
  */
 declare function getDefaultColumnVisibilityState(): ColumnVisibilityState;
 /**
- * Toggles visibility for a column.
+ * Updates this column's visibility when hiding is allowed.
  *
- * The update is applied through the owning table state slice and respects the feature options for that column.
+ * Passing `visible` stores that value. Omitting it flips the column's current
+ * visibility state. Columns that cannot hide are left unchanged.
  *
  * @example
  * ```ts
@@ -29,86 +31,105 @@ declare function getDefaultColumnVisibilityState(): ColumnVisibilityState;
  */
 declare function column_toggleVisibility<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData>(column: Column_Internal<TFeatures, TData, TValue>, visible?: boolean): void;
 /**
- * Returns is visible for a column.
+ * Checks whether this column is visible.
  *
- * This derives the value from the column definition, table options, and the feature state atoms registered on the table.
+ * Leaf columns read `state.columnVisibility[column.id]`, where missing entries
+ * default to visible. Parent columns are visible when at least one child column
+ * is visible.
  *
  * @example
  * ```ts
- * const value = column_getIsVisible(column)
+ * const visible = column_getIsVisible(column)
  * ```
  */
 declare function column_getIsVisible<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData>(column: Column_Internal<TFeatures, TData, TValue>): boolean;
 /**
- * Returns whether a column can use hide.
+ * Checks whether this column is allowed to be hidden.
  *
- * This combines column options, table options, and any required accessor or feature state for the capability.
+ * Both `columnDef.enableHiding` and table `enableHiding` default to `true`.
  *
  * @example
  * ```ts
- * const value = column_getCanHide(column)
+ * const canHide = column_getCanHide(column)
  * ```
  */
 declare function column_getCanHide<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData>(column: Column_Internal<TFeatures, TData, TValue>): boolean;
 /**
- * Returns an event handler for toggling visibility handler.
+ * Creates a checkbox-style handler that writes this column's visibility.
  *
- * The handler is intended for direct use in column header controls such as buttons or checkboxes.
+ * The handler reads `event.target.checked`, so it is intended for visibility
+ * controls whose checked state means "visible".
  *
  * @example
  * ```ts
- * const value = column_getToggleVisibilityHandler(column)
+ * const onChange = column_getToggleVisibilityHandler(column)
  * ```
  */
 declare function column_getToggleVisibilityHandler<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData>(column: Column_Internal<TFeatures, TData, TValue>): (e: unknown) => void;
 /**
- * Returns visible cells for a row.
+ * Collects the cells from this row whose columns are visible.
  *
- * This is the static implementation behind the matching row instance API and may read row caches or table state atoms.
+ * When column pinning is active, the result is ordered as left-pinned cells,
+ * center cells, then right-pinned cells.
  *
  * @example
  * ```ts
- * const value = row_getVisibleCells(row)
+ * const visibleCells = row_getVisibleCells(row)
  * ```
  */
 declare function row_getVisibleCells<TFeatures extends TableFeatures, TData extends RowData>(row: Row<TFeatures, TData>): Array<Cell<TFeatures, TData, unknown>>;
 /**
- * Returns visible flat columns for the table.
+ * Builds a lookup map of this row's visible cells keyed by column id.
  *
- * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ * Hidden columns are omitted from the map.
  *
  * @example
  * ```ts
- * const value = table_getVisibleFlatColumns(table)
+ * const visibleCellsById = row_getVisibleCellsByColumnId(row)
+ * ```
+ */
+declare function row_getVisibleCellsByColumnId<TFeatures extends TableFeatures, TData extends RowData>(row: Row<TFeatures, TData>): Record<string, Cell<TFeatures, TData, unknown>>;
+/**
+ * Filters the flat column list down to visible columns.
+ *
+ * Parent/group columns are included when `column_getIsVisible` considers them
+ * visible.
+ *
+ * @example
+ * ```ts
+ * const columns = table_getVisibleFlatColumns(table)
  * ```
  */
 declare function table_getVisibleFlatColumns<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): Column<TFeatures, TData, unknown>[];
 /**
- * Returns visible leaf columns for the table.
+ * Filters leaf columns down to those currently visible.
  *
- * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ * This is the column list most row rendering code uses before pinning-specific
+ * partitioning.
  *
  * @example
  * ```ts
- * const value = table_getVisibleLeafColumns(table)
+ * const columns = table_getVisibleLeafColumns(table)
  * ```
  */
 declare function table_getVisibleLeafColumns<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): Column<TFeatures, TData, unknown>[];
 /**
- * Updates the table's column visibility state slice.
+ * Routes a column visibility updater through the table's visibility 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 visibility map or a function of the previous map,
+ * matching the instance `table.setColumnVisibility` behavior.
  *
  * @example
  * ```ts
- * table_setColumnVisibility(table, (old) => old)
+ * table_setColumnVisibility(table, (old) => ({ ...old, age: false }))
  * ```
  */
 declare function table_setColumnVisibility<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, updater: Updater<ColumnVisibilityState>): void;
 /**
- * Resets the table's column visibility state slice.
+ * Resets `columnVisibility` 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.columnVisibility` when
+ * it exists. Passing `true` ignores initial state and resets to `{}`.
  *
  * @example
  * ```ts
@@ -118,9 +139,9 @@ declare function table_setColumnVisibility<TFeatures extends TableFeatures, TDat
  */
 declare function table_resetColumnVisibility<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, defaultState?: boolean): void;
 /**
- * Toggles all columns visible for the table.
+ * Shows or hides every hideable leaf column.
  *
- * This is the table-level convenience API used by UI controls that affect many columns or rows at once.
+ * Columns that cannot hide stay visible when toggling all columns off.
  *
  * @example
  * ```ts
@@ -129,38 +150,40 @@ declare function table_resetColumnVisibility<TFeatures extends TableFeatures, TD
  */
 declare function table_toggleAllColumnsVisible<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, value?: boolean): void;
 /**
- * Returns is all columns visible for the table.
+ * Checks whether every leaf column is currently visible.
  *
- * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ * Non-hideable columns are naturally visible because missing visibility entries
+ * default to `true`.
  *
  * @example
  * ```ts
- * const value = table_getIsAllColumnsVisible(table)
+ * const allVisible = table_getIsAllColumnsVisible(table)
  * ```
  */
 declare function table_getIsAllColumnsVisible<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): boolean;
 /**
- * Returns is some columns visible for the table.
+ * Checks whether at least one leaf column is currently visible.
  *
- * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ * This is useful for tri-state "show all columns" controls.
  *
  * @example
  * ```ts
- * const value = table_getIsSomeColumnsVisible(table)
+ * const someVisible = table_getIsSomeColumnsVisible(table)
  * ```
  */
 declare function table_getIsSomeColumnsVisible<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): boolean;
 /**
- * Returns an event handler for all columns visibility handler.
+ * Creates a checkbox-style handler that shows or hides all columns.
  *
- * The handler calls the matching table toggle API and can be attached directly to checkbox or button UI.
+ * The handler reads `event.target.checked`, so it is intended for controls whose
+ * checked state means "all columns visible".
  *
  * @example
  * ```ts
- * const value = table_getToggleAllColumnsVisibilityHandler(table)
+ * const onChange = table_getToggleAllColumnsVisibilityHandler(table)
  * ```
  */
 declare function table_getToggleAllColumnsVisibilityHandler<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): (e: unknown) => void;
 //#endregion
-export { column_getCanHide, column_getIsVisible, column_getToggleVisibilityHandler, column_toggleVisibility, getDefaultColumnVisibilityState, row_getVisibleCells, table_getIsAllColumnsVisible, table_getIsSomeColumnsVisible, table_getToggleAllColumnsVisibilityHandler, table_getVisibleFlatColumns, table_getVisibleLeafColumns, table_resetColumnVisibility, table_setColumnVisibility, table_toggleAllColumnsVisible };
+export { column_getCanHide, column_getIsVisible, column_getToggleVisibilityHandler, column_toggleVisibility, getDefaultColumnVisibilityState, row_getVisibleCells, row_getVisibleCellsByColumnId, table_getIsAllColumnsVisible, table_getIsSomeColumnsVisible, table_getToggleAllColumnsVisibilityHandler, table_getVisibleFlatColumns, table_getVisibleLeafColumns, table_resetColumnVisibility, table_setColumnVisibility, table_toggleAllColumnsVisible };
 //# sourceMappingURL=columnVisibilityFeature.utils.d.ts.map