@tanstack/table-core 8.10.1 → 8.10.2

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tanstack/table-core",
   "author": "Tanner Linsley",
-  "version": "8.10.1",
+  "version": "8.10.2",
   "description": "Headless UI for building powerful tables & datagrids for TS/JS.",
   "license": "MIT",
   "homepage": "https://github.com/tanstack/table#readme",

package/src/columnHelper.ts

@@ -56,7 +56,7 @@ export type ColumnHelper<TData extends RowData> = {
       ? TReturn
       : TAccessor extends DeepKeys<TData>
       ? DeepValue<TData, TAccessor>
-      : never
+      : never,
   >(
     accessor: TAccessor,
     column: TAccessor extends AccessorFn<TData>
@@ -68,7 +68,7 @@ export type ColumnHelper<TData extends RowData> = {
 }
 
 export function createColumnHelper<
-  TData extends RowData
+  TData extends RowData,
 >(): ColumnHelper<TData> {
   return {
     accessor: (accessor, column) => {

package/src/core/cell.ts

@@ -2,21 +2,51 @@ import { RowData, Cell, Column, Row, Table } from '../types'
 import { Getter, memo } from '../utils'
 
 export interface CellContext<TData extends RowData, TValue> {
-  table: Table<TData>
-  column: Column<TData, TValue>
-  row: Row<TData>
   cell: Cell<TData, TValue>
+  column: Column<TData, TValue>
   getValue: Getter<TValue>
   renderValue: Getter<TValue | null>
+  row: Row<TData>
+  table: Table<TData>
 }
 
 export interface CoreCell<TData extends RowData, TValue> {
-  id: string
+  /**
+   * The associated Column object for the cell.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/cell#column)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/cells)
+   */
+  column: Column<TData, TValue>
+  /**
+   * Returns the rendering context (or props) for cell-based components like cells and aggregated cells. Use these props with your framework's `flexRender` utility to render these using the template of your choice:
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/cell#getcontext)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/cells)
+   */
+  getContext: () => CellContext<TData, TValue>
+  /**
+   * Returns the value for the cell, accessed via the associated column's accessor key or accessor function.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/cell#getvalue)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/cells)
+   */
   getValue: CellContext<TData, TValue>['getValue']
+  /**
+   * The unique ID for the cell across the entire table.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/cell#id)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/cells)
+   */
+  id: string
+  /**
+   * Renders the value for a cell the same as `getValue`, but will return the `renderFallbackValue` if no value is found.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/cell#rendervalue)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/cells)
+   */
   renderValue: CellContext<TData, TValue>['renderValue']
+  /**
+   * The associated Row object for the cell.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/cell#row)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/cells)
+   */
   row: Row<TData>
-  column: Column<TData, TValue>
-  getContext: () => CellContext<TData, TValue>
 }
 
 export function createCell<TData extends RowData, TValue>(

package/src/core/column.ts

@@ -9,14 +9,57 @@ import {
 import { memo } from '../utils'
 
 export interface CoreColumn<TData extends RowData, TValue> {
-  id: string
-  depth: number
+  /**
+   * The resolved accessor function to use when extracting the value for the column from each row. Will only be defined if the column def has a valid accessor key or function defined.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/column#accessorfn)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-defs)
+   */
   accessorFn?: AccessorFn<TData, TValue>
+  /**
+   * The original column def used to create the column.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/column#columndef)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-defs)
+   */
   columnDef: ColumnDef<TData, TValue>
+  /**
+   * The child column (if the column is a group column). Will be an empty array if the column is not a group column.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/column#columns)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-defs)
+   */
   columns: Column<TData, TValue>[]
-  parent?: Column<TData, TValue>
+  /**
+   * The depth of the column (if grouped) relative to the root column def array.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/column#depth)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-defs)
+   */
+  depth: number
+  /**
+   * Returns the flattened array of this column and all child/grand-child columns for this column.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/column#getflatcolumns)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-defs)
+   */
   getFlatColumns: () => Column<TData, TValue>[]
+  /**
+   * Returns an array of all leaf-node columns for this column. If a column has no children, it is considered the only leaf-node column.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/column#getleafcolumns)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-defs)
+   */
   getLeafColumns: () => Column<TData, TValue>[]
+  /**
+   * The resolved unique identifier for the column resolved in this priority:
+      - A manual `id` property from the column def
+      - The accessor key from the column def
+      - The header string from the column def
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/column#id)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-defs)
+   */
+  id: string
+  /**
+   * The parent column for this column. Will be undefined if this is a root column.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/column#parent)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-defs)
+   */
+  parent?: Column<TData, TValue>
 }
 
 export function createColumn<TData extends RowData, TValue>(

package/src/core/headers.ts

@@ -3,51 +3,200 @@ import { memo } from '../utils'
 import { TableFeature } from './table'
 
 export interface CoreHeaderGroup<TData extends RowData> {
-  id: string
   depth: number
   headers: Header<TData, unknown>[]
+  id: string
 }
 
 export interface HeaderContext<TData, TValue> {
-  table: Table<TData>
-  header: Header<TData, TValue>
+  /**
+   * An instance of a column.
+   */
   column: Column<TData, TValue>
+  /**
+   * An instance of a header.
+   */
+  header: Header<TData, TValue>
+  /**
+   * The table instance.
+   */
+  table: Table<TData>
 }
 
 export interface CoreHeader<TData extends RowData, TValue> {
-  id: string
-  index: number
-  depth: number
-  column: Column<TData, TValue>
-  headerGroup: HeaderGroup<TData>
-  subHeaders: Header<TData, TValue>[]
+  /**
+   * The col-span for the header.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/header#colspan)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/headers)
+   */
   colSpan: number
-  rowSpan: number
+  /**
+   * The header's associated column object.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/header#column)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/headers)
+   */
+  column: Column<TData, TValue>
+  /**
+   * The depth of the header, zero-indexed based.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/header#depth)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/headers)
+   */
+  depth: number
+  /**
+   * Returns the rendering context (or props) for column-based components like headers, footers and filters.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/header#getcontext)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/headers)
+   */
+  getContext: () => HeaderContext<TData, TValue>
+  /**
+   * Returns the leaf headers hierarchically nested under this header.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/header#getleafheaders)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/headers)
+   */
   getLeafHeaders: () => Header<TData, unknown>[]
+  /**
+   * The header's associated header group object.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/header#headergroup)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/headers)
+   */
+  headerGroup: HeaderGroup<TData>
+  /**
+   * The unique identifier for the header.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/header#id)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/headers)
+   */
+  id: string
+  /**
+   * The index for the header within the header group.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/header#index)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/headers)
+   */
+  index: number
+  /**
+   * A boolean denoting if the header is a placeholder header.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/header#isplaceholder)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/headers)
+   */
   isPlaceholder: boolean
+  /**
+   * If the header is a placeholder header, this will be a unique header ID that does not conflict with any other headers across the table.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/header#placeholderid)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/headers)
+   */
   placeholderId?: string
-  getContext: () => HeaderContext<TData, TValue>
+  /**
+   * The row-span for the header.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/header#rowspan)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/headers)
+   */
+  rowSpan: number
+  /**
+   * The header's hierarchical sub/child headers. Will be empty if the header's associated column is a leaf-column.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/header#subheaders)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/headers)
+   */
+  subHeaders: Header<TData, TValue>[]
 }
 
 export interface HeadersInstance<TData extends RowData> {
+  /**
+   * Returns all header groups for the table.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/headers#getheadergroups)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/headers)
+   */
   getHeaderGroups: () => HeaderGroup<TData>[]
+  /**
+   * If pinning, returns the header groups for the left pinned columns.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/headers#getleftheadergroups)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/headers)
+   */
   getLeftHeaderGroups: () => HeaderGroup<TData>[]
+  /**
+   * If pinning, returns the header groups for columns that are not pinned.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/headers#getcenterheadergroups)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/headers)
+   */
   getCenterHeaderGroups: () => HeaderGroup<TData>[]
+  /**
+   * If pinning, returns the header groups for the right pinned columns.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/headers#getrightheadergroups)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/headers)
+   */
   getRightHeaderGroups: () => HeaderGroup<TData>[]
 
+  /**
+   * Returns the footer groups for the table.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/headers#getfootergroups)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/headers)
+   */
   getFooterGroups: () => HeaderGroup<TData>[]
+  /**
+   * If pinning, returns the footer groups for the left pinned columns.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/headers#getleftfootergroups)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/headers)
+   */
   getLeftFooterGroups: () => HeaderGroup<TData>[]
+  /**
+   * If pinning, returns the footer groups for columns that are not pinned.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/headers#getcenterfootergroups)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/headers)
+   */
   getCenterFooterGroups: () => HeaderGroup<TData>[]
+  /**
+   * If pinning, returns the footer groups for the right pinned columns.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/headers#getrightfootergroups)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/headers)
+   */
   getRightFooterGroups: () => HeaderGroup<TData>[]
 
+  /**
+   * Returns headers for all columns in the table, including parent headers.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/headers#getflatheaders)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/headers)
+   */
   getFlatHeaders: () => Header<TData, unknown>[]
+  /**
+   * If pinning, returns headers for all left pinned columns in the table, including parent headers.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/headers#getleftflatheaders)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/headers)
+   */
   getLeftFlatHeaders: () => Header<TData, unknown>[]
+  /**
+   * If pinning, returns headers for all columns that are not pinned, including parent headers.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/headers#getcenterflatheaders)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/headers)
+   */
   getCenterFlatHeaders: () => Header<TData, unknown>[]
+  /**
+   * If pinning, returns headers for all right pinned columns in the table, including parent headers.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/headers#getrightflatheaders)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/headers)
+   */
   getRightFlatHeaders: () => Header<TData, unknown>[]
 
+  /**
+   * Returns headers for all leaf columns in the table, (not including parent headers).
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/headers#getleafheaders)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/headers)
+   */
   getLeafHeaders: () => Header<TData, unknown>[]
+  /**
+   * If pinning, returns headers for all left pinned leaf columns in the table, (not including parent headers).
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/headers#getleftleafheaders)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/headers)
+   */
   getLeftLeafHeaders: () => Header<TData, unknown>[]
+  /**
+   * If pinning, returns headers for all columns that are not pinned, (not including parent headers).
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/headers#getcenterleafheaders)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/headers)
+   */
   getCenterLeafHeaders: () => Header<TData, unknown>[]
+  /**
+   * If pinning, returns headers for all right pinned leaf columns in the table, (not including parent headers).
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/headers#getrightleafheaders)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/headers)
+   */
   getRightLeafHeaders: () => Header<TData, unknown>[]
 }
 

package/src/core/row.ts

@@ -3,23 +3,93 @@ import { flattenBy, memo } from '../utils'
 import { createCell } from './cell'
 
 export interface CoreRow<TData extends RowData> {
+  _getAllCellsByColumnId: () => Record<string, Cell<TData, unknown>>
+  _uniqueValuesCache: Record<string, unknown>
+  _valuesCache: Record<string, unknown>
+  /**
+   * The depth of the row (if nested or grouped) relative to the root row array.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/row#depth)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/rows)
+   */
+  depth: number
+  /**
+   * Returns all of the cells for the row.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/row#getallcells)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/rows)
+   */
+  getAllCells: () => Cell<TData, unknown>[]
+  /**
+   * Returns the leaf rows for the row, not including any parent rows.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/row#getleafrows)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/rows)
+   */
+  getLeafRows: () => Row<TData>[]
+  /**
+   * Returns the parent row for the row, if it exists.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/row#getparentrow)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/rows)
+   */
+  getParentRow: () => Row<TData> | undefined
+  /**
+   * Returns the parent rows for the row, all the way up to a root row.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/row#getparentrows)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/rows)
+   */
+  getParentRows: () => Row<TData>[]
+  /**
+   * Returns a unique array of values from the row for a given columnId.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/row#getuniquevalues)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/rows)
+   */
+  getUniqueValues: <TValue>(columnId: string) => TValue[]
+  /**
+   * Returns the value from the row for a given columnId.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/row#getvalue)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/rows)
+   */
+  getValue: <TValue>(columnId: string) => TValue
+  /**
+   * The resolved unique identifier for the row resolved via the `options.getRowId` option. Defaults to the row's index (or relative index if it is a subRow).
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/row#id)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/rows)
+   */
   id: string
+  /**
+   * The index of the row within its parent array (or the root data array).
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/row#index)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/rows)
+   */
   index: number
+  /**
+   * The original row object provided to the table. If the row is a grouped row, the original row object will be the first original in the group.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/row#original)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/rows)
+   */
   original: TData
-  depth: number
+  /**
+   * An array of the original subRows as returned by the `options.getSubRows` option.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/row#originalsubrows)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/rows)
+   */
+  originalSubRows?: TData[]
+  /**
+   * If nested, this row's parent row id.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/row#parentid)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/rows)
+   */
   parentId?: string
-  _valuesCache: Record<string, unknown>
-  _uniqueValuesCache: Record<string, unknown>
-  getValue: <TValue>(columnId: string) => TValue
-  getUniqueValues: <TValue>(columnId: string) => TValue[]
+  /**
+   * Renders the value for the row in a given columnId the same as `getValue`, but will return the `renderFallbackValue` if no value is found.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/row#rendervalue)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/rows)
+   */
   renderValue: <TValue>(columnId: string) => TValue
+  /**
+   * An array of subRows for the row as returned and created by the `options.getSubRows` option.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/row#subrows)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/rows)
+   */
   subRows: Row<TData>[]
-  getLeafRows: () => Row<TData>[]
-  originalSubRows?: TData[]
-  getAllCells: () => Cell<TData, unknown>[]
-  _getAllCellsByColumnId: () => Record<string, Cell<TData, unknown>>
-  getParentRow: () => Row<TData> | undefined
-  getParentRows: () => Row<TData>[]
 }
 
 export const createRow = <TData extends RowData>(
@@ -112,10 +182,13 @@ export const createRow = <TData extends RowData>(
     _getAllCellsByColumnId: memo(
       () => [row.getAllCells()],
       allCells => {
-        return allCells.reduce((acc, cell) => {
-          acc[cell.column.id] = cell
-          return acc
-        }, {} as Record<string, Cell<TData, unknown>>)
+        return allCells.reduce(
+          (acc, cell) => {
+            acc[cell.column.id] = cell
+            return acc
+          },
+          {} as Record<string, Cell<TData, unknown>>
+        )
       },
       {
         key: