@tanstack/table-core 8.13.2 → 8.14.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/table-core",
-  "version": "8.13.2",
+  "version": "8.14.0",
   "description": "Headless UI for building powerful tables & datagrids for TS/JS.",
   "author": "Tanner Linsley",
   "license": "MIT",

package/src/aggregationFns.ts

@@ -1,4 +1,4 @@
-import { AggregationFn } from './features/Grouping'
+import { AggregationFn } from './features/ColumnGrouping'
 import { isNumberArray } from './utils'
 
 const sum: AggregationFn<any> = (columnId, _leafRows, childRows) => {

package/src/core/column.ts

@@ -157,9 +157,9 @@ export function createColumn<TData extends RowData, TValue>(
   }
 
   for (const feature of table._features) {
-    feature.createColumn?.(column, table)
+    feature.createColumn?.(column as Column<TData, TValue>, table)
   }
 
-  // Yes, we have to convert table to uknown, because we know more than the compiler here.
+  // Yes, we have to convert table to unknown, because we know more than the compiler here.
   return column as Column<TData, TValue>
 }

package/src/core/headers.ts

@@ -1,6 +1,12 @@
-import { RowData, Column, Header, HeaderGroup, Table } from '../types'
+import {
+  RowData,
+  Column,
+  Header,
+  HeaderGroup,
+  Table,
+  TableFeature,
+} from '../types'
 import { getMemoOptions, memo } from '../utils'
-import { TableFeature } from './table'
 
 const debug = 'debugHeaders'
 
@@ -250,7 +256,7 @@ function createHeader<TData extends RowData, TValue>(
   }
 
   table._features.forEach(feature => {
-    feature.createHeader?.(header, table)
+    feature.createHeader?.(header as Header<TData, TValue>, table)
   })
 
   return header as Header<TData, TValue>

package/src/core/row.ts

