@tanstack/table-core/dist/index.d.ts

Headless UI for building powerful tables & datagrids for TS/JS.

import { CellData, DeepKeys, DeepValue, Getter, NoInfer, OnChangeFn, PartialKeys, Prettify, RequiredKeys, RowData, TransformDataValueFn, UnionToIntersection, Updater } from "./types/type-utils.js";
import { coreCellsFeature } from "./core/cells/coreCellsFeature.js";
import { coreColumnsFeature } from "./core/columns/coreColumnsFeature.js";
import { coreHeadersFeature } from "./core/headers/coreHeadersFeature.js";
import { coreRowModelsFeature } from "./core/row-models/coreRowModelsFeature.js";
import { coreRowsFeature } from "./core/rows/coreRowsFeature.js";
import { coreTablesFeature } from "./core/table/coreTablesFeature.js";
import { CoreFeatures, coreFeatures } from "./core/coreFeatures.js";
import { CellSelectionBounds, CellSelectionDirection, CellSelectionEdges, CellSelectionRange, CellSelectionRangeMode, CellSelectionRangeOperation, CellSelectionState, Cell_CellSelection, ColumnDef_CellSelection, SelectCellRangeOptions, TableOptions_CellSelection, TableState_CellSelection, Table_CellSelection } from "./features/cell-selection/cellSelectionFeature.types.js";
import { BuiltInFilterFn, constructFilterFn, filterFn_arrHas, filterFn_arrIncludes, filterFn_arrIncludesAll, filterFn_arrIncludesSome, filterFn_between, filterFn_betweenInclusive, filterFn_empty, filterFn_endsWith, filterFn_equals, filterFn_equalsString, filterFn_equalsStringSensitive, filterFn_greaterThan, filterFn_greaterThanOrEqualTo, filterFn_inDateRange, filterFn_inNumberRange, filterFn_includesString, filterFn_includesStringSensitive, filterFn_lessThan, filterFn_lessThanOrEqualTo, filterFn_notEmpty, filterFn_startsWith, filterFn_weakEquals, filterFns } from "./features/column-filtering/filterFns.js";
import { BuiltInSortFn, constructSortFn, reSplitAlphaNumeric, sortFn_alphanumeric, sortFn_alphanumericCaseSensitive, sortFn_basic, sortFn_datetime, sortFn_text, sortFn_textCaseSensitive, sortFns } from "./features/row-sorting/sortFns.js";
import { CachedRowModel_Sorted, ColumnDef_RowSorting, ColumnSort, Column_RowSorting, CreatedSortFn, CustomSortFns, ExtractSortFnKeys, RowModelFns_RowSorting, SortDirection, SortFn, SortFnDef, SortFnOption, SortFns, SortingState, TableOptions_RowSorting, TableState_RowSorting, Table_RowModels_Sorted, Table_RowSorting } from "./features/row-sorting/rowSortingFeature.types.js";
import { BuiltInAggregationFn, aggregationFn_count, aggregationFn_extent, aggregationFn_first, aggregationFn_last, aggregationFn_max, aggregationFn_mean, aggregationFn_median, aggregationFn_min, aggregationFn_sum, aggregationFn_unique, aggregationFn_uniqueCount, aggregationFns } from "./features/row-aggregation/aggregationFns.js";
import { CellContext, Cell_Cell, Cell_CoreProperties, TableOptions_Cell } from "./core/cells/coreCellsFeature.types.js";
import { HeaderGroup, HeaderGroup_Core } from "./types/HeaderGroup.js";
import { ColumnDef_ColumnPinning, ColumnPinningDefaultOptions, ColumnPinningPosition, ColumnPinningState, Column_ColumnPinning, Row_ColumnPinning, TableOptions_ColumnPinning, TableState_ColumnPinning, Table_ColumnPinning } from "./features/column-pinning/columnPinningFeature.types.js";
import { ColumnDef_ColumnSizing, ColumnOffsets, ColumnOffsetsByPosition, ColumnSizingDefaultOptions, ColumnSizingState, Column_ColumnSizing, Header_ColumnSizing, TableOptions_ColumnSizing, TableState_ColumnSizing, Table_ColumnSizing } from "./features/column-sizing/columnSizingFeature.types.js";
import { ColumnDef_ColumnResizing, ColumnResizeDirection, ColumnResizeMode, ColumnResizingDefaultOptions, Column_ColumnResizing, Header_ColumnResizing, TableOptions_ColumnResizing, TableState_ColumnResizing, Table_ColumnResizing, columnResizingState } from "./features/column-resizing/columnResizingFeature.types.js";
import { Header, Header_Core, Header_FeatureMap } from "./types/Header.js";
import { HeaderContext, HeaderGroup_Header, Header_CoreProperties, Header_Header, Table_Headers } from "./core/headers/coreHeadersFeature.types.js";
import { CachedRowModel_Grouped, Cell_ColumnGrouping, ColumnDef_ColumnGrouping, ColumnDefaultOptions, Column_ColumnGrouping, GroupingColumnMode, GroupingState, Row_ColumnGrouping, TableOptions_ColumnGrouping, TableState_ColumnGrouping, Table_ColumnGrouping, Table_RowModels_Grouped } from "./features/column-grouping/columnGroupingFeature.types.js";
import { ColumnDef_GlobalFiltering, Column_GlobalFiltering, TableOptions_GlobalFiltering, TableState_GlobalFiltering, Table_GlobalFiltering } from "./features/global-filtering/globalFilteringFeature.types.js";
import { AccessorColumnDef, AccessorFn, AccessorFnColumnDef, AccessorFnColumnDefBase, AccessorKeyColumnDef, AccessorKeyColumnDefBase, ColumnDef, ColumnDefBase, ColumnDefBase_All, ColumnDefResolved, ColumnDefTemplate, ColumnDef_FeatureMap, ColumnMeta, DisplayColumnDef, ExtractColumnMeta, GroupColumnDef, IdIdentifier, IdentifiedColumnDef, StringHeaderIdentifier, StringOrTemplateHeader } from "./types/ColumnDef.js";
import { AggregationContext, AggregationFnDef, AggregationFnDescriptor, AggregationFnListItem, AggregationFnOption, AggregationFnRef, AggregationFns, AggregationMergeContext, AggregationResult, AggregationResultOf, AggregationValueContext, AggregationValueOptions, AggregationValueResult, Cell_RowAggregation, ColumnAggregationValue, ColumnDef_RowAggregation, Column_RowAggregation, CustomAggregationFns, ExtractAggregationFnKeys, ResolvedAggregationFn, RowModelFns_RowAggregation, Row_RowAggregation, TableOptions_RowAggregation, constructAggregationFn } from "./features/row-aggregation/rowAggregationFeature.types.js";
import { ColumnIndexes, ColumnOrderDefaultOptions, ColumnOrderState, Column_ColumnOrdering, TableOptions_ColumnOrdering, TableState_ColumnOrdering, Table_ColumnOrdering } from "./features/column-ordering/columnOrderingFeature.types.js";
import { Column_Column, Column_CoreProperties, TableOptions_Columns, Table_Columns } from "./core/columns/coreColumnsFeature.types.js";
import { Column, Column_Core, Column_FeatureMap } from "./types/Column.js";
import { ColumnDef_ColumnVisibility, ColumnVisibilityState, Column_ColumnVisibility, Row_ColumnVisibility, TableOptions_ColumnVisibility, TableState_ColumnVisibility, Table_ColumnVisibility, VisibilityDefaultOptions } from "./features/column-visibility/columnVisibilityFeature.types.js";
import { CachedRowModel_Expanded, ExpandedState, ExpandedStateList, Row_RowExpanding, TableOptions_RowExpanding, TableState_RowExpanding, Table_RowExpanding, Table_RowModels_Expanded } from "./features/row-expanding/rowExpandingFeature.types.js";
import { RowPinningDefaultOptions, RowPinningPosition, RowPinningState, Row_RowPinning, TableOptions_RowPinning, TableState_RowPinning, Table_RowPinning } from "./features/row-pinning/rowPinningFeature.types.js";
import { RowSelectionState, Row_RowSelection, TableOptions_RowSelection, TableState_RowSelection, Table_RowSelection, ToggleSelectedOptions } from "./features/row-selection/rowSelectionFeature.types.js";
import { Row_CoreProperties, Row_Row, TableOptions_Rows, Table_Rows } from "./core/rows/coreRowsFeature.types.js";
import { Row, Row_Core, Row_FeatureMap } from "./types/Row.js";
import { CachedRowModel_Filtered, ColumnDef_ColumnFiltering, ColumnFilter, ColumnFilterAutoRemoveTestFn, ColumnFiltersState, Column_ColumnFiltering, CreatedFilterFn, CustomFilterFns, ExtractFilterFnKeys, ExtractFilterMeta, FilterFn, FilterFnDef, FilterFnOption, FilterFns, FilterMeta, ResolvedColumnFilter, RowModelFns_ColumnFiltering, Row_ColumnFiltering, TableOptions_ColumnFiltering, TableState_ColumnFiltering, Table_ColumnFiltering, Table_RowModels_Filtered, TransformFilterValueFn } from "./features/column-filtering/columnFilteringFeature.types.js";
import { CachedRowModel_Paginated, PaginationDefaultOptions, PaginationState, TableOptions_RowPagination, TableState_RowPagination, Table_RowModels_Paginated, Table_RowPagination } from "./features/row-pagination/rowPaginationFeature.types.js";
import { CachedRowModel_Core, RowModel, Table_RowModels, Table_RowModels_Core } from "./core/row-models/coreRowModelsFeature.types.js";
import { CachedRowModel_Faceted, Column_ColumnFaceting, Table_ColumnFaceting, Table_RowModels_Faceted } from "./features/column-faceting/columnFacetingFeature.types.js";
import { CachedRowModel_All, CachedRowModels, CachedRowModels_FeatureMap } from "./types/RowModel.js";
import { RowModelFns, RowModelFns_All, RowModelFns_Core, RowModelFns_FeatureMap } from "./types/RowModelFns.js";
import { TableState, TableState_All, TableState_FeatureMap } from "./types/TableState.js";
import { DebugOptions, TableOptions, TableOptions_All, TableOptions_Core, TableOptions_FeatureMap } from "./types/TableOptions.js";
import { Atoms, Atoms_All, BaseAtoms, BaseAtoms_All, ExternalAtoms, ExternalAtoms_All, ExtractTableMeta, TableMeta, TableOptions_Table, Table_CoreProperties, Table_Table } from "./core/table/coreTablesFeature.types.js";
import { Table, Table_Core, Table_FeatureMap } from "./types/Table.js";
import { CellSpanIndex, Cell_CellSpanning, ColSpanContext, ColumnDef_CellSpanning, RowSpanContext, TableOptions_CellSpanning, Table_CellSpanning } from "./features/cell-spanning/cellSpanningFeature.types.js";
import { Cell, Cell_Core, Cell_FeatureMap } from "./types/Cell.js";
import { cellSelectionFeature } from "./features/cell-selection/cellSelectionFeature.js";
import { cellSpanningFeature } from "./features/cell-spanning/cellSpanningFeature.js";
import { columnFacetingFeature } from "./features/column-faceting/columnFacetingFeature.js";
import { rowAggregationFeature } from "./features/row-aggregation/rowAggregationFeature.js";
import { columnFilteringFeature } from "./features/column-filtering/columnFilteringFeature.js";
import { columnGroupingFeature } from "./features/column-grouping/columnGroupingFeature.js";
import { columnOrderingFeature } from "./features/column-ordering/columnOrderingFeature.js";
import { columnPinningFeature } from "./features/column-pinning/columnPinningFeature.js";
import { columnResizingFeature } from "./features/column-resizing/columnResizingFeature.js";
import { columnSizingFeature } from "./features/column-sizing/columnSizingFeature.js";
import { columnVisibilityFeature } from "./features/column-visibility/columnVisibilityFeature.js";
import { globalFilteringFeature } from "./features/global-filtering/globalFilteringFeature.js";
import { rowExpandingFeature } from "./features/row-expanding/rowExpandingFeature.js";
import { rowPaginationFeature } from "./features/row-pagination/rowPaginationFeature.js";
import { rowPinningFeature } from "./features/row-pinning/rowPinningFeature.js";
import { rowSelectionFeature } from "./features/row-selection/rowSelectionFeature.js";
import { rowSortingFeature } from "./features/row-sorting/rowSortingFeature.js";
import { StockFeatures, stockFeatures } from "./features/stockFeatures.js";
import { ExtractFeatureMapTypes, FeatureSlotPrereqs, IsAny, NonFeatureKeys, Plugins, TableFeature, TableFeatures, ValidateFeatureSlots } from "./types/TableFeatures.js";
import { ColumnHelper, createColumnHelper } from "./helpers/columnHelper.js";
import { metaHelper } from "./helpers/metaHelper.js";
import { tableFeatures } from "./helpers/tableFeatures.js";
import { tableOptions } from "./helpers/tableOptions.js";
import { API, APIObject, PrototypeAPI, PrototypeAPIObject, assignPrototypeAPIs, assignTableAPIs, callMemoOrStaticFn, cloneState, copyInstancePropertiesWithoutMemos, flattenBy, functionalUpdate, getFunctionNameInfo, hasOwn, isFunction, makeObjectMap, makeStateUpdater, memo, skipFirstRun, tableMemo } from "./utils.js";
import { constructCell } from "./core/cells/constructCell.js";
import { constructColumn } from "./core/columns/constructColumn.js";
import { buildHeaderGroups } from "./core/headers/buildHeaderGroups.js";
import { constructHeader } from "./core/headers/constructHeader.js";
import { constructRow } from "./core/rows/constructRow.js";
import { createCoreRowModel } from "./core/row-models/createCoreRowModel.js";
import { constructTable, getInitialTableState } from "./core/table/constructTable.js";
import { createFacetedMinMaxValues } from "./features/column-faceting/createFacetedMinMaxValues.js";
import { createFacetedRowModel } from "./features/column-faceting/createFacetedRowModel.js";
import { createFacetedUniqueValues } from "./features/column-faceting/createFacetedUniqueValues.js";
import { createFilteredRowModel } from "./features/column-filtering/createFilteredRowModel.js";
import { createGroupedRowModel } from "./features/column-grouping/createGroupedRowModel.js";
import { createExpandedRowModel, expandRows } from "./features/row-expanding/createExpandedRowModel.js";
import { createPaginatedRowModel } from "./features/row-pagination/createPaginatedRowModel.js";
import { createSortedRowModel } from "./features/row-sorting/createSortedRowModel.js";
export { API, APIObject, AccessorColumnDef, AccessorFn, AccessorFnColumnDef, AccessorFnColumnDefBase, AccessorKeyColumnDef, AccessorKeyColumnDefBase, AggregationContext, AggregationFnDef, AggregationFnDescriptor, AggregationFnListItem, AggregationFnOption, AggregationFnRef, AggregationFns, AggregationMergeContext, AggregationResult, AggregationResultOf, AggregationValueContext, AggregationValueOptions, AggregationValueResult, Atoms, Atoms_All, BaseAtoms, BaseAtoms_All, BuiltInAggregationFn, BuiltInFilterFn, BuiltInSortFn, CachedRowModel_All, CachedRowModel_Core, CachedRowModel_Expanded, CachedRowModel_Faceted, CachedRowModel_Filtered, CachedRowModel_Grouped, CachedRowModel_Paginated, CachedRowModel_Sorted, CachedRowModels, CachedRowModels_FeatureMap, Cell, CellContext, CellData, CellSelectionBounds, CellSelectionDirection, CellSelectionEdges, CellSelectionRange, CellSelectionRangeMode, CellSelectionRangeOperation, CellSelectionState, CellSpanIndex, Cell_Cell, Cell_CellSelection, Cell_CellSpanning, Cell_ColumnGrouping, Cell_Core, Cell_CoreProperties, Cell_FeatureMap, Cell_RowAggregation, ColSpanContext, Column, ColumnAggregationValue, ColumnDef, ColumnDefBase, ColumnDefBase_All, ColumnDefResolved, ColumnDefTemplate, ColumnDef_CellSelection, ColumnDef_CellSpanning, ColumnDef_ColumnFiltering, ColumnDef_ColumnGrouping, ColumnDef_ColumnPinning, ColumnDef_ColumnResizing, ColumnDef_ColumnSizing, ColumnDef_ColumnVisibility, ColumnDef_FeatureMap, ColumnDef_GlobalFiltering, ColumnDef_RowAggregation, ColumnDef_RowSorting, ColumnDefaultOptions, ColumnFilter, ColumnFilterAutoRemoveTestFn, ColumnFiltersState, ColumnHelper, ColumnIndexes, ColumnMeta, ColumnOffsets, ColumnOffsetsByPosition, ColumnOrderDefaultOptions, ColumnOrderState, ColumnPinningDefaultOptions, ColumnPinningPosition, ColumnPinningState, ColumnResizeDirection, ColumnResizeMode, ColumnResizingDefaultOptions, ColumnSizingDefaultOptions, ColumnSizingState, ColumnSort, ColumnVisibilityState, Column_Column, Column_ColumnFaceting, Column_ColumnFiltering, Column_ColumnGrouping, Column_ColumnOrdering, Column_ColumnPinning, Column_ColumnResizing, Column_ColumnSizing, Column_ColumnVisibility, Column_Core, Column_CoreProperties, Column_FeatureMap, Column_GlobalFiltering, Column_RowAggregation, Column_RowSorting, CoreFeatures, CreatedFilterFn, CreatedSortFn, CustomAggregationFns, CustomFilterFns, CustomSortFns, DebugOptions, DeepKeys, DeepValue, DisplayColumnDef, ExpandedState, ExpandedStateList, ExternalAtoms, ExternalAtoms_All, ExtractAggregationFnKeys, ExtractColumnMeta, ExtractFeatureMapTypes, ExtractFilterFnKeys, ExtractFilterMeta, ExtractSortFnKeys, ExtractTableMeta, FeatureSlotPrereqs, FilterFn, FilterFnDef, FilterFnOption, FilterFns, FilterMeta, Getter, GroupColumnDef, GroupingColumnMode, GroupingState, Header, HeaderContext, HeaderGroup, HeaderGroup_Core, HeaderGroup_Header, Header_ColumnResizing, Header_ColumnSizing, Header_Core, Header_CoreProperties, Header_FeatureMap, Header_Header, IdIdentifier, IdentifiedColumnDef, IsAny, NoInfer, NonFeatureKeys, OnChangeFn, PaginationDefaultOptions, PaginationState, PartialKeys, Plugins, Prettify, PrototypeAPI, PrototypeAPIObject, RequiredKeys, ResolvedAggregationFn, ResolvedColumnFilter, Row, RowData, RowModel, RowModelFns, RowModelFns_All, RowModelFns_ColumnFiltering, RowModelFns_Core, RowModelFns_FeatureMap, RowModelFns_RowAggregation, RowModelFns_RowSorting, RowPinningDefaultOptions, RowPinningPosition, RowPinningState, RowSelectionState, RowSpanContext, Row_ColumnFiltering, Row_ColumnGrouping, Row_ColumnPinning, Row_ColumnVisibility, Row_Core, Row_CoreProperties, Row_FeatureMap, Row_Row, Row_RowAggregation, Row_RowExpanding, Row_RowPinning, Row_RowSelection, SelectCellRangeOptions, SortDirection, SortFn, SortFnDef, SortFnOption, SortFns, SortingState, StockFeatures, StringHeaderIdentifier, StringOrTemplateHeader, Table, TableFeature, TableFeatures, TableMeta, TableOptions, TableOptions_All, TableOptions_Cell, TableOptions_CellSelection, TableOptions_CellSpanning, TableOptions_ColumnFiltering, TableOptions_ColumnGrouping, TableOptions_ColumnOrdering, TableOptions_ColumnPinning, TableOptions_ColumnResizing, TableOptions_ColumnSizing, TableOptions_ColumnVisibility, TableOptions_Columns, TableOptions_Core, TableOptions_FeatureMap, TableOptions_GlobalFiltering, TableOptions_RowAggregation, TableOptions_RowExpanding, TableOptions_RowPagination, TableOptions_RowPinning, TableOptions_RowSelection, TableOptions_RowSorting, TableOptions_Rows, TableOptions_Table, TableState, TableState_All, TableState_CellSelection, TableState_ColumnFiltering, TableState_ColumnGrouping, TableState_ColumnOrdering, TableState_ColumnPinning, TableState_ColumnResizing, TableState_ColumnSizing, TableState_ColumnVisibility, TableState_FeatureMap, TableState_GlobalFiltering, TableState_RowExpanding, TableState_RowPagination, TableState_RowPinning, TableState_RowSelection, TableState_RowSorting, Table_CellSelection, Table_CellSpanning, Table_ColumnFaceting, Table_ColumnFiltering, Table_ColumnGrouping, Table_ColumnOrdering, Table_ColumnPinning, Table_ColumnResizing, Table_ColumnSizing, Table_ColumnVisibility, Table_Columns, Table_Core, Table_CoreProperties, Table_FeatureMap, Table_GlobalFiltering, Table_Headers, Table_RowExpanding, Table_RowModels, Table_RowModels_Core, Table_RowModels_Expanded, Table_RowModels_Faceted, Table_RowModels_Filtered, Table_RowModels_Grouped, Table_RowModels_Paginated, Table_RowModels_Sorted, Table_RowPagination, Table_RowPinning, Table_RowSelection, Table_RowSorting, Table_Rows, Table_Table, ToggleSelectedOptions, TransformDataValueFn, TransformFilterValueFn, UnionToIntersection, Updater, ValidateFeatureSlots, VisibilityDefaultOptions, aggregationFn_count, aggregationFn_extent, aggregationFn_first, aggregationFn_last, aggregationFn_max, aggregationFn_mean, aggregationFn_median, aggregationFn_min, aggregationFn_sum, aggregationFn_unique, aggregationFn_uniqueCount, aggregationFns, assignPrototypeAPIs, assignTableAPIs, buildHeaderGroups, callMemoOrStaticFn, cellSelectionFeature, cellSpanningFeature, cloneState, columnFacetingFeature, columnFilteringFeature, columnGroupingFeature, columnOrderingFeature, columnPinningFeature, columnResizingFeature, columnResizingState, columnSizingFeature, columnVisibilityFeature, constructAggregationFn, constructCell, constructColumn, constructFilterFn, constructHeader, constructRow, constructSortFn, constructTable, copyInstancePropertiesWithoutMemos, coreCellsFeature, coreColumnsFeature, coreFeatures, coreHeadersFeature, coreRowModelsFeature, coreRowsFeature, coreTablesFeature, createColumnHelper, createCoreRowModel, createExpandedRowModel, createFacetedMinMaxValues, createFacetedRowModel, createFacetedUniqueValues, createFilteredRowModel, createGroupedRowModel, createPaginatedRowModel, createSortedRowModel, expandRows, filterFn_arrHas, filterFn_arrIncludes, filterFn_arrIncludesAll, filterFn_arrIncludesSome, filterFn_between, filterFn_betweenInclusive, filterFn_empty, filterFn_endsWith, filterFn_equals, filterFn_equalsString, filterFn_equalsStringSensitive, filterFn_greaterThan, filterFn_greaterThanOrEqualTo, filterFn_inDateRange, filterFn_inNumberRange, filterFn_includesString, filterFn_includesStringSensitive, filterFn_lessThan, filterFn_lessThanOrEqualTo, filterFn_notEmpty, filterFn_startsWith, filterFn_weakEquals, filterFns, flattenBy, functionalUpdate, getFunctionNameInfo, getInitialTableState, globalFilteringFeature, hasOwn, isFunction, makeObjectMap, makeStateUpdater, memo, metaHelper, reSplitAlphaNumeric, rowAggregationFeature, rowExpandingFeature, rowPaginationFeature, rowPinningFeature, rowSelectionFeature, rowSortingFeature, skipFirstRun, sortFn_alphanumeric, sortFn_alphanumericCaseSensitive, sortFn_basic, sortFn_datetime, sortFn_text, sortFn_textCaseSensitive, sortFns, stockFeatures, tableFeatures, tableMemo, tableOptions };