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

package/src/types/ColumnDef.ts

@@ -27,11 +27,23 @@ export interface ColumnMeta<
   TValue extends CellData = CellData,
 > {}
 
+/**
+ * Reads a cell value from an original row object.
+ *
+ * The row index is provided for accessors that need stable position-aware
+ * derived values.
+ */
 export type AccessorFn<
   TData extends RowData,
   TValue extends CellData = CellData,
 > = (originalRow: TData, index: number) => TValue
 
+/**
+ * A renderable column template value.
+ *
+ * Strings render directly; functions receive the relevant cell/header context
+ * and can return framework-specific render output.
+ */
 export type ColumnDefTemplate<TProps extends object> =
   | string
   | ((props: TProps) => any)
@@ -43,7 +55,13 @@ export type StringOrTemplateHeader<
 > = string | ColumnDefTemplate<HeaderContext<TFeatures, TData, TValue>>
 
 export interface StringHeaderIdentifier {
+  /**
+   * Header text used both for rendering and as a fallback column id.
+   */
   header: string
+  /**
+   * Optional explicit id that overrides the header-derived id.
+   */
   id?: string
 }
 
@@ -52,7 +70,13 @@ export interface IdIdentifier<
   TData extends RowData,
   TValue extends CellData = CellData,
 > {
+  /**
+   * Explicit stable column id.
+   */
   id: string
+  /**
+   * Header text or template used to render this column's header.
+   */
   header?: StringOrTemplateHeader<TFeatures, TData, TValue>
 }
 type ColumnIdentifiers<
@@ -66,9 +90,23 @@ interface ColumnDefBase_Core<
   TData extends RowData,
   TValue extends CellData = CellData,
 > {
+  /**
+   * Produces the values used by faceting/grouping for this column.
+   *
+   * When omitted, the normal accessor value is wrapped in a single-item array.
+   */
   getUniqueValues?: AccessorFn<TData, Array<unknown>>
+  /**
+   * Footer template rendered with header context.
+   */
   footer?: ColumnDefTemplate<HeaderContext<TFeatures, TData, TValue>>
+  /**
+   * Cell template rendered with cell context.
+   */
   cell?: ColumnDefTemplate<CellContext<TFeatures, TData, TValue>>
+  /**
+   * User-defined metadata available on the resolved column definition.
+   */
   meta?: ColumnMeta<TFeatures, TData, TValue>
 }
 

package/src/types/TableOptions.ts

@@ -24,6 +24,10 @@ export interface TableOptions_Plugins<
   TData extends RowData,
 > {}
 
+/**
+ * Core options that are always available on a table, before optional feature
+ * options are mixed in.
+ */
 export interface TableOptions_Core<
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -48,6 +52,13 @@ export type DebugOptions<TFeatures extends TableFeatures> = {
   debugTable?: boolean
 } & DebugKeysFor<CoreFeatures & TFeatures>
 
+/**
+ * Complete table options for a specific feature set.
+ *
+ * Feature options are included only when their feature is present in
+ * `TFeatures`, then custom feature/plugin options and debug options are mixed
+ * in.
+ */
 export type TableOptions<
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -104,6 +115,10 @@ export type TableOptions<
 //   ExtractFeatureTypes<'TableOptions', TFeatures> &
 //   TableOptions_Plugins<TFeatures, TData>
 
+/**
+ * Internal broad option shape used where feature code may need to read options
+ * from features that are not present in the current generic feature set.
+ */
 export type TableOptions_All<
   TFeatures extends TableFeatures,
   TData extends RowData,

package/src/types/TableState.ts

@@ -20,6 +20,12 @@ import type { ExtractFeatureTypes, TableFeatures } from './TableFeatures'
  */
 export interface TableState_Plugins<TFeatures extends TableFeatures> {}
 
+/**
+ * Complete table state for a specific feature set.
+ *
+ * State slices are included only when their feature is present in `TFeatures`,
+ * then custom feature/plugin state is mixed in.
+ */
 export type TableState<TFeatures extends TableFeatures> = UnionToIntersection<
   | ('columnFilteringFeature' extends keyof TFeatures
       ? TableState_ColumnFiltering
@@ -71,6 +77,12 @@ export type TableState<TFeatures extends TableFeatures> = UnionToIntersection<
 // > &
 //   TableState_Plugins<TFeatures>
 
+/**
+ * Internal broad state shape containing every stock feature state slice.
+ *
+ * Feature internals use this when they may need to inspect optional slices owned
+ * by other features.
+ */
 export type TableState_All = Partial<
   TableState_ColumnFiltering &
     TableState_ColumnGrouping &