@@ -194,7 +194,7 @@ export const createRow = <TData extends RowData>(
 
   for (let i = 0; i < table._features.length; i++) {
     const feature = table._features[i]
-    feature?.createRow?.(row, table)
+    feature?.createRow?.(row as Row<TData>, table)
   }
 
   return row as Row<TData>

package/src/core/table.ts

@@ -15,6 +15,7 @@ import {
   TableMeta,
   ColumnDefResolved,
   GroupColumnDef,
+  TableFeature,
 } from '../types'
 
 //
@@ -22,38 +23,33 @@ import { createColumn } from './column'
 import { Headers } from './headers'
 //
 
+import { ColumnFaceting } from '../features/ColumnFaceting'
+import { ColumnFiltering } from '../features/ColumnFiltering'
+import { ColumnGrouping } from '../features/ColumnGrouping'
+import { ColumnOrdering } from '../features/ColumnOrdering'
+import { ColumnPinning } from '../features/ColumnPinning'
 import { ColumnSizing } from '../features/ColumnSizing'
-import { Expanding } from '../features/Expanding'
-import { Filters } from '../features/Filters'
-import { Grouping } from '../features/Grouping'
-import { Ordering } from '../features/Ordering'
-import { Pagination } from '../features/Pagination'
-import { Pinning } from '../features/Pinning'
+import { ColumnVisibility } from '../features/ColumnVisibility'
+import { GlobalFiltering } from '../features/GlobalFiltering'
+import { RowExpanding } from '../features/RowExpanding'
+import { RowPagination } from '../features/RowPagination'
+import { RowPinning } from '../features/RowPinning'
 import { RowSelection } from '../features/RowSelection'
-import { Sorting } from '../features/Sorting'
-import { Visibility } from '../features/Visibility'
-
-export interface TableFeature {
-  createCell?: (cell: any, column: any, row: any, table: any) => any
-  createColumn?: (column: any, table: any) => any
-  createHeader?: (column: any, table: any) => any
-  createRow?: (row: any, table: any) => any
-  createTable?: (table: any) => any
-  getDefaultColumnDef?: () => any
-  getDefaultOptions?: (table: any) => any
-  getInitialState?: (initialState?: InitialTableState) => any
-}
+import { RowSorting } from '../features/RowSorting'
 
-const features = [
+const builtInFeatures = [
   Headers,
-  Visibility,
-  Ordering,
-  Pinning,
-  Filters,
-  Sorting,
-  Grouping,
-  Expanding,
-  Pagination,
+  ColumnVisibility,
+  ColumnOrdering,
+  ColumnPinning,
+  ColumnFaceting,
+  ColumnFiltering,
+  GlobalFiltering, //depends on ColumnFiltering and ColumnFaceting
+  RowSorting,
+  ColumnGrouping, //depends on RowSorting
+  RowExpanding,
+  RowPagination,
+  RowPinning,
   RowSelection,
   ColumnSizing,
 ] as const
@@ -63,6 +59,12 @@ const features = [
 export interface CoreTableState {}
 
 export interface CoreOptions<TData extends RowData> {
+  /**
+   * An array of extra features that you can add to the table instance.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/table#_features)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/tables)
+   */
+  _features?: TableFeature[]
   /**
    * Set this option to override any of the `autoReset...` feature options.
    * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/table#autoresetall)
@@ -279,11 +281,16 @@ export interface CoreInstance<TData extends RowData> {
 export function createTable<TData extends RowData>(
   options: TableOptionsResolved<TData>
 ): Table<TData> {
-  if (options.debugAll || options.debugTable) {
+  if (
+    process.env.NODE_ENV !== 'production' &&
+    (options.debugAll || options.debugTable)
+  ) {
     console.info('Creating Table Instance...')
   }
 
-  let table = { _features: features } as unknown as Table<TData>
+  const _features = [...builtInFeatures, ...(options._features ?? [])]
+
+  let table = { _features } as unknown as Table<TData>
 
   const defaultOptions = table._features.reduce((obj, feature) => {
     return Object.assign(obj, feature.getDefaultOptions?.(table))
@@ -308,14 +315,15 @@ export function createTable<TData extends RowData>(
   } as TableState
 
   table._features.forEach(feature => {
-    initialState = feature.getInitialState?.(initialState) ?? initialState
+    initialState = (feature.getInitialState?.(initialState) ??
+      initialState) as TableState
   })
 
   const queued: (() => void)[] = []
   let queuedTimeout = false
 
   const coreInstance: CoreInstance<TData> = {
-    _features: features,
+    _features,
     options: {
       ...defaultOptions,
       ...options,

package/src/features/ColumnFaceting.ts

@@ -0,0 +1,84 @@
+import { RowModel } from '..'
+import { Column, RowData, Table, TableFeature } from '../types'
+
+export interface FacetedColumn<TData extends RowData> {
+  _getFacetedMinMaxValues?: () => undefined | [number, number]
+  _getFacetedRowModel?: () => RowModel<TData>
+  _getFacetedUniqueValues?: () => Map<any, number>
+  /**
+   * A function that **computes and returns** a min/max tuple derived from `column.getFacetedRowModel`. Useful for displaying faceted result values.
+   * > ⚠️ Requires that you pass a valid `getFacetedMinMaxValues` function to `options.getFacetedMinMaxValues`. A default implementation is provided via the exported `getFacetedMinMaxValues` function.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#getfacetedminmaxvalues)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)
+   */
+  getFacetedMinMaxValues: () => undefined | [number, number]
+  /**
+   * Returns the row model with all other column filters applied, excluding its own filter. Useful for displaying faceted result counts.
+   * > ⚠️ Requires that you pass a valid `getFacetedRowModel` function to `options.facetedRowModel`. A default implementation is provided via the exported `getFacetedRowModel` function.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#getfacetedrowmodel)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)
+   */
+  getFacetedRowModel: () => RowModel<TData>
+  /**
+   * A function that **computes and returns** a `Map` of unique values and their occurrences derived from `column.getFacetedRowModel`. Useful for displaying faceted result values.
+   * > ⚠️ Requires that you pass a valid `getFacetedUniqueValues` function to `options.getFacetedUniqueValues`. A default implementation is provided via the exported `getFacetedUniqueValues` function.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#getfaceteduniquevalues)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)
+   */
+  getFacetedUniqueValues: () => Map<any, number>
+}
+
+export interface FacetedOptions<TData extends RowData> {
+  getFacetedMinMaxValues?: (
+    table: Table<TData>,
+    columnId: string
+  ) => () => undefined | [number, number]
+  getFacetedRowModel?: (
+    table: Table<TData>,
+    columnId: string
+  ) => () => RowModel<TData>
+  getFacetedUniqueValues?: (
+    table: Table<TData>,
+    columnId: string
+  ) => () => Map<any, number>
+}
+
+//
+
+export const ColumnFaceting: TableFeature = {
+  createColumn: <TData extends RowData>(
+    column: Column<TData, unknown>,
+    table: Table<TData>
+  ): void => {
+    column._getFacetedRowModel =
+      table.options.getFacetedRowModel &&
+      table.options.getFacetedRowModel(table, column.id)
+    column.getFacetedRowModel = () => {
+      if (!column._getFacetedRowModel) {
+        return table.getPreFilteredRowModel()
+      }
+
+      return column._getFacetedRowModel()
+    }
+    column._getFacetedUniqueValues =
+      table.options.getFacetedUniqueValues &&
+      table.options.getFacetedUniqueValues(table, column.id)
+    column.getFacetedUniqueValues = () => {
+      if (!column._getFacetedUniqueValues) {
+        return new Map()
+      }
+
+      return column._getFacetedUniqueValues()
+    }
+    column._getFacetedMinMaxValues =
+      table.options.getFacetedMinMaxValues &&
+      table.options.getFacetedMinMaxValues(table, column.id)
+    column.getFacetedMinMaxValues = () => {
+      if (!column._getFacetedMinMaxValues) {
+        return undefined
+      }
+
+      return column._getFacetedMinMaxValues()
+    }
+  },
+}