From be6a9323c07d06b2de59f8cd2b2abca1bc0e9849 Mon Sep 17 00:00:00 2001 From: Kevin Van Cott Date: Tue, 9 Jun 2026 07:51:38 -0500 Subject: [PATCH] docs: regen api ref and refactor composable tables guides --- docs/config.json | 337 ++---------------- docs/faq.md | 4 - docs/framework/angular/angular-table.md | 2 +- .../angular/guide/composable-tables.md | 184 ++++++++++ docs/framework/angular/guide/migrating.md | 2 +- .../angular/guide/table-composition.md | 295 --------------- .../reference/functions/injectTable.md | 2 +- .../reference/type-aliases/AngularTable.md | 17 +- .../reference/type-aliases/SubscribeSource.md | 2 +- .../variables/TanStackTableCellToken.md | 2 +- .../variables/TanStackTableHeaderToken.md | 2 +- .../reference/variables/TanStackTableToken.md | 2 +- docs/framework/lit/guide/composable-tables.md | 192 ++++++++++ .../preact/guide/composable-tables.md | 210 +++++++++++ .../preact/guide/create-table-hook.md | 169 --------- docs/framework/preact/preact-table.md | 2 +- .../interfaces/AppCellPropsWithSelector.md | 2 +- .../interfaces/AppCellPropsWithoutSelector.md | 2 +- .../interfaces/AppHeaderPropsWithSelector.md | 4 +- .../AppHeaderPropsWithoutSelector.md | 4 +- .../react/guide/composable-tables.md | 210 +++++++++++ .../react/guide/create-table-hook.md | 281 --------------- docs/framework/react/react-table.md | 2 +- .../interfaces/AppCellPropsWithSelector.md | 2 +- .../interfaces/AppCellPropsWithoutSelector.md | 2 +- .../interfaces/AppHeaderPropsWithSelector.md | 4 +- .../AppHeaderPropsWithoutSelector.md | 4 +- .../legacy/functions/getCoreRowModel.md | 2 +- .../legacy/functions/getExpandedRowModel.md | 2 +- .../functions/getFacetedMinMaxValues.md | 2 +- .../legacy/functions/getFacetedRowModel.md | 2 +- .../functions/getFacetedUniqueValues.md | 2 +- .../legacy/functions/getFilteredRowModel.md | 2 +- .../legacy/functions/getGroupedRowModel.md | 2 +- .../legacy/functions/getPaginationRowModel.md | 2 +- .../legacy/functions/getSortedRowModel.md | 2 +- .../functions/legacyCreateColumnHelper.md | 2 +- .../legacy/functions/useLegacyTable.md | 2 +- .../interfaces/LegacyRowModelOptions.md | 26 +- .../FacetedMinMaxValuesFactory.md | 2 +- .../type-aliases/FacetedRowModelFactory.md | 2 +- .../FacetedUniqueValuesFactory.md | 2 +- .../legacy/type-aliases/LegacyCell.md | 2 +- .../legacy/type-aliases/LegacyColumn.md | 2 +- .../legacy/type-aliases/LegacyColumnDef.md | 2 +- .../legacy/type-aliases/LegacyHeader.md | 2 +- .../legacy/type-aliases/LegacyHeaderGroup.md | 2 +- .../legacy/type-aliases/LegacyReactTable.md | 2 +- .../legacy/type-aliases/LegacyRow.md | 2 +- .../legacy/type-aliases/LegacyTable.md | 2 +- .../legacy/type-aliases/LegacyTableOptions.md | 2 +- .../legacy/type-aliases/RowModelFactory.md | 2 +- .../solid/guide/composable-tables.md | 217 +++++++++++ .../solid/reference/functions/createTable.md | 24 +- .../reference/functions/createTableHook.md | 28 +- docs/framework/solid/reference/index.md | 10 +- .../reference/interfaces/AppCellComponent.md | 52 +-- .../reference/interfaces/AppCellProps.md | 58 +++ .../interfaces/AppCellPropsWithSelector.md | 86 ----- .../interfaces/AppCellPropsWithoutSelector.md | 68 ---- .../interfaces/AppHeaderComponent.md | 52 +-- .../reference/interfaces/AppHeaderProps.md | 58 +++ .../interfaces/AppHeaderPropsWithSelector.md | 88 ----- .../AppHeaderPropsWithoutSelector.md | 70 ---- .../reference/interfaces/AppTableComponent.md | 40 +-- .../reference/interfaces/AppTableProps.md | 18 + .../interfaces/AppTablePropsWithSelector.md | 60 ---- .../AppTablePropsWithoutSelector.md | 30 -- .../reference/type-aliases/AppSolidTable.md | 27 +- .../reference/type-aliases/SolidTable.md | 142 +------- .../reference/type-aliases/SubscribeSource.md | 22 -- .../svelte/guide/composable-tables.md | 201 +++++++++++ .../reference/type-aliases/FlexRender.md | 2 +- .../svelte/reference/variables/FlexRender.md | 2 +- docs/framework/vue/guide/composable-tables.md | 233 ++++++++++++ .../reference/functions/createTableHook.md | 14 +- .../vue/reference/functions/flexRender.md | 2 +- .../vue/reference/functions/useTable.md | 21 +- docs/framework/vue/reference/index.md | 3 +- .../vue/reference/interfaces/AppCellProps.md | 30 +- .../reference/interfaces/AppHeaderProps.md | 30 +- .../vue/reference/interfaces/AppTableProps.md | 32 +- .../reference/interfaces/FlexRenderCell.md | 78 ++++ .../reference/interfaces/FlexRenderHeader.md | 50 +++ .../vue/reference/type-aliases/AppVueTable.md | 6 +- .../reference/type-aliases/SubscribeSource.md | 22 -- .../TableOptionsWithReactiveData.md | 2 +- .../vue/reference/type-aliases/VueTable.md | 192 +--------- .../vue/reference/variables/AppFlexRender.md | 20 +- .../vue/reference/variables/FlexRender.md | 20 +- .../index/functions/aggregationFn_count.md | 40 +++ .../index/functions/aggregationFn_extent.md | 48 +++ .../index/functions/aggregationFn_max.md | 48 +++ .../index/functions/aggregationFn_mean.md | 41 +++ .../index/functions/aggregationFn_median.md | 41 +++ .../index/functions/aggregationFn_min.md | 48 +++ .../index/functions/aggregationFn_sum.md | 48 +++ .../index/functions/aggregationFn_unique.md | 40 +++ .../functions/aggregationFn_uniqueCount.md | 40 +++ .../index/functions/callMemoOrStaticFn.md | 18 +- .../constructColumnFacetingFeature.md | 30 -- .../constructColumnFilteringFeature.md | 30 -- .../constructColumnGroupingFeature.md | 30 -- .../constructColumnOrderingFeature.md | 30 -- .../constructColumnPinningFeature.md | 30 -- .../constructColumnResizingFeature.md | 30 -- .../functions/constructColumnSizingFeature.md | 30 -- .../constructColumnVisibilityFeature.md | 30 -- .../functions/constructCoreCellsFeature.md | 30 -- .../functions/constructCoreColumnsFeature.md | 30 -- .../functions/constructCoreHeadersFeature.md | 30 -- .../constructCoreRowModelsFeature.md | 30 -- .../functions/constructCoreRowsFeature.md | 30 -- .../functions/constructCoreTablesFeature.md | 30 -- .../constructGlobalFilteringFeature.md | 30 -- .../functions/constructRowExpandingFeature.md | 30 -- .../constructRowPaginationFeature.md | 30 -- .../functions/constructRowPinningFeature.md | 30 -- .../functions/constructRowSelectionFeature.md | 30 -- .../functions/constructRowSortingFeature.md | 30 -- .../index/functions/constructTable.md | 2 +- .../index/functions/createFilteredRowModel.md | 2 +- .../index/functions/filterFn_arrHas.md | 45 +++ .../index/functions/getInitialTableState.md | 2 +- .../index/functions/makeStateUpdater.md | 15 +- .../index/functions/sortFn_alphanumeric.md | 47 +++ .../sortFn_alphanumericCaseSensitive.md | 47 +++ .../reference/index/functions/sortFn_basic.md | 47 +++ .../index/functions/sortFn_datetime.md | 47 +++ docs/reference/index/functions/sortFn_text.md | 47 +++ .../functions/sortFn_textCaseSensitive.md | 47 +++ .../reference/index/functions/tableOptions.md | 10 +- docs/reference/index/index.md | 128 ++----- .../index/interfaces/CachedRowModel_Core.md | 8 +- .../interfaces/CachedRowModel_Plugins.md | 12 - .../interfaces/CachedRowModels_FeatureMap.md | 78 ++++ .../interfaces/CachedRowModels_Plugins.md | 18 - docs/reference/index/interfaces/Cell_Core.md | 2 +- .../index/interfaces/Cell_FeatureMap.md | 18 + .../index/interfaces/Cell_Plugins.md | 25 -- .../index/interfaces/ColumnDef_FeatureMap.md | 102 ++++++ .../index/interfaces/ColumnDef_Plugins.md | 25 -- .../ColumnFacetingFeatureConstructors.md | 18 - .../ColumnFilteringFeatureConstructors.md | 18 - .../ColumnGroupingFeatureConstructors.md | 18 - docs/reference/index/interfaces/ColumnMeta.md | 2 +- .../ColumnOrderingFeatureConstructors.md | 18 - .../ColumnPinningFeatureConstructors.md | 18 - .../ColumnResizingFeatureConstructors.md | 18 - .../ColumnSizingFeatureConstructors.md | 18 - .../ColumnVisibilityFeatureConstructors.md | 18 - .../reference/index/interfaces/Column_Core.md | 2 +- .../index/interfaces/Column_FeatureMap.md | 118 ++++++ .../index/interfaces/Column_Plugins.md | 25 -- .../CoreCellsFeatureConstructors.md | 18 - .../CoreColumnsFeatureConstructors.md | 18 - .../index/interfaces/CoreFeatures.md | 12 +- .../CoreHeadersFeatureConstructors.md | 18 - .../CoreRowModelsFeatureConstructors.md | 18 - .../interfaces/CoreRowsFeatureConstructors.md | 18 - .../CoreTablesFeatureConstructors.md | 18 - .../index/interfaces/CreateRowModel_Core.md | 8 +- .../interfaces/CreateRowModel_Plugins.md | 12 - .../interfaces/CreateRowModels_FeatureMap.md | 78 ++++ .../interfaces/CreateRowModels_Plugins.md | 21 -- .../index/interfaces/FeatureConstructors.md | 128 ------- .../GlobalFilteringFeatureConstructors.md | 18 - .../index/interfaces/HeaderGroup_Core.md | 2 +- .../index/interfaces/HeaderGroup_Plugins.md | 21 -- .../reference/index/interfaces/Header_Core.md | 2 +- .../index/interfaces/Header_FeatureMap.md | 28 ++ .../index/interfaces/Header_Plugins.md | 25 -- .../index/interfaces/IdIdentifier.md | 6 +- docs/reference/index/interfaces/Plugins.md | 2 +- .../RowExpandingFeatureConstructors.md | 18 - .../interfaces/RowModelFns_ColumnFiltering.md | 2 +- .../index/interfaces/RowModelFns_Core.md | 2 +- .../interfaces/RowModelFns_FeatureMap.md | 48 +++ .../index/interfaces/RowModelFns_Plugins.md | 21 -- .../RowPaginationFeatureConstructors.md | 18 - .../RowPinningFeatureConstructors.md | 18 - .../RowSelectionFeatureConstructors.md | 18 - .../RowSortingFeatureConstructors.md | 18 - docs/reference/index/interfaces/Row_Core.md | 2 +- .../index/interfaces/Row_FeatureMap.md | 88 +++++ .../reference/index/interfaces/Row_Plugins.md | 21 -- .../index/interfaces/StockFeatures.md | 28 +- .../interfaces/StringHeaderIdentifier.md | 6 +- .../index/interfaces/TableFeature.md | 248 +++++++++++-- .../index/interfaces/TableFeatures.md | 42 +-- .../index/interfaces/TableOptions_Core.md | 80 ++--- .../interfaces/TableOptions_FeatureMap.md | 148 ++++++++ .../index/interfaces/TableOptions_Plugins.md | 18 - .../index/interfaces/TableOptions_Table.md | 62 ++-- .../index/interfaces/TableState_FeatureMap.md | 138 +++++++ .../index/interfaces/TableState_Plugins.md | 17 - .../index/interfaces/Table_CoreProperties.md | 12 +- .../index/interfaces/Table_FeatureMap.md | 158 ++++++++ .../index/interfaces/Table_Plugins.md | 21 -- .../index/interfaces/Table_RowModels_Core.md | 6 +- .../reference/index/interfaces/Table_Table.md | 16 +- .../functions/autoRemove.md | 22 -- .../namespaces/filterFn_arrIncludes/index.md | 12 - .../functions/autoRemove.md | 22 -- .../filterFn_arrIncludesAll/index.md | 12 - .../functions/autoRemove.md | 22 -- .../filterFn_arrIncludesSome/index.md | 12 - .../filterFn_equals/functions/autoRemove.md | 22 -- .../index/namespaces/filterFn_equals/index.md | 14 - .../functions/autoRemove.md | 22 -- .../namespaces/filterFn_equalsString/index.md | 15 - .../functions/autoRemove.md | 22 -- .../filterFn_equalsStringSensitive/index.md | 14 - .../functions/resolveFilterValue.md | 22 -- .../namespaces/filterFn_greaterThan/index.md | 15 - .../functions/resolveFilterValue.md | 22 -- .../filterFn_greaterThanOrEqualTo/index.md | 14 - .../functions/autoRemove.md | 22 -- .../functions/resolveFilterValue.md | 22 -- .../filterFn_inNumberRange/index.md | 16 - .../functions/autoRemove.md | 22 -- .../filterFn_includesString/index.md | 15 - .../functions/autoRemove.md | 22 -- .../filterFn_includesStringSensitive/index.md | 14 - .../functions/resolveFilterValue.md | 22 -- .../namespaces/filterFn_lessThan/index.md | 14 - .../functions/resolveFilterValue.md | 22 -- .../filterFn_lessThanOrEqualTo/index.md | 14 - .../functions/autoRemove.md | 22 -- .../namespaces/filterFn_weakEquals/index.md | 15 - .../index/type-aliases/AccessorColumnDef.md | 2 +- .../index/type-aliases/AccessorFn.md | 2 +- .../index/type-aliases/AccessorFnColumnDef.md | 2 +- .../type-aliases/AccessorFnColumnDefBase.md | 2 +- .../type-aliases/AccessorKeyColumnDef.md | 2 +- .../type-aliases/AccessorKeyColumnDefBase.md | 2 +- .../index/type-aliases/AssignCellPrototype.md | 42 --- .../type-aliases/AssignColumnPrototype.md | 42 --- .../type-aliases/AssignHeaderPrototype.md | 42 --- .../index/type-aliases/AssignRowPrototype.md | 42 --- .../type-aliases/BuiltInAggregationFn.md | 2 +- .../index/type-aliases/BuiltInFilterFn.md | 2 +- .../index/type-aliases/BuiltInSortFn.md | 2 +- .../index/type-aliases/CachedRowModel_All.md | 2 +- .../index/type-aliases/CachedRowModels.md | 10 +- docs/reference/index/type-aliases/Cell.md | 4 +- docs/reference/index/type-aliases/Column.md | 14 +- .../reference/index/type-aliases/ColumnDef.md | 2 +- .../index/type-aliases/ColumnDefBase.md | 12 +- .../index/type-aliases/ColumnDefBase_All.md | 2 +- .../index/type-aliases/ColumnDefResolved.md | 2 +- .../index/type-aliases/ColumnDefTemplate.md | 2 +- .../index/type-aliases/Column_Internal.md | 2 +- .../index/type-aliases/ConstructTableAPIs.md | 38 -- .../index/type-aliases/CreateRowModels.md | 10 +- .../index/type-aliases/CreateRowModels_All.md | 2 +- .../index/type-aliases/CustomFilterFns.md | 2 +- .../index/type-aliases/DebugOptions.md | 2 +- .../index/type-aliases/DisplayColumnDef.md | 2 +- .../type-aliases/ExtractFeatureMapTypes.md | 22 ++ .../index/type-aliases/ExtractFeatureTypes.md | 22 -- .../index/type-aliases/FilterFnOption.md | 2 +- .../index/type-aliases/GetDefaultColumnDef.md | 36 -- .../type-aliases/GetDefaultStateSelector.md | 28 -- .../type-aliases/GetDefaultTableOptions.md | 38 -- .../index/type-aliases/GetInitialState.md | 28 -- .../index/type-aliases/GroupColumnDef.md | 2 +- docs/reference/index/type-aliases/Header.md | 6 +- .../index/type-aliases/HeaderGroup.md | 4 +- .../index/type-aliases/IdentifiedColumnDef.md | 2 +- .../index/type-aliases/InitRowInstanceData.md | 38 -- docs/reference/index/type-aliases/Row.md | 11 +- .../index/type-aliases/RowModelFns.md | 5 +- .../index/type-aliases/RowModelFns_All.md | 2 +- .../type-aliases/StringOrTemplateHeader.md | 2 +- docs/reference/index/type-aliases/Table.md | 18 +- .../index/type-aliases/TableOptions.md | 17 +- .../index/type-aliases/TableOptions_All.md | 4 +- .../TableOptions_FeatureMap_All.md | 22 ++ .../index/type-aliases/TableState.md | 17 +- .../index/type-aliases/TableState_All.md | 6 +- .../index/type-aliases/Table_Core.md | 2 +- .../index/type-aliases/Table_Internal.md | 18 +- .../index/type-aliases/Table_RowModels.md | 2 +- .../index/variables/aggregationFn_count.md | 16 - .../index/variables/aggregationFn_extent.md | 17 - .../index/variables/aggregationFn_max.md | 17 - .../index/variables/aggregationFn_mean.md | 17 - .../index/variables/aggregationFn_median.md | 17 - .../index/variables/aggregationFn_min.md | 17 - .../index/variables/aggregationFn_sum.md | 17 - .../index/variables/aggregationFn_unique.md | 16 - .../variables/aggregationFn_uniqueCount.md | 16 - .../index/variables/aggregationFns.md | 312 +++++++++++++++- .../index/variables/columnFacetingFeature.md | 9 +- .../index/variables/columnFilteringFeature.md | 10 +- .../index/variables/columnGroupingFeature.md | 9 +- .../index/variables/columnOrderingFeature.md | 9 +- .../index/variables/columnPinningFeature.md | 9 +- .../index/variables/columnResizingFeature.md | 9 +- .../index/variables/columnSizingFeature.md | 10 +- .../variables/columnVisibilityFeature.md | 9 +- .../index/variables/coreCellsFeature.md | 6 +- .../index/variables/coreColumnsFeature.md | 6 +- .../index/variables/coreHeadersFeature.md | 6 +- .../index/variables/coreRowModelsFeature.md | 6 +- .../index/variables/coreRowsFeature.md | 6 +- .../index/variables/coreTablesFeature.md | 6 +- .../index/variables/filterFn_arrHas.md | 14 - .../index/variables/filterFn_arrIncludes.md | 22 +- .../variables/filterFn_arrIncludesAll.md | 22 +- .../variables/filterFn_arrIncludesSome.md | 22 +- .../index/variables/filterFn_equals.md | 22 +- .../index/variables/filterFn_equalsString.md | 22 +- .../filterFn_equalsStringSensitive.md | 22 +- .../index/variables/filterFn_greaterThan.md | 22 +- .../filterFn_greaterThanOrEqualTo.md | 22 +- .../index/variables/filterFn_inNumberRange.md | 38 +- .../variables/filterFn_includesString.md | 22 +- .../filterFn_includesStringSensitive.md | 22 +- .../index/variables/filterFn_lessThan.md | 22 +- .../variables/filterFn_lessThanOrEqualTo.md | 22 +- .../index/variables/filterFn_weakEquals.md | 22 +- docs/reference/index/variables/filterFns.md | 272 +++++++++++++- .../index/variables/globalFilteringFeature.md | 9 +- .../index/variables/reSplitAlphaNumeric.md | 2 +- .../index/variables/rowExpandingFeature.md | 9 +- .../index/variables/rowPaginationFeature.md | 9 +- .../index/variables/rowPinningFeature.md | 9 +- .../index/variables/rowSelectionFeature.md | 9 +- .../index/variables/rowSortingFeature.md | 9 +- .../index/variables/sortFn_alphanumeric.md | 16 - .../sortFn_alphanumericCaseSensitive.md | 16 - .../reference/index/variables/sortFn_basic.md | 16 - .../index/variables/sortFn_datetime.md | 16 - docs/reference/index/variables/sortFn_text.md | 16 - .../variables/sortFn_textCaseSensitive.md | 16 - docs/reference/index/variables/sortFns.md | 218 ++++++++++- .../functions/cell_getIsAggregated.md | 2 +- .../functions/cell_getIsGrouped.md | 2 +- .../functions/cell_getIsPlaceholder.md | 2 +- .../functions/column_getAggregationFn.md | 2 +- .../functions/column_getAutoAggregationFn.md | 2 +- .../functions/column_getAutoFilterFn.md | 4 +- .../functions/column_getCanGroup.md | 2 +- .../functions/column_getCanResize.md | 2 +- .../functions/column_getGroupedIndex.md | 2 +- .../functions/column_getIsGrouped.md | 2 +- .../functions/column_getIsResizing.md | 2 +- .../column_getToggleGroupingHandler.md | 2 +- .../functions/column_toggleGrouping.md | 2 +- .../getDefaultColumnResizingState.md | 2 +- .../functions/getDefaultGroupingState.md | 2 +- .../functions/header_getResizeHandler.md | 2 +- .../functions/isTouchStartEvent.md | 2 +- .../functions/passiveEventSupported.md | 2 +- .../functions/row_getCenterVisibleCells.md | 4 +- .../functions/row_getGroupingValue.md | 11 +- .../functions/row_getIsGrouped.md | 11 +- .../functions/table_getCenterFooterGroups.md | 4 +- .../functions/table_getCenterLeafHeaders.md | 4 +- .../functions/table_getCenterTotalSize.md | 4 +- .../table_getCenterVisibleLeafColumns.md | 4 +- .../functions/table_getGlobalAutoFilterFn.md | 4 +- .../functions/table_getLeftFooterGroups.md | 4 +- .../functions/table_getLeftLeafHeaders.md | 4 +- .../functions/table_getLeftTotalSize.md | 4 +- .../table_getLeftVisibleLeafColumns.md | 4 +- .../functions/table_getPinnedLeafColumns.md | 4 +- .../table_getPinnedVisibleLeafColumns.md | 4 +- .../functions/table_getRightFooterGroups.md | 4 +- .../functions/table_getRightLeafHeaders.md | 4 +- .../functions/table_getRightTotalSize.md | 4 +- .../table_getRightVisibleLeafColumns.md | 4 +- .../functions/table_resetGlobalFilter.md | 2 +- .../functions/table_resetGrouping.md | 2 +- .../functions/table_resetHeaderSizeInfo.md | 2 +- .../functions/table_setColumnResizing.md | 2 +- .../functions/table_setGlobalFilter.md | 2 +- .../functions/table_setGrouping.md | 2 +- 380 files changed, 5338 insertions(+), 5471 deletions(-) create mode 100644 docs/framework/angular/guide/composable-tables.md delete mode 100644 docs/framework/angular/guide/table-composition.md create mode 100644 docs/framework/lit/guide/composable-tables.md create mode 100644 docs/framework/preact/guide/composable-tables.md delete mode 100644 docs/framework/preact/guide/create-table-hook.md create mode 100644 docs/framework/react/guide/composable-tables.md delete mode 100644 docs/framework/react/guide/create-table-hook.md create mode 100644 docs/framework/solid/guide/composable-tables.md create mode 100644 docs/framework/solid/reference/interfaces/AppCellProps.md delete mode 100644 docs/framework/solid/reference/interfaces/AppCellPropsWithSelector.md delete mode 100644 docs/framework/solid/reference/interfaces/AppCellPropsWithoutSelector.md create mode 100644 docs/framework/solid/reference/interfaces/AppHeaderProps.md delete mode 100644 docs/framework/solid/reference/interfaces/AppHeaderPropsWithSelector.md delete mode 100644 docs/framework/solid/reference/interfaces/AppHeaderPropsWithoutSelector.md create mode 100644 docs/framework/solid/reference/interfaces/AppTableProps.md delete mode 100644 docs/framework/solid/reference/interfaces/AppTablePropsWithSelector.md delete mode 100644 docs/framework/solid/reference/interfaces/AppTablePropsWithoutSelector.md delete mode 100644 docs/framework/solid/reference/type-aliases/SubscribeSource.md create mode 100644 docs/framework/svelte/guide/composable-tables.md create mode 100644 docs/framework/vue/guide/composable-tables.md create mode 100644 docs/framework/vue/reference/interfaces/FlexRenderCell.md create mode 100644 docs/framework/vue/reference/interfaces/FlexRenderHeader.md delete mode 100644 docs/framework/vue/reference/type-aliases/SubscribeSource.md create mode 100644 docs/reference/index/functions/aggregationFn_count.md create mode 100644 docs/reference/index/functions/aggregationFn_extent.md create mode 100644 docs/reference/index/functions/aggregationFn_max.md create mode 100644 docs/reference/index/functions/aggregationFn_mean.md create mode 100644 docs/reference/index/functions/aggregationFn_median.md create mode 100644 docs/reference/index/functions/aggregationFn_min.md create mode 100644 docs/reference/index/functions/aggregationFn_sum.md create mode 100644 docs/reference/index/functions/aggregationFn_unique.md create mode 100644 docs/reference/index/functions/aggregationFn_uniqueCount.md delete mode 100644 docs/reference/index/functions/constructColumnFacetingFeature.md delete mode 100644 docs/reference/index/functions/constructColumnFilteringFeature.md delete mode 100644 docs/reference/index/functions/constructColumnGroupingFeature.md delete mode 100644 docs/reference/index/functions/constructColumnOrderingFeature.md delete mode 100644 docs/reference/index/functions/constructColumnPinningFeature.md delete mode 100644 docs/reference/index/functions/constructColumnResizingFeature.md delete mode 100644 docs/reference/index/functions/constructColumnSizingFeature.md delete mode 100644 docs/reference/index/functions/constructColumnVisibilityFeature.md delete mode 100644 docs/reference/index/functions/constructCoreCellsFeature.md delete mode 100644 docs/reference/index/functions/constructCoreColumnsFeature.md delete mode 100644 docs/reference/index/functions/constructCoreHeadersFeature.md delete mode 100644 docs/reference/index/functions/constructCoreRowModelsFeature.md delete mode 100644 docs/reference/index/functions/constructCoreRowsFeature.md delete mode 100644 docs/reference/index/functions/constructCoreTablesFeature.md delete mode 100644 docs/reference/index/functions/constructGlobalFilteringFeature.md delete mode 100644 docs/reference/index/functions/constructRowExpandingFeature.md delete mode 100644 docs/reference/index/functions/constructRowPaginationFeature.md delete mode 100644 docs/reference/index/functions/constructRowPinningFeature.md delete mode 100644 docs/reference/index/functions/constructRowSelectionFeature.md delete mode 100644 docs/reference/index/functions/constructRowSortingFeature.md create mode 100644 docs/reference/index/functions/filterFn_arrHas.md create mode 100644 docs/reference/index/functions/sortFn_alphanumeric.md create mode 100644 docs/reference/index/functions/sortFn_alphanumericCaseSensitive.md create mode 100644 docs/reference/index/functions/sortFn_basic.md create mode 100644 docs/reference/index/functions/sortFn_datetime.md create mode 100644 docs/reference/index/functions/sortFn_text.md create mode 100644 docs/reference/index/functions/sortFn_textCaseSensitive.md delete mode 100644 docs/reference/index/interfaces/CachedRowModel_Plugins.md create mode 100644 docs/reference/index/interfaces/CachedRowModels_FeatureMap.md delete mode 100644 docs/reference/index/interfaces/CachedRowModels_Plugins.md create mode 100644 docs/reference/index/interfaces/Cell_FeatureMap.md delete mode 100644 docs/reference/index/interfaces/Cell_Plugins.md create mode 100644 docs/reference/index/interfaces/ColumnDef_FeatureMap.md delete mode 100644 docs/reference/index/interfaces/ColumnDef_Plugins.md delete mode 100644 docs/reference/index/interfaces/ColumnFacetingFeatureConstructors.md delete mode 100644 docs/reference/index/interfaces/ColumnFilteringFeatureConstructors.md delete mode 100644 docs/reference/index/interfaces/ColumnGroupingFeatureConstructors.md delete mode 100644 docs/reference/index/interfaces/ColumnOrderingFeatureConstructors.md delete mode 100644 docs/reference/index/interfaces/ColumnPinningFeatureConstructors.md delete mode 100644 docs/reference/index/interfaces/ColumnResizingFeatureConstructors.md delete mode 100644 docs/reference/index/interfaces/ColumnSizingFeatureConstructors.md delete mode 100644 docs/reference/index/interfaces/ColumnVisibilityFeatureConstructors.md create mode 100644 docs/reference/index/interfaces/Column_FeatureMap.md delete mode 100644 docs/reference/index/interfaces/Column_Plugins.md delete mode 100644 docs/reference/index/interfaces/CoreCellsFeatureConstructors.md delete mode 100644 docs/reference/index/interfaces/CoreColumnsFeatureConstructors.md delete mode 100644 docs/reference/index/interfaces/CoreHeadersFeatureConstructors.md delete mode 100644 docs/reference/index/interfaces/CoreRowModelsFeatureConstructors.md delete mode 100644 docs/reference/index/interfaces/CoreRowsFeatureConstructors.md delete mode 100644 docs/reference/index/interfaces/CoreTablesFeatureConstructors.md delete mode 100644 docs/reference/index/interfaces/CreateRowModel_Plugins.md create mode 100644 docs/reference/index/interfaces/CreateRowModels_FeatureMap.md delete mode 100644 docs/reference/index/interfaces/CreateRowModels_Plugins.md delete mode 100644 docs/reference/index/interfaces/FeatureConstructors.md delete mode 100644 docs/reference/index/interfaces/GlobalFilteringFeatureConstructors.md delete mode 100644 docs/reference/index/interfaces/HeaderGroup_Plugins.md create mode 100644 docs/reference/index/interfaces/Header_FeatureMap.md delete mode 100644 docs/reference/index/interfaces/Header_Plugins.md delete mode 100644 docs/reference/index/interfaces/RowExpandingFeatureConstructors.md create mode 100644 docs/reference/index/interfaces/RowModelFns_FeatureMap.md delete mode 100644 docs/reference/index/interfaces/RowModelFns_Plugins.md delete mode 100644 docs/reference/index/interfaces/RowPaginationFeatureConstructors.md delete mode 100644 docs/reference/index/interfaces/RowPinningFeatureConstructors.md delete mode 100644 docs/reference/index/interfaces/RowSelectionFeatureConstructors.md delete mode 100644 docs/reference/index/interfaces/RowSortingFeatureConstructors.md create mode 100644 docs/reference/index/interfaces/Row_FeatureMap.md delete mode 100644 docs/reference/index/interfaces/Row_Plugins.md create mode 100644 docs/reference/index/interfaces/TableOptions_FeatureMap.md delete mode 100644 docs/reference/index/interfaces/TableOptions_Plugins.md create mode 100644 docs/reference/index/interfaces/TableState_FeatureMap.md delete mode 100644 docs/reference/index/interfaces/TableState_Plugins.md create mode 100644 docs/reference/index/interfaces/Table_FeatureMap.md delete mode 100644 docs/reference/index/interfaces/Table_Plugins.md delete mode 100644 docs/reference/index/namespaces/filterFn_arrIncludes/functions/autoRemove.md delete mode 100644 docs/reference/index/namespaces/filterFn_arrIncludes/index.md delete mode 100644 docs/reference/index/namespaces/filterFn_arrIncludesAll/functions/autoRemove.md delete mode 100644 docs/reference/index/namespaces/filterFn_arrIncludesAll/index.md delete mode 100644 docs/reference/index/namespaces/filterFn_arrIncludesSome/functions/autoRemove.md delete mode 100644 docs/reference/index/namespaces/filterFn_arrIncludesSome/index.md delete mode 100644 docs/reference/index/namespaces/filterFn_equals/functions/autoRemove.md delete mode 100644 docs/reference/index/namespaces/filterFn_equals/index.md delete mode 100644 docs/reference/index/namespaces/filterFn_equalsString/functions/autoRemove.md delete mode 100644 docs/reference/index/namespaces/filterFn_equalsString/index.md delete mode 100644 docs/reference/index/namespaces/filterFn_equalsStringSensitive/functions/autoRemove.md delete mode 100644 docs/reference/index/namespaces/filterFn_equalsStringSensitive/index.md delete mode 100644 docs/reference/index/namespaces/filterFn_greaterThan/functions/resolveFilterValue.md delete mode 100644 docs/reference/index/namespaces/filterFn_greaterThan/index.md delete mode 100644 docs/reference/index/namespaces/filterFn_greaterThanOrEqualTo/functions/resolveFilterValue.md delete mode 100644 docs/reference/index/namespaces/filterFn_greaterThanOrEqualTo/index.md delete mode 100644 docs/reference/index/namespaces/filterFn_inNumberRange/functions/autoRemove.md delete mode 100644 docs/reference/index/namespaces/filterFn_inNumberRange/functions/resolveFilterValue.md delete mode 100644 docs/reference/index/namespaces/filterFn_inNumberRange/index.md delete mode 100644 docs/reference/index/namespaces/filterFn_includesString/functions/autoRemove.md delete mode 100644 docs/reference/index/namespaces/filterFn_includesString/index.md delete mode 100644 docs/reference/index/namespaces/filterFn_includesStringSensitive/functions/autoRemove.md delete mode 100644 docs/reference/index/namespaces/filterFn_includesStringSensitive/index.md delete mode 100644 docs/reference/index/namespaces/filterFn_lessThan/functions/resolveFilterValue.md delete mode 100644 docs/reference/index/namespaces/filterFn_lessThan/index.md delete mode 100644 docs/reference/index/namespaces/filterFn_lessThanOrEqualTo/functions/resolveFilterValue.md delete mode 100644 docs/reference/index/namespaces/filterFn_lessThanOrEqualTo/index.md delete mode 100644 docs/reference/index/namespaces/filterFn_weakEquals/functions/autoRemove.md delete mode 100644 docs/reference/index/namespaces/filterFn_weakEquals/index.md delete mode 100644 docs/reference/index/type-aliases/AssignCellPrototype.md delete mode 100644 docs/reference/index/type-aliases/AssignColumnPrototype.md delete mode 100644 docs/reference/index/type-aliases/AssignHeaderPrototype.md delete mode 100644 docs/reference/index/type-aliases/AssignRowPrototype.md delete mode 100644 docs/reference/index/type-aliases/ConstructTableAPIs.md create mode 100644 docs/reference/index/type-aliases/ExtractFeatureMapTypes.md delete mode 100644 docs/reference/index/type-aliases/ExtractFeatureTypes.md delete mode 100644 docs/reference/index/type-aliases/GetDefaultColumnDef.md delete mode 100644 docs/reference/index/type-aliases/GetDefaultStateSelector.md delete mode 100644 docs/reference/index/type-aliases/GetDefaultTableOptions.md delete mode 100644 docs/reference/index/type-aliases/GetInitialState.md delete mode 100644 docs/reference/index/type-aliases/InitRowInstanceData.md create mode 100644 docs/reference/index/type-aliases/TableOptions_FeatureMap_All.md delete mode 100644 docs/reference/index/variables/aggregationFn_count.md delete mode 100644 docs/reference/index/variables/aggregationFn_extent.md delete mode 100644 docs/reference/index/variables/aggregationFn_max.md delete mode 100644 docs/reference/index/variables/aggregationFn_mean.md delete mode 100644 docs/reference/index/variables/aggregationFn_median.md delete mode 100644 docs/reference/index/variables/aggregationFn_min.md delete mode 100644 docs/reference/index/variables/aggregationFn_sum.md delete mode 100644 docs/reference/index/variables/aggregationFn_unique.md delete mode 100644 docs/reference/index/variables/aggregationFn_uniqueCount.md delete mode 100644 docs/reference/index/variables/filterFn_arrHas.md delete mode 100644 docs/reference/index/variables/sortFn_alphanumeric.md delete mode 100644 docs/reference/index/variables/sortFn_alphanumericCaseSensitive.md delete mode 100644 docs/reference/index/variables/sortFn_basic.md delete mode 100644 docs/reference/index/variables/sortFn_datetime.md delete mode 100644 docs/reference/index/variables/sortFn_text.md delete mode 100644 docs/reference/index/variables/sortFn_textCaseSensitive.md diff --git a/docs/config.json b/docs/config.json index 1376674224..ab3493dece 100644 --- a/docs/config.json +++ b/docs/config.json @@ -21,8 +21,7 @@ "children": [ { "label": "Angular Table Adapter", "to": "framework/angular/angular-table" }, { "label": "Migrating to V9", "to": "framework/angular/guide/migrating" }, - { "label": "Rendering components", "to": "framework/angular/guide/rendering" }, - { "label": "Table composition", "to": "framework/angular/guide/table-composition" } + { "label": "Rendering components", "to": "framework/angular/guide/rendering" } ] }, { @@ -35,7 +34,6 @@ "label": "react", "children": [ { "label": "React Table Adapter", "to": "framework/react/react-table" }, - { "label": "createTableHook Guide", "to": "framework/react/guide/create-table-hook" }, { "label": "Migrating to V9", "to": "framework/react/guide/migrating" }, { "label": "useLegacyTable Guide", "to": "framework/react/guide/use-legacy-table" } ] @@ -43,8 +41,7 @@ { "label": "preact", "children": [ - { "label": "Preact Table Adapter", "to": "framework/preact/preact-table" }, - { "label": "createTableHook Guide", "to": "framework/preact/guide/create-table-hook" } + { "label": "Preact Table Adapter", "to": "framework/preact/preact-table" } ] }, { @@ -90,43 +87,50 @@ { "label": "angular", "children": [ - { "label": "Table State", "to": "framework/angular/guide/table-state" } + { "label": "Table State", "to": "framework/angular/guide/table-state" }, + { "label": "Composable Tables", "to": "framework/angular/guide/composable-tables" } ] }, { "label": "lit", "children": [ - { "label": "Table State", "to": "framework/lit/guide/table-state" } + { "label": "Table State", "to": "framework/lit/guide/table-state" }, + { "label": "Composable Tables", "to": "framework/lit/guide/composable-tables" } ] }, { "label": "react", "children": [ - { "label": "Table State", "to": "framework/react/guide/table-state" } + { "label": "Table State", "to": "framework/react/guide/table-state" }, + { "label": "Composable Tables", "to": "framework/react/guide/composable-tables" } ] }, { "label": "preact", "children": [ - { "label": "Table State", "to": "framework/preact/guide/table-state" } + { "label": "Table State", "to": "framework/preact/guide/table-state" }, + { "label": "Composable Tables", "to": "framework/preact/guide/composable-tables" } ] }, { "label": "solid", "children": [ - { "label": "Table State", "to": "framework/solid/guide/table-state" } + { "label": "Table State", "to": "framework/solid/guide/table-state" }, + { "label": "Composable Tables", "to": "framework/solid/guide/composable-tables" } ] }, { "label": "svelte", "children": [ - { "label": "Table State", "to": "framework/svelte/guide/table-state" } + { "label": "Table State", "to": "framework/svelte/guide/table-state" }, + { "label": "Composable Tables", "to": "framework/svelte/guide/composable-tables" } ] }, { "label": "vue", "children": [ - { "label": "Table State", "to": "framework/vue/guide/table-state" } + { "label": "Table State", "to": "framework/vue/guide/table-state" }, + { "label": "Composable Tables", "to": "framework/vue/guide/composable-tables" } ] }, { @@ -244,11 +248,8 @@ { "label": "AppReactTable", "to": "framework/react/reference/index/type-aliases/AppReactTable" }, { "label": "CreateTableHookOptions", "to": "framework/react/reference/index/type-aliases/CreateTableHookOptions" }, { "label": "Subscribe", "to": "framework/react/reference/index/functions/Subscribe" }, - { "label": "SubscribeProps", "to": "framework/react/reference/index/type-aliases/SubscribeProps" }, { "label": "FlexRender", "to": "framework/react/reference/index/functions/FlexRender-1" }, - { "label": "flexRender", "to": "framework/react/reference/index/functions/flexRender" }, - { "label": "FlexRenderProps", "to": "framework/react/reference/index/type-aliases/FlexRenderProps" }, - { "label": "Renderable", "to": "framework/react/reference/index/type-aliases/Renderable" } + { "label": "flexRender", "to": "framework/react/reference/index/functions/flexRender" } ] }, { @@ -261,17 +262,9 @@ { "label": "CreateTableHookResult", "to": "framework/angular/reference/type-aliases/CreateTableHookResult" }, { "label": "CreateTableContextOptions", "to": "framework/angular/reference/type-aliases/CreateTableContextOptions" }, { "label": "flexRenderComponent", "to": "framework/angular/reference/functions/flexRenderComponent" }, - { "label": "FlexRenderComponent", "to": "framework/angular/reference/interfaces/FlexRenderComponent" }, - { "label": "FlexRenderContent", "to": "framework/angular/reference/type-aliases/FlexRenderContent" }, - { "label": "FlexRenderInputContent", "to": "framework/angular/reference/type-aliases/FlexRenderInputContent" }, - { "label": "FlexRenderComponentProps", "to": "framework/angular/reference/type-aliases/FlexRenderComponentProps" }, { "label": "FlexRender", "to": "framework/angular/reference/variables/FlexRender" }, - { "label": "FlexRenderDirective", "to": "framework/angular/reference/classes/FlexRenderDirective" }, - { "label": "FlexRenderCell", "to": "framework/angular/reference/classes/FlexRenderCell" }, { "label": "TanStackTable", "to": "framework/angular/reference/classes/TanStackTable" }, - { "label": "TanStackTableToken", "to": "framework/angular/reference/variables/TanStackTableToken" }, - { "label": "injectTableContext", "to": "framework/angular/reference/functions/injectTableContext" }, - { "label": "AngularTableComputed", "to": "framework/angular/reference/interfaces/AngularTableComputed" } + { "label": "injectTableContext", "to": "framework/angular/reference/functions/injectTableContext" } ] }, { @@ -283,7 +276,6 @@ { "label": "AppPreactTable", "to": "framework/preact/reference/type-aliases/AppPreactTable" }, { "label": "CreateTableHookOptions", "to": "framework/preact/reference/type-aliases/CreateTableHookOptions" }, { "label": "Subscribe", "to": "framework/preact/reference/functions/Subscribe" }, - { "label": "SubscribeProps", "to": "framework/preact/reference/type-aliases/SubscribeProps" }, { "label": "FlexRender", "to": "framework/preact/reference/functions/FlexRender-1" }, { "label": "flexRender", "to": "framework/preact/reference/functions/flexRender" } ] @@ -570,20 +562,6 @@ { "label": "filterFns", "to": "reference/index/variables/filterFns" }, { "label": "sortFns", "to": "reference/index/variables/sortFns" }, { "label": "aggregationFns", "to": "reference/index/variables/aggregationFns" }, - { "label": "constructColumnFilteringFeature", "to": "reference/index/functions/constructColumnFilteringFeature" }, - { "label": "constructColumnFacetingFeature", "to": "reference/index/functions/constructColumnFacetingFeature" }, - { "label": "constructColumnGroupingFeature", "to": "reference/index/functions/constructColumnGroupingFeature" }, - { "label": "constructColumnOrderingFeature", "to": "reference/index/functions/constructColumnOrderingFeature" }, - { "label": "constructColumnPinningFeature", "to": "reference/index/functions/constructColumnPinningFeature" }, - { "label": "constructColumnResizingFeature", "to": "reference/index/functions/constructColumnResizingFeature" }, - { "label": "constructColumnSizingFeature", "to": "reference/index/functions/constructColumnSizingFeature" }, - { "label": "constructColumnVisibilityFeature", "to": "reference/index/functions/constructColumnVisibilityFeature" }, - { "label": "constructGlobalFilteringFeature", "to": "reference/index/functions/constructGlobalFilteringFeature" }, - { "label": "constructRowExpandingFeature", "to": "reference/index/functions/constructRowExpandingFeature" }, - { "label": "constructRowPaginationFeature", "to": "reference/index/functions/constructRowPaginationFeature" }, - { "label": "constructRowPinningFeature", "to": "reference/index/functions/constructRowPinningFeature" }, - { "label": "constructRowSelectionFeature", "to": "reference/index/functions/constructRowSelectionFeature" }, - { "label": "constructRowSortingFeature", "to": "reference/index/functions/constructRowSortingFeature" }, { "label": "ColumnFilter", "to": "reference/index/interfaces/ColumnFilter" }, { "label": "ColumnPinningState", "to": "reference/index/interfaces/ColumnPinningState" }, { "label": "ColumnSort", "to": "reference/index/interfaces/ColumnSort" }, @@ -615,37 +593,7 @@ { "label": "SortFnOption", "to": "reference/index/type-aliases/SortFnOption" }, { "label": "BuiltInAggregationFn", "to": "reference/index/type-aliases/BuiltInAggregationFn" }, { "label": "BuiltInFilterFn", "to": "reference/index/type-aliases/BuiltInFilterFn" }, - { "label": "BuiltInSortFn", "to": "reference/index/type-aliases/BuiltInSortFn" }, - { "label": "filterFn_arrHas", "to": "reference/index/variables/filterFn_arrHas" }, - { "label": "filterFn_arrIncludes", "to": "reference/index/variables/filterFn_arrIncludes" }, - { "label": "filterFn_arrIncludesAll", "to": "reference/index/variables/filterFn_arrIncludesAll" }, - { "label": "filterFn_arrIncludesSome", "to": "reference/index/variables/filterFn_arrIncludesSome" }, - { "label": "filterFn_equals", "to": "reference/index/variables/filterFn_equals" }, - { "label": "filterFn_equalsString", "to": "reference/index/variables/filterFn_equalsString" }, - { "label": "filterFn_equalsStringSensitive", "to": "reference/index/variables/filterFn_equalsStringSensitive" }, - { "label": "filterFn_greaterThan", "to": "reference/index/variables/filterFn_greaterThan" }, - { "label": "filterFn_greaterThanOrEqualTo", "to": "reference/index/variables/filterFn_greaterThanOrEqualTo" }, - { "label": "filterFn_inNumberRange", "to": "reference/index/variables/filterFn_inNumberRange" }, - { "label": "filterFn_includesString", "to": "reference/index/variables/filterFn_includesString" }, - { "label": "filterFn_includesStringSensitive", "to": "reference/index/variables/filterFn_includesStringSensitive" }, - { "label": "filterFn_lessThan", "to": "reference/index/variables/filterFn_lessThan" }, - { "label": "filterFn_lessThanOrEqualTo", "to": "reference/index/variables/filterFn_lessThanOrEqualTo" }, - { "label": "filterFn_weakEquals", "to": "reference/index/variables/filterFn_weakEquals" }, - { "label": "sortFn_alphanumeric", "to": "reference/index/variables/sortFn_alphanumeric" }, - { "label": "sortFn_alphanumericCaseSensitive", "to": "reference/index/variables/sortFn_alphanumericCaseSensitive" }, - { "label": "sortFn_basic", "to": "reference/index/variables/sortFn_basic" }, - { "label": "sortFn_datetime", "to": "reference/index/variables/sortFn_datetime" }, - { "label": "sortFn_text", "to": "reference/index/variables/sortFn_text" }, - { "label": "sortFn_textCaseSensitive", "to": "reference/index/variables/sortFn_textCaseSensitive" }, - { "label": "aggregationFn_count", "to": "reference/index/variables/aggregationFn_count" }, - { "label": "aggregationFn_extent", "to": "reference/index/variables/aggregationFn_extent" }, - { "label": "aggregationFn_max", "to": "reference/index/variables/aggregationFn_max" }, - { "label": "aggregationFn_mean", "to": "reference/index/variables/aggregationFn_mean" }, - { "label": "aggregationFn_median", "to": "reference/index/variables/aggregationFn_median" }, - { "label": "aggregationFn_min", "to": "reference/index/variables/aggregationFn_min" }, - { "label": "aggregationFn_sum", "to": "reference/index/variables/aggregationFn_sum" }, - { "label": "aggregationFn_unique", "to": "reference/index/variables/aggregationFn_unique" }, - { "label": "aggregationFn_uniqueCount", "to": "reference/index/variables/aggregationFn_uniqueCount" } + { "label": "BuiltInSortFn", "to": "reference/index/type-aliases/BuiltInSortFn" } ] }, { @@ -653,245 +601,7 @@ "defaultCollapsed": true, "label": "Static Functions API Reference", "children": [ - { "label": "cell_getContext", "to": "reference/static-functions/functions/cell_getContext" }, - { "label": "cell_getIsAggregated", "to": "reference/static-functions/functions/cell_getIsAggregated" }, - { "label": "cell_getIsGrouped", "to": "reference/static-functions/functions/cell_getIsGrouped" }, - { "label": "cell_getIsPlaceholder", "to": "reference/static-functions/functions/cell_getIsPlaceholder" }, - { "label": "cell_getValue", "to": "reference/static-functions/functions/cell_getValue" }, - { "label": "cell_renderValue", "to": "reference/static-functions/functions/cell_renderValue" }, - { "label": "column_clearSorting", "to": "reference/static-functions/functions/column_clearSorting" }, - { "label": "column_getAfter", "to": "reference/static-functions/functions/column_getAfter" }, - { "label": "column_getAggregationFn", "to": "reference/static-functions/functions/column_getAggregationFn" }, - { "label": "column_getAutoAggregationFn", "to": "reference/static-functions/functions/column_getAutoAggregationFn" }, - { "label": "column_getAutoFilterFn", "to": "reference/static-functions/functions/column_getAutoFilterFn" }, - { "label": "column_getAutoSortDir", "to": "reference/static-functions/functions/column_getAutoSortDir" }, - { "label": "column_getAutoSortFn", "to": "reference/static-functions/functions/column_getAutoSortFn" }, - { "label": "column_getCanFilter", "to": "reference/static-functions/functions/column_getCanFilter" }, - { "label": "column_getCanGlobalFilter", "to": "reference/static-functions/functions/column_getCanGlobalFilter" }, - { "label": "column_getCanGroup", "to": "reference/static-functions/functions/column_getCanGroup" }, - { "label": "column_getCanHide", "to": "reference/static-functions/functions/column_getCanHide" }, - { "label": "column_getCanMultiSort", "to": "reference/static-functions/functions/column_getCanMultiSort" }, - { "label": "column_getCanPin", "to": "reference/static-functions/functions/column_getCanPin" }, - { "label": "column_getCanResize", "to": "reference/static-functions/functions/column_getCanResize" }, - { "label": "column_getCanSort", "to": "reference/static-functions/functions/column_getCanSort" }, - { "label": "column_getFacetedMinMaxValues", "to": "reference/static-functions/functions/column_getFacetedMinMaxValues" }, - { "label": "column_getFacetedRowModel", "to": "reference/static-functions/functions/column_getFacetedRowModel" }, - { "label": "column_getFacetedUniqueValues", "to": "reference/static-functions/functions/column_getFacetedUniqueValues" }, - { "label": "column_getFilterFn", "to": "reference/static-functions/functions/column_getFilterFn" }, - { "label": "column_getFilterIndex", "to": "reference/static-functions/functions/column_getFilterIndex" }, - { "label": "column_getFilterValue", "to": "reference/static-functions/functions/column_getFilterValue" }, - { "label": "column_getFirstSortDir", "to": "reference/static-functions/functions/column_getFirstSortDir" }, - { "label": "column_getFlatColumns", "to": "reference/static-functions/functions/column_getFlatColumns" }, - { "label": "column_getGroupedIndex", "to": "reference/static-functions/functions/column_getGroupedIndex" }, - { "label": "column_getIndex", "to": "reference/static-functions/functions/column_getIndex" }, - { "label": "column_getIsFiltered", "to": "reference/static-functions/functions/column_getIsFiltered" }, - { "label": "column_getIsFirstColumn", "to": "reference/static-functions/functions/column_getIsFirstColumn" }, - { "label": "column_getIsGrouped", "to": "reference/static-functions/functions/column_getIsGrouped" }, - { "label": "column_getIsLastColumn", "to": "reference/static-functions/functions/column_getIsLastColumn" }, - { "label": "column_getIsPinned", "to": "reference/static-functions/functions/column_getIsPinned" }, - { "label": "column_getIsResizing", "to": "reference/static-functions/functions/column_getIsResizing" }, - { "label": "column_getIsSorted", "to": "reference/static-functions/functions/column_getIsSorted" }, - { "label": "column_getIsVisible", "to": "reference/static-functions/functions/column_getIsVisible" }, - { "label": "column_getLeafColumns", "to": "reference/static-functions/functions/column_getLeafColumns" }, - { "label": "column_getNextSortingOrder", "to": "reference/static-functions/functions/column_getNextSortingOrder" }, - { "label": "column_getPinnedIndex", "to": "reference/static-functions/functions/column_getPinnedIndex" }, - { "label": "column_getSize", "to": "reference/static-functions/functions/column_getSize" }, - { "label": "column_getSortFn", "to": "reference/static-functions/functions/column_getSortFn" }, - { "label": "column_getSortIndex", "to": "reference/static-functions/functions/column_getSortIndex" }, - { "label": "column_getStart", "to": "reference/static-functions/functions/column_getStart" }, - { "label": "column_getToggleGroupingHandler", "to": "reference/static-functions/functions/column_getToggleGroupingHandler" }, - { "label": "column_getToggleSortingHandler", "to": "reference/static-functions/functions/column_getToggleSortingHandler" }, - { "label": "column_getToggleVisibilityHandler", "to": "reference/static-functions/functions/column_getToggleVisibilityHandler" }, - { "label": "column_pin", "to": "reference/static-functions/functions/column_pin" }, - { "label": "column_resetSize", "to": "reference/static-functions/functions/column_resetSize" }, - { "label": "column_setFilterValue", "to": "reference/static-functions/functions/column_setFilterValue" }, - { "label": "column_toggleGrouping", "to": "reference/static-functions/functions/column_toggleGrouping" }, - { "label": "column_toggleSorting", "to": "reference/static-functions/functions/column_toggleSorting" }, - { "label": "column_toggleVisibility", "to": "reference/static-functions/functions/column_toggleVisibility" }, - { "label": "getDefaultColumnFiltersState", "to": "reference/static-functions/functions/getDefaultColumnFiltersState" }, - { "label": "getDefaultColumnOrderState", "to": "reference/static-functions/functions/getDefaultColumnOrderState" }, - { "label": "getDefaultColumnPinningState", "to": "reference/static-functions/functions/getDefaultColumnPinningState" }, - { "label": "getDefaultColumnResizingState", "to": "reference/static-functions/functions/getDefaultColumnResizingState" }, - { "label": "getDefaultColumnSizingColumnDef", "to": "reference/static-functions/functions/getDefaultColumnSizingColumnDef" }, - { "label": "getDefaultColumnSizingState", "to": "reference/static-functions/functions/getDefaultColumnSizingState" }, - { "label": "getDefaultColumnVisibilityState", "to": "reference/static-functions/functions/getDefaultColumnVisibilityState" }, - { "label": "getDefaultExpandedState", "to": "reference/static-functions/functions/getDefaultExpandedState" }, - { "label": "getDefaultGroupingState", "to": "reference/static-functions/functions/getDefaultGroupingState" }, - { "label": "getDefaultPaginationState", "to": "reference/static-functions/functions/getDefaultPaginationState" }, - { "label": "getDefaultRowPinningState", "to": "reference/static-functions/functions/getDefaultRowPinningState" }, - { "label": "getDefaultRowSelectionState", "to": "reference/static-functions/functions/getDefaultRowSelectionState" }, - { "label": "getDefaultSortingState", "to": "reference/static-functions/functions/getDefaultSortingState" }, - { "label": "header_getContext", "to": "reference/static-functions/functions/header_getContext" }, - { "label": "header_getLeafHeaders", "to": "reference/static-functions/functions/header_getLeafHeaders" }, - { "label": "header_getResizeHandler", "to": "reference/static-functions/functions/header_getResizeHandler" }, - { "label": "header_getSize", "to": "reference/static-functions/functions/header_getSize" }, - { "label": "header_getStart", "to": "reference/static-functions/functions/header_getStart" }, - { "label": "isRowSelected", "to": "reference/static-functions/functions/isRowSelected" }, - { "label": "isSubRowSelected", "to": "reference/static-functions/functions/isSubRowSelected" }, - { "label": "isTouchStartEvent", "to": "reference/static-functions/functions/isTouchStartEvent" }, - { "label": "orderColumns", "to": "reference/static-functions/functions/orderColumns" }, - { "label": "passiveEventSupported", "to": "reference/static-functions/functions/passiveEventSupported" }, - { "label": "row_getAllCells", "to": "reference/static-functions/functions/row_getAllCells" }, - { "label": "row_getAllCellsByColumnId", "to": "reference/static-functions/functions/row_getAllCellsByColumnId" }, - { "label": "row_getCanExpand", "to": "reference/static-functions/functions/row_getCanExpand" }, - { "label": "row_getCanMultiSelect", "to": "reference/static-functions/functions/row_getCanMultiSelect" }, - { "label": "row_getCanPin", "to": "reference/static-functions/functions/row_getCanPin" }, - { "label": "row_getCanSelect", "to": "reference/static-functions/functions/row_getCanSelect" }, - { "label": "row_getCanSelectSubRows", "to": "reference/static-functions/functions/row_getCanSelectSubRows" }, - { "label": "row_getCenterVisibleCells", "to": "reference/static-functions/functions/row_getCenterVisibleCells" }, - { "label": "row_getGroupingValue", "to": "reference/static-functions/functions/row_getGroupingValue" }, - { "label": "row_getIsAllParentsExpanded", "to": "reference/static-functions/functions/row_getIsAllParentsExpanded" }, - { "label": "row_getIsAllSubRowsSelected", "to": "reference/static-functions/functions/row_getIsAllSubRowsSelected" }, - { "label": "row_getIsExpanded", "to": "reference/static-functions/functions/row_getIsExpanded" }, - { "label": "row_getIsGrouped", "to": "reference/static-functions/functions/row_getIsGrouped" }, - { "label": "row_getIsPinned", "to": "reference/static-functions/functions/row_getIsPinned" }, - { "label": "row_getIsSelected", "to": "reference/static-functions/functions/row_getIsSelected" }, - { "label": "row_getIsSomeSelected", "to": "reference/static-functions/functions/row_getIsSomeSelected" }, - { "label": "row_getLeafRows", "to": "reference/static-functions/functions/row_getLeafRows" }, - { "label": "row_getLeftVisibleCells", "to": "reference/static-functions/functions/row_getLeftVisibleCells" }, - { "label": "row_getParentRow", "to": "reference/static-functions/functions/row_getParentRow" }, - { "label": "row_getParentRows", "to": "reference/static-functions/functions/row_getParentRows" }, - { "label": "row_getPinnedIndex", "to": "reference/static-functions/functions/row_getPinnedIndex" }, - { "label": "row_getRightVisibleCells", "to": "reference/static-functions/functions/row_getRightVisibleCells" }, - { "label": "row_getToggleExpandedHandler", "to": "reference/static-functions/functions/row_getToggleExpandedHandler" }, - { "label": "row_getToggleSelectedHandler", "to": "reference/static-functions/functions/row_getToggleSelectedHandler" }, - { "label": "row_getUniqueValues", "to": "reference/static-functions/functions/row_getUniqueValues" }, - { "label": "row_getValue", "to": "reference/static-functions/functions/row_getValue" }, - { "label": "row_getVisibleCells", "to": "reference/static-functions/functions/row_getVisibleCells" }, - { "label": "row_pin", "to": "reference/static-functions/functions/row_pin" }, - { "label": "row_renderValue", "to": "reference/static-functions/functions/row_renderValue" }, - { "label": "row_toggleExpanded", "to": "reference/static-functions/functions/row_toggleExpanded" }, - { "label": "row_toggleSelected", "to": "reference/static-functions/functions/row_toggleSelected" }, - { "label": "selectRowsFn", "to": "reference/static-functions/functions/selectRowsFn" }, - { "label": "shouldAutoRemoveFilter", "to": "reference/static-functions/functions/shouldAutoRemoveFilter" }, - { "label": "table_autoResetExpanded", "to": "reference/static-functions/functions/table_autoResetExpanded" }, - { "label": "table_autoResetPageIndex", "to": "reference/static-functions/functions/table_autoResetPageIndex" }, - { "label": "table_firstPage", "to": "reference/static-functions/functions/table_firstPage" }, - { "label": "table_getAllColumns", "to": "reference/static-functions/functions/table_getAllColumns" }, - { "label": "table_getAllFlatColumns", "to": "reference/static-functions/functions/table_getAllFlatColumns" }, - { "label": "table_getAllFlatColumnsById", "to": "reference/static-functions/functions/table_getAllFlatColumnsById" }, - { "label": "table_getAllLeafColumns", "to": "reference/static-functions/functions/table_getAllLeafColumns" }, - { "label": "table_getBottomRows", "to": "reference/static-functions/functions/table_getBottomRows" }, - { "label": "table_getCanNextPage", "to": "reference/static-functions/functions/table_getCanNextPage" }, - { "label": "table_getCanPreviousPage", "to": "reference/static-functions/functions/table_getCanPreviousPage" }, - { "label": "table_getCanSomeRowsExpand", "to": "reference/static-functions/functions/table_getCanSomeRowsExpand" }, - { "label": "table_getCenterFlatHeaders", "to": "reference/static-functions/functions/table_getCenterFlatHeaders" }, - { "label": "table_getCenterFooterGroups", "to": "reference/static-functions/functions/table_getCenterFooterGroups" }, - { "label": "table_getCenterHeaderGroups", "to": "reference/static-functions/functions/table_getCenterHeaderGroups" }, - { "label": "table_getCenterLeafColumns", "to": "reference/static-functions/functions/table_getCenterLeafColumns" }, - { "label": "table_getCenterLeafHeaders", "to": "reference/static-functions/functions/table_getCenterLeafHeaders" }, - { "label": "table_getCenterRows", "to": "reference/static-functions/functions/table_getCenterRows" }, - { "label": "table_getCenterTotalSize", "to": "reference/static-functions/functions/table_getCenterTotalSize" }, - { "label": "table_getCenterVisibleLeafColumns", "to": "reference/static-functions/functions/table_getCenterVisibleLeafColumns" }, - { "label": "table_getColumn", "to": "reference/static-functions/functions/table_getColumn" }, - { "label": "table_getCoreRowModel", "to": "reference/static-functions/functions/table_getCoreRowModel" }, - { "label": "table_getDefaultColumnDef", "to": "reference/static-functions/functions/table_getDefaultColumnDef" }, - { "label": "table_getExpandedDepth", "to": "reference/static-functions/functions/table_getExpandedDepth" }, - { "label": "table_getExpandedRowModel", "to": "reference/static-functions/functions/table_getExpandedRowModel" }, - { "label": "table_getFilteredRowModel", "to": "reference/static-functions/functions/table_getFilteredRowModel" }, - { "label": "table_getFilteredSelectedRowModel", "to": "reference/static-functions/functions/table_getFilteredSelectedRowModel" }, - { "label": "table_getFlatHeaders", "to": "reference/static-functions/functions/table_getFlatHeaders" }, - { "label": "table_getFooterGroups", "to": "reference/static-functions/functions/table_getFooterGroups" }, - { "label": "table_getGlobalAutoFilterFn", "to": "reference/static-functions/functions/table_getGlobalAutoFilterFn" }, - { "label": "table_getGlobalFacetedMinMaxValues", "to": "reference/static-functions/functions/table_getGlobalFacetedMinMaxValues" }, - { "label": "table_getGlobalFacetedRowModel", "to": "reference/static-functions/functions/table_getGlobalFacetedRowModel" }, - { "label": "table_getGlobalFacetedUniqueValues", "to": "reference/static-functions/functions/table_getGlobalFacetedUniqueValues" }, - { "label": "table_getGlobalFilterFn", "to": "reference/static-functions/functions/table_getGlobalFilterFn" }, - { "label": "table_getGroupedRowModel", "to": "reference/static-functions/functions/table_getGroupedRowModel" }, - { "label": "table_getGroupedSelectedRowModel", "to": "reference/static-functions/functions/table_getGroupedSelectedRowModel" }, - { "label": "table_getHeaderGroups", "to": "reference/static-functions/functions/table_getHeaderGroups" }, - { "label": "table_getIsAllColumnsVisible", "to": "reference/static-functions/functions/table_getIsAllColumnsVisible" }, - { "label": "table_getIsAllPageRowsSelected", "to": "reference/static-functions/functions/table_getIsAllPageRowsSelected" }, - { "label": "table_getIsAllRowsExpanded", "to": "reference/static-functions/functions/table_getIsAllRowsExpanded" }, - { "label": "table_getIsAllRowsSelected", "to": "reference/static-functions/functions/table_getIsAllRowsSelected" }, - { "label": "table_getIsSomeColumnsPinned", "to": "reference/static-functions/functions/table_getIsSomeColumnsPinned" }, - { "label": "table_getIsSomeColumnsVisible", "to": "reference/static-functions/functions/table_getIsSomeColumnsVisible" }, - { "label": "table_getIsSomePageRowsSelected", "to": "reference/static-functions/functions/table_getIsSomePageRowsSelected" }, - { "label": "table_getIsSomeRowsExpanded", "to": "reference/static-functions/functions/table_getIsSomeRowsExpanded" }, - { "label": "table_getIsSomeRowsPinned", "to": "reference/static-functions/functions/table_getIsSomeRowsPinned" }, - { "label": "table_getIsSomeRowsSelected", "to": "reference/static-functions/functions/table_getIsSomeRowsSelected" }, - { "label": "table_getLeafHeaders", "to": "reference/static-functions/functions/table_getLeafHeaders" }, - { "label": "table_getLeftFlatHeaders", "to": "reference/static-functions/functions/table_getLeftFlatHeaders" }, - { "label": "table_getLeftFooterGroups", "to": "reference/static-functions/functions/table_getLeftFooterGroups" }, - { "label": "table_getLeftHeaderGroups", "to": "reference/static-functions/functions/table_getLeftHeaderGroups" }, - { "label": "table_getLeftLeafColumns", "to": "reference/static-functions/functions/table_getLeftLeafColumns" }, - { "label": "table_getLeftLeafHeaders", "to": "reference/static-functions/functions/table_getLeftLeafHeaders" }, - { "label": "table_getLeftTotalSize", "to": "reference/static-functions/functions/table_getLeftTotalSize" }, - { "label": "table_getLeftVisibleLeafColumns", "to": "reference/static-functions/functions/table_getLeftVisibleLeafColumns" }, - { "label": "table_getOrderColumnsFn", "to": "reference/static-functions/functions/table_getOrderColumnsFn" }, - { "label": "table_getPageCount", "to": "reference/static-functions/functions/table_getPageCount" }, - { "label": "table_getPageOptions", "to": "reference/static-functions/functions/table_getPageOptions" }, - { "label": "table_getPaginatedRowModel", "to": "reference/static-functions/functions/table_getPaginatedRowModel" }, - { "label": "table_getPinnedLeafColumns", "to": "reference/static-functions/functions/table_getPinnedLeafColumns" }, - { "label": "table_getPinnedVisibleLeafColumns", "to": "reference/static-functions/functions/table_getPinnedVisibleLeafColumns" }, - { "label": "table_getPreExpandedRowModel", "to": "reference/static-functions/functions/table_getPreExpandedRowModel" }, - { "label": "table_getPreFilteredRowModel", "to": "reference/static-functions/functions/table_getPreFilteredRowModel" }, - { "label": "table_getPreGroupedRowModel", "to": "reference/static-functions/functions/table_getPreGroupedRowModel" }, - { "label": "table_getPrePaginatedRowModel", "to": "reference/static-functions/functions/table_getPrePaginatedRowModel" }, - { "label": "table_getPreSelectedRowModel", "to": "reference/static-functions/functions/table_getPreSelectedRowModel" }, - { "label": "table_getPreSortedRowModel", "to": "reference/static-functions/functions/table_getPreSortedRowModel" }, - { "label": "table_getRightFlatHeaders", "to": "reference/static-functions/functions/table_getRightFlatHeaders" }, - { "label": "table_getRightFooterGroups", "to": "reference/static-functions/functions/table_getRightFooterGroups" }, - { "label": "table_getRightHeaderGroups", "to": "reference/static-functions/functions/table_getRightHeaderGroups" }, - { "label": "table_getRightLeafColumns", "to": "reference/static-functions/functions/table_getRightLeafColumns" }, - { "label": "table_getRightLeafHeaders", "to": "reference/static-functions/functions/table_getRightLeafHeaders" }, - { "label": "table_getRightTotalSize", "to": "reference/static-functions/functions/table_getRightTotalSize" }, - { "label": "table_getRightVisibleLeafColumns", "to": "reference/static-functions/functions/table_getRightVisibleLeafColumns" }, - { "label": "table_getRow", "to": "reference/static-functions/functions/table_getRow" }, - { "label": "table_getRowCount", "to": "reference/static-functions/functions/table_getRowCount" }, - { "label": "table_getRowId", "to": "reference/static-functions/functions/table_getRowId" }, - { "label": "table_getRowModel", "to": "reference/static-functions/functions/table_getRowModel" }, - { "label": "table_getSelectedRowModel", "to": "reference/static-functions/functions/table_getSelectedRowModel" }, - { "label": "table_getSortedRowModel", "to": "reference/static-functions/functions/table_getSortedRowModel" }, - { "label": "table_getToggleAllColumnsVisibilityHandler", "to": "reference/static-functions/functions/table_getToggleAllColumnsVisibilityHandler" }, - { "label": "table_getToggleAllPageRowsSelectedHandler", "to": "reference/static-functions/functions/table_getToggleAllPageRowsSelectedHandler" }, - { "label": "table_getToggleAllRowsExpandedHandler", "to": "reference/static-functions/functions/table_getToggleAllRowsExpandedHandler" }, - { "label": "table_getToggleAllRowsSelectedHandler", "to": "reference/static-functions/functions/table_getToggleAllRowsSelectedHandler" }, - { "label": "table_getTopRows", "to": "reference/static-functions/functions/table_getTopRows" }, - { "label": "table_getTotalSize", "to": "reference/static-functions/functions/table_getTotalSize" }, - { "label": "table_getVisibleFlatColumns", "to": "reference/static-functions/functions/table_getVisibleFlatColumns" }, - { "label": "table_getVisibleLeafColumns", "to": "reference/static-functions/functions/table_getVisibleLeafColumns" }, - { "label": "table_lastPage", "to": "reference/static-functions/functions/table_lastPage" }, - { "label": "table_mergeOptions", "to": "reference/static-functions/functions/table_mergeOptions" }, - { "label": "table_nextPage", "to": "reference/static-functions/functions/table_nextPage" }, - { "label": "table_previousPage", "to": "reference/static-functions/functions/table_previousPage" }, - { "label": "table_reset", "to": "reference/static-functions/functions/table_reset" }, - { "label": "table_resetColumnFilters", "to": "reference/static-functions/functions/table_resetColumnFilters" }, - { "label": "table_resetColumnOrder", "to": "reference/static-functions/functions/table_resetColumnOrder" }, - { "label": "table_resetColumnPinning", "to": "reference/static-functions/functions/table_resetColumnPinning" }, - { "label": "table_resetColumnSizing", "to": "reference/static-functions/functions/table_resetColumnSizing" }, - { "label": "table_resetColumnVisibility", "to": "reference/static-functions/functions/table_resetColumnVisibility" }, - { "label": "table_resetExpanded", "to": "reference/static-functions/functions/table_resetExpanded" }, - { "label": "table_resetGlobalFilter", "to": "reference/static-functions/functions/table_resetGlobalFilter" }, - { "label": "table_resetGrouping", "to": "reference/static-functions/functions/table_resetGrouping" }, - { "label": "table_resetHeaderSizeInfo", "to": "reference/static-functions/functions/table_resetHeaderSizeInfo" }, - { "label": "table_resetPageIndex", "to": "reference/static-functions/functions/table_resetPageIndex" }, - { "label": "table_resetPageSize", "to": "reference/static-functions/functions/table_resetPageSize" }, - { "label": "table_resetPagination", "to": "reference/static-functions/functions/table_resetPagination" }, - { "label": "table_resetRowPinning", "to": "reference/static-functions/functions/table_resetRowPinning" }, - { "label": "table_resetRowSelection", "to": "reference/static-functions/functions/table_resetRowSelection" }, - { "label": "table_resetSorting", "to": "reference/static-functions/functions/table_resetSorting" }, - { "label": "table_setColumnFilters", "to": "reference/static-functions/functions/table_setColumnFilters" }, - { "label": "table_setColumnOrder", "to": "reference/static-functions/functions/table_setColumnOrder" }, - { "label": "table_setColumnPinning", "to": "reference/static-functions/functions/table_setColumnPinning" }, - { "label": "table_setColumnResizing", "to": "reference/static-functions/functions/table_setColumnResizing" }, - { "label": "table_setColumnSizing", "to": "reference/static-functions/functions/table_setColumnSizing" }, - { "label": "table_setColumnVisibility", "to": "reference/static-functions/functions/table_setColumnVisibility" }, - { "label": "table_setExpanded", "to": "reference/static-functions/functions/table_setExpanded" }, - { "label": "table_setGlobalFilter", "to": "reference/static-functions/functions/table_setGlobalFilter" }, - { "label": "table_setGrouping", "to": "reference/static-functions/functions/table_setGrouping" }, - { "label": "table_setOptions", "to": "reference/static-functions/functions/table_setOptions" }, - { "label": "table_setPageIndex", "to": "reference/static-functions/functions/table_setPageIndex" }, - { "label": "table_setPageSize", "to": "reference/static-functions/functions/table_setPageSize" }, - { "label": "table_setPagination", "to": "reference/static-functions/functions/table_setPagination" }, - { "label": "table_setRowPinning", "to": "reference/static-functions/functions/table_setRowPinning" }, - { "label": "table_setRowSelection", "to": "reference/static-functions/functions/table_setRowSelection" }, - { "label": "table_setSorting", "to": "reference/static-functions/functions/table_setSorting" }, - { "label": "table_syncExternalStateToBaseAtoms", "to": "reference/static-functions/functions/table_syncExternalStateToBaseAtoms" }, - { "label": "table_toggleAllColumnsVisible", "to": "reference/static-functions/functions/table_toggleAllColumnsVisible" }, - { "label": "table_toggleAllPageRowsSelected", "to": "reference/static-functions/functions/table_toggleAllPageRowsSelected" }, - { "label": "table_toggleAllRowsExpanded", "to": "reference/static-functions/functions/table_toggleAllRowsExpanded" }, - { "label": "table_toggleAllRowsSelected", "to": "reference/static-functions/functions/table_toggleAllRowsSelected" } + { "label": "Static Functions Overview", "to": "reference/static-functions/index" } ] }, { @@ -919,12 +629,7 @@ { "label": "LegacyTable", "to": "framework/react/reference/legacy/type-aliases/LegacyTable" }, { "label": "LegacyTableOptions", "to": "framework/react/reference/legacy/type-aliases/LegacyTableOptions" }, { "label": "LegacyReactTable", "to": "framework/react/reference/legacy/type-aliases/LegacyReactTable" }, - { "label": "LegacyColumnDef", "to": "framework/react/reference/legacy/type-aliases/LegacyColumnDef" }, - { "label": "LegacyColumn", "to": "framework/react/reference/legacy/type-aliases/LegacyColumn" }, - { "label": "LegacyRow", "to": "framework/react/reference/legacy/type-aliases/LegacyRow" }, - { "label": "LegacyCell", "to": "framework/react/reference/legacy/type-aliases/LegacyCell" }, - { "label": "LegacyHeader", "to": "framework/react/reference/legacy/type-aliases/LegacyHeader" }, - { "label": "LegacyHeaderGroup", "to": "framework/react/reference/legacy/type-aliases/LegacyHeaderGroup" } + { "label": "LegacyColumnDef", "to": "framework/react/reference/legacy/type-aliases/LegacyColumnDef" } ] } ] diff --git a/docs/faq.md b/docs/faq.md index 714a9fa448..0f34c7dd83 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -127,10 +127,6 @@ export default function MyComponent() { } ``` -### React Forget - -When React Forget is released, these problems might be a thing of the past. Or just use Solid.js... 🤓 - ## How do I stop my table state from automatically resetting when my data changes? Most plugins use state that _should_ normally reset when the data sources changes, but sometimes you need to suppress that from happening if you are filtering your data externally, or immutably editing your data while looking at it, or simply doing anything external with your data that you don't want to trigger a piece of table state to reset automatically. diff --git a/docs/framework/angular/angular-table.md b/docs/framework/angular/angular-table.md index 2c9285c837..53f2875fc8 100644 --- a/docs/framework/angular/angular-table.md +++ b/docs/framework/angular/angular-table.md @@ -165,7 +165,7 @@ export class App { } ``` -See the [Table Composition Guide](./guide/table-composition.md) and the [Composable Tables example](./examples/composable-tables) for the full pattern. +See the [Composable Tables Guide](./guide/composable-tables.md) and the [Composable Tables example](./examples/composable-tables) for the full pattern. ## API Reference diff --git a/docs/framework/angular/guide/composable-tables.md b/docs/framework/angular/guide/composable-tables.md new file mode 100644 index 0000000000..16848949f6 --- /dev/null +++ b/docs/framework/angular/guide/composable-tables.md @@ -0,0 +1,184 @@ +--- +title: Composable Tables Guide +--- + +Composable tables are app-level table factories built with `createTableHook`. Instead of repeating the same features, row models, default options, and table/cell/header components in every Angular table, you define that shared infrastructure once and consume it from each table component. + +Use this pattern when multiple tables in an Angular app share behavior or rendering conventions. For a single isolated table, `injectTable` is usually enough. + +## Examples + +- [Composable Tables](../examples/composable-tables) - Two tables sharing one app table setup from `src/app/table.ts`. +- [Basic App Table](../examples/basic-app-table) - Minimal `createTableHook` usage without the larger component registry. + +## Setup + +The composable tables example keeps the shared setup in `src/app/table.ts`. That file creates one app-specific table factory and exports the helpers used by the rest of the example. + +```ts +import { + columnFilteringFeature, + createFilteredRowModel, + createPaginatedRowModel, + createSortedRowModel, + createTableHook, + filterFns, + rowPaginationFeature, + rowSortingFeature, + sortFns, + tableFeatures, +} from '@tanstack/angular-table' + +import { + PaginationControls, + RowCount, + TableToolbar, +} from './components/table-components' +import { + CategoryCell, + NumberCell, + PriceCell, + ProgressCell, + RowActionsCell, + StatusCell, + TextCell, +} from './components/cell-components' +import { + ColumnFilter, + FooterColumnId, + FooterSum, + SortIndicator, +} from './components/header-components' + +export const { + createAppColumnHelper, + injectAppTable, + injectTableContext, + injectTableCellContext, + injectTableHeaderContext, +} = createTableHook({ + features: tableFeatures({ + columnFilteringFeature, + rowPaginationFeature, + rowSortingFeature, + }), + rowModels: { + sortedRowModel: createSortedRowModel(sortFns), + filteredRowModel: createFilteredRowModel(filterFns), + paginatedRowModel: createPaginatedRowModel(), + }, + getRowId: (row) => row.id, + tableComponents: { + PaginationControls, + RowCount, + TableToolbar, + }, + cellComponents: { + TextCell, + NumberCell, + ProgressCell, + StatusCell, + CategoryCell, + PriceCell, + RowActionsCell, + }, + headerComponents: { + SortIndicator, + ColumnFilter, + FooterColumnId, + FooterSum, + }, +}) +``` + +This file is the source of truth for the feature set, row model pipeline, row IDs, and registered components used by both tables in the example. + +## Returned Helpers + +| Helper | Purpose | +|---|---| +| `injectAppTable` | Creates a table with the app's shared `features`, `rowModels`, defaults, and registered components already attached. | +| `createAppColumnHelper` | Creates column helpers where `cell`, `header`, and `footer` contexts know about the registered components. | +| `injectTableContext` | Reads the current table inside registered table components like `PaginationControls`. | +| `injectTableCellContext` | Reads the current cell inside registered cell components like `TextCell`. | +| `injectTableHeaderContext` | Reads the current header/footer inside registered header components like `SortIndicator`. | + +## Columns + +Use `createAppColumnHelper()` instead of the base column helper when column definitions should render registered components. + +```ts +import { flexRenderComponent } from '@tanstack/angular-table' +import { createAppColumnHelper } from '../../table' +import type { Person } from '../../makeData' + +const personColumnHelper = createAppColumnHelper() + +readonly columns = personColumnHelper.columns([ + personColumnHelper.accessor('firstName', { + header: 'First Name', + footer: ({ header }) => flexRenderComponent(header.FooterColumnId), + cell: ({ cell }) => flexRenderComponent(cell.TextCell), + }), + personColumnHelper.accessor('age', { + header: 'Age', + footer: ({ header }) => flexRenderComponent(header.FooterSum), + cell: ({ cell }) => flexRenderComponent(cell.NumberCell), + }), +]) +``` + +The registered components are available through the enhanced `cell` and `header` objects because the column helper is bound to the `createTableHook` configuration. + +## Table Rendering + +Create each table with `injectAppTable`. Per-table options provide the data and columns; shared features and row models come from `src/app/table.ts`. + +```ts +table = injectAppTable(() => ({ + key: 'users-table', + columns: this.columns, + data: this.data(), + debugTable: true, +})) +``` + +The Angular table instance is augmented with: + +- `table.PaginationControls`, `table.RowCount`, and `table.TableToolbar` +- `table.appCell(cell)` for enhanced cell component types in templates +- `table.appHeader(header)` for enhanced header component types in templates +- `table.appFooter(footer)` for enhanced footer component types in templates + +Registered table components can access the table through Angular DI: + +```ts +export class PaginationControls { + readonly table = injectTableContext() +} +``` + +In templates, use the Angular rendering helpers with the app wrappers: + +```html +@for (_header of headerGroup.headers; track _header.id) { + @let header = table.appHeader(_header); + + + + {{ value }} + + + {{ value }} + + +} +``` + +## Reusing The Hook + +The example has separate Users and Products table components. Both import `createAppColumnHelper` and `injectAppTable` from `src/app/table.ts`, so they share sorting, filtering, pagination, row IDs, toolbar controls, cell renderers, and header/footer renderers while keeping their own data and columns. + +If different product areas need incompatible defaults, create another `createTableHook` setup file and export a second set of app helpers from there. diff --git a/docs/framework/angular/guide/migrating.md b/docs/framework/angular/guide/migrating.md index 67ada68fdb..9ddbc684f6 100644 --- a/docs/framework/angular/guide/migrating.md +++ b/docs/framework/angular/guide/migrating.md @@ -614,7 +614,7 @@ const { injectAppTable } = createTableHook(sharedOptions) For applications with multiple tables sharing the same configuration, `createTableHook` lets you define features, row models, and reusable components once. -For full setup and patterns, see the [Table composition Guide](./table-composition.md). +For full setup and patterns, see the [Composable Tables Guide](./composable-tables.md). --- diff --git a/docs/framework/angular/guide/table-composition.md b/docs/framework/angular/guide/table-composition.md deleted file mode 100644 index c4519bd9cc..0000000000 --- a/docs/framework/angular/guide/table-composition.md +++ /dev/null @@ -1,295 +0,0 @@ ---- -title: Table Composition (createTableHook) ---- - -`createTableHook` is a convenience API for creating reusable, type-safe table configurations with pre-bound components. It is inspired by [TanStack Form's `createFormHook`](https://tanstack.com/form/latest/docs/framework/react/guides/form-composition) — a pattern where you define shared infrastructure once and consume it across your application with minimal boilerplate. - -> **When to use it:** Use `createTableHook` when you have multiple tables that share the same configuration (features, row models, and reusable components). For a single table, `injectTable` is sufficient. - -## Examples - -- [Composable Tables](../examples/composable-tables) — Two tables (Users and Products) sharing the same `createTableHook` configuration, with table/cell/header components, sorting, filtering, and pagination. -- [Basic App Table](../examples/basic-app-table) — Minimal example using `createTableHook` with no pre-bound components. - -### createTableHook - -`createTableHook` centralizes your table configuration into a single factory call. It returns a set of typed functions — `injectAppTable`, `createAppColumnHelper`, and pre-typed injection helpers — that you use instead of the base APIs. - -## Setup - -Call `createTableHook` with your shared configuration and destructure the returned utilities: - -```ts -// table.ts — shared table infrastructure - -import { - createTableHook, - tableFeatures, - columnFilteringFeature, - createFilteredRowModel, - createPaginatedRowModel, - createSortedRowModel, - filterFns, - rowPaginationFeature, - rowSortingFeature, - sortFns, -} from '@tanstack/angular-table' - -import { PaginationControls, RowCount, TableToolbar } from './components/table-components' -import { TextCell, NumberCell, StatusCell, ProgressCell } from './components/cell-components' -import { SortIndicator, ColumnFilter } from './components/header-components' - -export const { - createAppColumnHelper, - injectAppTable, - injectTableContext, - injectTableCellContext, - injectTableHeaderContext, -} = createTableHook({ - // Features and row models are shared across all tables - features: tableFeatures({ - columnFilteringFeature, - rowPaginationFeature, - rowSortingFeature, - }), - rowModels: { - sortedRowModel: createSortedRowModel(sortFns), - filteredRowModel: createFilteredRowModel(filterFns), - paginatedRowModel: createPaginatedRowModel(), - }, - // Default table options applied to every table - getRowId: (row) => row.id, - - // Pre-bound component registries - tableComponents: { - PaginationControls, - RowCount, - TableToolbar, - }, - cellComponents: { - TextCell, - NumberCell, - StatusCell, - ProgressCell, - }, - headerComponents: { - SortIndicator, - ColumnFilter, - }, -}) -``` - -This single file becomes the source of truth for your application's table infrastructure. - -## What `createTableHook` returns - -| Export | Description | -|---|---| -| `injectAppTable` | A wrapper around `injectTable` that merges default options and attaches component registries. Returns an `AppAngularTable` with table/cell/header components available directly on the instance. | -| `createAppColumnHelper` | A typed column helper where `cell`, `header`, and `footer` definitions receive enhanced context types with the registered components. | -| `injectTableContext` | Pre-typed `injectTableContext()` bound to your feature set. | -| `injectTableCellContext` | Pre-typed `injectTableCellContext()` bound to your feature set. | -| `injectTableHeaderContext` | Pre-typed `injectTableHeaderContext()` bound to your feature set. | -| `injectFlexRenderCellContext` | Pre-typed `injectFlexRenderContext()` for cell context. | -| `injectFlexRenderHeaderContext` | Pre-typed `injectFlexRenderContext()` for header context. | - -## Component registries - -`createTableHook` accepts three component registries that map string keys to Angular components or render functions: - -### `tableComponents` - -Components that need access to the **table instance**. These are attached directly to the `AppAngularTable` object returned by `injectAppTable`, so you can reference them in templates as `table.PaginationControls`, `table.RowCount`, etc. - -Use `injectTableContext()` inside these components to access the table: - -```ts -@Component({ - selector: 'app-pagination-controls', - template: ` - - `, - changeDetection: ChangeDetectionStrategy.OnPush, -}) -export class PaginationControls { - readonly table = injectTableContext() -} -``` - -Render table components via Angular `NgComponentOutlet`: - -```html - - - -``` - -### `cellComponents` - -Components that render **cell content**. These are attached to the `Cell` prototype, so they are available in column definitions through the enhanced `AppCellContext`: - -```ts -const columnHelper = createAppColumnHelper() - -const columns = columnHelper.columns([ - columnHelper.accessor('firstName', { - header: 'First Name', - cell: ({ cell }) => cell.TextCell, - }), - columnHelper.accessor('age', { - header: 'Age', - cell: ({ cell }) => cell.NumberCell, - }), - columnHelper.accessor('status', { - header: 'Status', - cell: ({ cell }) => cell.StatusCell, - }), -]) -``` - -Use `injectTableCellContext()` or `injectFlexRenderContext()` inside cell components: - -```ts -@Component({ - selector: 'span', - template: `{{ cell().getValue() }}`, -}) -export class TextCell { - readonly cell = injectTableCellContext() -} -``` - -### `headerComponents` - -Components or render functions that render **header/footer content**. These are attached to the `Header` prototype and available through the enhanced `AppHeaderContext`: - -```ts -// Render functions work too — they run in injection context -export function SortIndicator(): string | null { - const header = injectTableHeaderContext() - const sorted = header().column.getIsSorted() - if (!sorted) return null - return sorted === 'asc' ? '🔼' : '🔽' -} -``` - -Access header components in the template via `table.appHeader(header)`: - -```html -@for (_header of headerGroup.headers; track _header.id) { - @let header = table.appHeader(_header); - - {{ value }} - -
- - -} -``` - -## Using `injectAppTable` - -`injectAppTable` is a wrapper around `injectTable`. It merges the default options from `createTableHook` with the per-table options, and returns an `AppAngularTable` — the standard table instance augmented with: - -- **Table components** directly on the table object (`table.PaginationControls`, `table.TableToolbar`, etc.) -- **`table.appCell(cell)`** — utility type functions for templates that wraps a `Cell` with the registered `cellComponents` -- **`table.appHeader(header)`** — utility type functions for templates that wraps a `Header` with the registered `headerComponents` -- **`table.appFooter(footer)`** — utility type functions for templates that wraps a `Header` (footer) with the registered `headerComponents` - -You do not need to pass `features` or `rowModels` — they are inherited from the hook configuration: - -```ts -@Component({ - selector: 'users-table', - templateUrl: './users-table.html', - imports: [FlexRender, TanStackTable, TanStackTableHeader, TanStackTableCell, NgComponentOutlet], - changeDetection: ChangeDetectionStrategy.OnPush, -}) -export class UsersTable { - readonly data = signal(makeData(100)) - - readonly columns = columnHelper.columns([ - columnHelper.accessor('firstName', { - header: 'First Name', - cell: ({ cell }) => cell.TextCell, - }), - // ... - ]) - - // No need to specify features, rowModels, ... — they come from createTableHook - table = injectAppTable(() => ({ - columns: this.columns, - data: this.data(), - })) -} -``` - -## Using `createAppColumnHelper` - -`createAppColumnHelper()` returns a column helper identical to `createColumnHelper` at runtime, but with enhanced types: the `cell`, `header`, and `footer` definition callbacks receive `AppCellContext` / `AppHeaderContext` instead of the base context types. - -This means TypeScript knows about your registered components and provides autocompletion: - -```ts -const columnHelper = createAppColumnHelper() - -columnHelper.accessor('firstName', { - cell: ({ cell }) => { - // ✅ TypeScript knows about TextCell, NumberCell, StatusCell, etc. - return cell.TextCell - }, - header: ({ header }) => { - // ✅ TypeScript knows about SortIndicator, ColumnFilter, etc. - return flexRenderComponent(header.SortIndicator) - }, -}) -``` - -You can also use `flexRenderComponent(...)` to wrap the component with custom inputs/outputs: - -```ts -columnHelper.accessor('firstName', { - cell: ({ cell }) => flexRenderComponent(cell.TextCell), - footer: ({ header }) => flexRenderComponent(header.FooterColumnId), -}) -``` - -## Multiple table configurations - -You can call `createTableHook` multiple times to create different table configurations for different parts of your application. Each call returns an independent set of utilities with its own feature set and component registries: - -```ts -// admin-table.ts — tables with editing capabilities -export const { - injectAppTable: injectAdminTable, - createAppColumnHelper: createAdminColumnHelper, -} = createTableHook({ - features: tableFeatures({ rowSortingFeature, columnFilteringFeature }), - rowModels: { /* ... */ }, - cellComponents: { EditableCell, DeleteButton }, -}) - -// readonly-table.ts — simpler read-only tables -export const { - injectAppTable: injectReadonlyTable, - createAppColumnHelper: createReadonlyColumnHelper, -} = createTableHook({ - features: tableFeatures({ rowSortingFeature }), - rowModels: { /* ... */ }, - cellComponents: { TextCell, NumberCell }, -}) -``` - -## Examples - -- [Composable Tables](../examples/composable-tables) — Full example with two tables sharing the same `createTableHook` configuration. -- [Basic App Table](../examples/basic-app-table) — Minimal example with no pre-bound components. diff --git a/docs/framework/angular/reference/functions/injectTable.md b/docs/framework/angular/reference/functions/injectTable.md index 9edc9f063c..8cfd642b3a 100644 --- a/docs/framework/angular/reference/functions/injectTable.md +++ b/docs/framework/angular/reference/functions/injectTable.md @@ -9,7 +9,7 @@ title: injectTable function injectTable(options): AngularTable; ``` -Defined in: [packages/angular-table/src/injectTable.ts:106](https://github.com/TanStack/table/blob/main/packages/angular-table/src/injectTable.ts#L106) +Defined in: [packages/angular-table/src/injectTable.ts:101](https://github.com/TanStack/table/blob/main/packages/angular-table/src/injectTable.ts#L101) Creates and returns an Angular-reactive table instance. diff --git a/docs/framework/angular/reference/type-aliases/AngularTable.md b/docs/framework/angular/reference/type-aliases/AngularTable.md index ead0a2d42d..0c4592d95e 100644 --- a/docs/framework/angular/reference/type-aliases/AngularTable.md +++ b/docs/framework/angular/reference/type-aliases/AngularTable.md @@ -9,19 +9,10 @@ title: AngularTable type AngularTable = Table & object; ``` -Defined in: [packages/angular-table/src/injectTable.ts:33](https://github.com/TanStack/table/blob/main/packages/angular-table/src/injectTable.ts#L33) +Defined in: [packages/angular-table/src/injectTable.ts:32](https://github.com/TanStack/table/blob/main/packages/angular-table/src/injectTable.ts#L32) ## Type Declaration -### state - -```ts -readonly state: Readonly>; -``` - -The current table state exposed as a flat proxy. Prefer -`table.atoms..get()` when reading a specific slice. - ### ~~store~~ ```ts @@ -31,9 +22,9 @@ readonly store: Table["store"]; #### Deprecated Prefer `table.atoms..get()` for template/render reads -of a specific state slice, `table.state` for full-state debug snapshots, or -Angular computed values around explicit selectors. `table.store.state` is a -current-value snapshot and is easy to misuse in render code. +of a specific state slice, or Angular computed values around explicit +selectors. `table.store.state` is a current-value snapshot and is easy to +misuse in render code. ## Type Parameters diff --git a/docs/framework/angular/reference/type-aliases/SubscribeSource.md b/docs/framework/angular/reference/type-aliases/SubscribeSource.md index a384d0e002..cf222f7fda 100644 --- a/docs/framework/angular/reference/type-aliases/SubscribeSource.md +++ b/docs/framework/angular/reference/type-aliases/SubscribeSource.md @@ -13,7 +13,7 @@ type SubscribeSource = | ReadonlyStore; ``` -Defined in: [packages/angular-table/src/injectTable.ts:27](https://github.com/TanStack/table/blob/main/packages/angular-table/src/injectTable.ts#L27) +Defined in: [packages/angular-table/src/injectTable.ts:26](https://github.com/TanStack/table/blob/main/packages/angular-table/src/injectTable.ts#L26) ## Type Parameters diff --git a/docs/framework/angular/reference/variables/TanStackTableCellToken.md b/docs/framework/angular/reference/variables/TanStackTableCellToken.md index 216d12e2f6..dd4895fc2d 100644 --- a/docs/framework/angular/reference/variables/TanStackTableCellToken.md +++ b/docs/framework/angular/reference/variables/TanStackTableCellToken.md @@ -6,7 +6,7 @@ title: TanStackTableCellToken # Variable: TanStackTableCellToken ```ts -const TanStackTableCellToken: InjectionToken>; +const TanStackTableCellToken: InjectionToken>>; ``` Defined in: [packages/angular-table/src/helpers/cell.ts:25](https://github.com/TanStack/table/blob/main/packages/angular-table/src/helpers/cell.ts#L25) diff --git a/docs/framework/angular/reference/variables/TanStackTableHeaderToken.md b/docs/framework/angular/reference/variables/TanStackTableHeaderToken.md index dbd54f2665..4d607a3a2c 100644 --- a/docs/framework/angular/reference/variables/TanStackTableHeaderToken.md +++ b/docs/framework/angular/reference/variables/TanStackTableHeaderToken.md @@ -6,7 +6,7 @@ title: TanStackTableHeaderToken # Variable: TanStackTableHeaderToken ```ts -const TanStackTableHeaderToken: InjectionToken>; +const TanStackTableHeaderToken: InjectionToken>>; ``` Defined in: [packages/angular-table/src/helpers/header.ts:25](https://github.com/TanStack/table/blob/main/packages/angular-table/src/helpers/header.ts#L25) diff --git a/docs/framework/angular/reference/variables/TanStackTableToken.md b/docs/framework/angular/reference/variables/TanStackTableToken.md index 08e4dce77e..93a8358263 100644 --- a/docs/framework/angular/reference/variables/TanStackTableToken.md +++ b/docs/framework/angular/reference/variables/TanStackTableToken.md @@ -6,7 +6,7 @@ title: TanStackTableToken # Variable: TanStackTableToken ```ts -const TanStackTableToken: InjectionToken>; +const TanStackTableToken: InjectionToken>>; ``` Defined in: [packages/angular-table/src/helpers/table.ts:11](https://github.com/TanStack/table/blob/main/packages/angular-table/src/helpers/table.ts#L11) diff --git a/docs/framework/lit/guide/composable-tables.md b/docs/framework/lit/guide/composable-tables.md new file mode 100644 index 0000000000..c73d08760f --- /dev/null +++ b/docs/framework/lit/guide/composable-tables.md @@ -0,0 +1,192 @@ +--- +title: Composable Tables Guide +--- + +Composable tables are app-level table factories built with `createTableHook`. They let Lit apps define shared features, row models, default options, and reusable render helpers once, then create multiple tables from that setup. + +Use this pattern when several tables should share behavior and cell/header rendering conventions. For one standalone Lit table, `TableController` is usually enough. + +## Examples + +- [Composable Tables](../examples/composable-tables) - Users and Products tables sharing `src/hooks/table.ts`. +- [Basic App Table](../examples/basic-app-table) - Minimal `createTableHook` setup. + +## Setup + +The composable tables example keeps the shared configuration in `src/hooks/table.ts`. + +```ts +import { + columnFilteringFeature, + createFilteredRowModel, + createPaginatedRowModel, + createSortedRowModel, + createTableHook, + filterFns, + rowPaginationFeature, + rowSortingFeature, + sortFns, + tableFeatures, +} from '@tanstack/lit-table' + +import { + CategoryCell, + NumberCell, + PriceCell, + ProgressCell, + RowActionsCell, + StatusCell, + TextCell, +} from '../components/cell-components' +import { + ColumnFilter, + FooterColumnId, + FooterSum, + SortIndicator, +} from '../components/header-components' + +export const features = tableFeatures({ + columnFilteringFeature, + rowPaginationFeature, + rowSortingFeature, +}) + +export const { createAppColumnHelper, useAppTable, useTableContext } = + createTableHook({ + features, + rowModels: { + sortedRowModel: createSortedRowModel(sortFns), + filteredRowModel: createFilteredRowModel(filterFns), + paginatedRowModel: createPaginatedRowModel(), + }, + getRowId: (row) => row.id, + cellComponents: { + TextCell, + NumberCell, + StatusCell, + ProgressCell, + RowActionsCell, + PriceCell, + CategoryCell, + }, + headerComponents: { + SortIndicator, + ColumnFilter, + FooterColumnId, + FooterSum, + }, + }) +``` + +The Lit example does not register `tableComponents` in `createTableHook`. Its table-level controls are custom elements that call `useTableContext(this)`, so they consume table context directly. + +## Returned Helpers + +| Helper | Purpose | +|---|---| +| `useAppTable` | Creates a `TableController`-backed app table for a Lit host and attaches app render helpers. | +| `createAppColumnHelper` | Creates column helpers with `TFeatures` and registered cell/header component types already bound. | +| `useTableContext` | Lets custom elements like `pagination-controls` read the nearest app table context. | + +## Columns + +Create one column helper per row type. Cell/header components in Lit are functions, so column definitions call the registered function on the enhanced `cell` or `header`. + +```ts +const personColumnHelper = createAppColumnHelper() + +const columns = personColumnHelper.columns([ + personColumnHelper.accessor('firstName', { + header: 'First Name', + footer: (props) => props.column.id, + cell: ({ cell }) => cell.TextCell(), + }), + personColumnHelper.accessor('age', { + header: 'Age', + footer: (props) => props.column.id, + cell: ({ cell }) => cell.NumberCell(), + }), + personColumnHelper.display({ + id: 'actions', + header: 'Actions', + cell: ({ cell }) => cell.RowActionsCell(), + }), +]) +``` + +## Table Rendering + +Call `useAppTable(this, options, selector)` from the `LitElement` host. The helper returns an object with `table()`, which computes the current app table through the controller. + +```ts +private appTable = (() => { + const host = this + return useAppTable( + this, + { + columns, + get data() { + return host.data + }, + debugTable: true, + }, + (state) => ({ + pagination: state.pagination, + sorting: state.sorting, + columnFilters: state.columnFilters, + }), + ) +})() +``` + +Inside `render()`, use callback-based app wrappers: + +```ts +const table = this.appTable.table() + +return html` + + + + + ${table.getHeaderGroups().map( + (headerGroup) => html` + + ${headerGroup.headers.map((h) => + table.AppHeader( + h, + (header) => html` + + `, + ), + )} + + `, + )} + + + ${table.getRowModel().rows.map( + (row) => html` + + ${row + .getAllCells() + .map((cell) => + table.AppCell(cell, (appCell) => html``), + )} + + `, + )} + +
+ ${header.FlexRender()} ${header.SortIndicator()} + ${header.ColumnFilter()} +
${appCell.FlexRender()}
+ + + +` +``` + +## Reusing The Hook + +The Users and Products table elements import the same `createAppColumnHelper` and `useAppTable` from `src/hooks/table.ts`. Their data and columns differ, but sorting, filtering, pagination, row IDs, and registered cell/header renderers come from one shared configuration. diff --git a/docs/framework/preact/guide/composable-tables.md b/docs/framework/preact/guide/composable-tables.md new file mode 100644 index 0000000000..0d2bd9ed6a --- /dev/null +++ b/docs/framework/preact/guide/composable-tables.md @@ -0,0 +1,210 @@ +--- +title: Composable Tables Guide +--- + +Composable tables are app-level table factories built with `createTableHook`. They let Preact apps define shared features, row models, default options, and reusable components once, then create multiple tables from that shared setup. + +Use this pattern when several tables should share behavior and rendering conventions. For one standalone table, `useTable` is usually enough. + +## Examples + +- [Composable Tables](../examples/composable-tables) - Users and Products tables sharing `src/hooks/table.ts`. +- [Basic useAppTable](../examples/basic-use-app-table) - Minimal `createTableHook` setup. + +## Setup + +The composable tables example keeps the shared configuration in `src/hooks/table.ts`. + +```tsx +import { + columnFilteringFeature, + createFilteredRowModel, + createPaginatedRowModel, + createSortedRowModel, + createTableHook, + filterFns, + rowPaginationFeature, + rowSortingFeature, + sortFns, + tableFeatures, +} from '@tanstack/preact-table' + +import { + PaginationControls, + RowCount, + TableToolbar, +} from '../components/table-components' +import { + CategoryCell, + NumberCell, + PriceCell, + ProgressCell, + RowActionsCell, + StatusCell, + TextCell, +} from '../components/cell-components' +import { + ColumnFilter, + FooterColumnId, + FooterSum, + SortIndicator, +} from '../components/header-components' + +export const { + createAppColumnHelper, + useAppTable, + useTableContext, + useCellContext, + useHeaderContext, +} = createTableHook({ + features: tableFeatures({ + columnFilteringFeature, + rowPaginationFeature, + rowSortingFeature, + }), + rowModels: { + sortedRowModel: createSortedRowModel(sortFns), + filteredRowModel: createFilteredRowModel(filterFns), + paginatedRowModel: createPaginatedRowModel(), + }, + getRowId: (row) => row.id, + tableComponents: { + PaginationControls, + RowCount, + TableToolbar, + }, + cellComponents: { + TextCell, + NumberCell, + StatusCell, + ProgressCell, + RowActionsCell, + PriceCell, + CategoryCell, + }, + headerComponents: { + SortIndicator, + ColumnFilter, + FooterColumnId, + FooterSum, + }, +}) +``` + +## Returned Helpers + +| Helper | Purpose | +|---|---| +| `useAppTable` | Creates a table with shared features, row models, defaults, and registered components. | +| `createAppColumnHelper` | Creates column helpers with `TFeatures` and registered component types already bound. | +| `useTableContext` | Reads the current table inside registered table components. | +| `useCellContext` | Reads the current cell inside registered cell components. | +| `useHeaderContext` | Reads the current header/footer inside registered header components. | + +## Columns + +Create one column helper per row type. The helper is bound to the app table setup, so column definitions can reference registered components directly. + +```tsx +const personColumnHelper = createAppColumnHelper() + +const columns = useMemo( + () => + personColumnHelper.columns([ + personColumnHelper.accessor('firstName', { + header: 'First Name', + footer: (props) => props.column.id, + cell: ({ cell }) => , + }), + personColumnHelper.accessor('age', { + header: 'Age', + footer: (props) => props.column.id, + cell: ({ cell }) => , + }), + personColumnHelper.display({ + id: 'actions', + header: 'Actions', + cell: ({ cell }) => , + }), + ]), + [], +) +``` + +Registered cell components use `useCellContext()` internally, and registered header/footer components use `useHeaderContext()`. + +## Table Rendering + +Create each table with `useAppTable`. You pass table-specific options like `key`, `columns`, and `data`; the shared `features`, `rowModels`, `getRowId`, and component registries come from the hook. + +```tsx +const table = useAppTable( + { + key: 'users-table', + columns, + data, + debugTable: true, + }, + (state) => state, +) +``` + +The returned table includes `AppTable`, `AppHeader`, `AppCell`, and `AppFooter` wrappers. The Preact example uses the same pattern as the React example, but imports from `@tanstack/preact-table` and `preact/hooks`. + +```tsx + ({ + pagination: state.pagination, + sorting: state.sorting, + columnFilters: state.columnFilters, + })} +> + {({ sorting, columnFilters }) => ( +
+ + + + + {table.getHeaderGroups().map((headerGroup) => ( + + {headerGroup.headers.map((h) => ( + + {(header) => ( + + )} + + ))} + + ))} + + + {table.getRowModel().rows.map((row) => ( + + {row.getAllCells().map((c) => ( + + {(cell) => ( + + )} + + ))} + + ))} + +
+ + + +
+ +
+ + + +
+ )} + +``` + +## Reusing The Hook + +The example creates both `personColumnHelper` and `productColumnHelper` from the same `createAppColumnHelper`, then renders Users and Products tables with the same `useAppTable` factory. Each table owns its data and columns, while the app hook owns table infrastructure and component conventions. diff --git a/docs/framework/preact/guide/create-table-hook.md b/docs/framework/preact/guide/create-table-hook.md deleted file mode 100644 index 750c78499b..0000000000 --- a/docs/framework/preact/guide/create-table-hook.md +++ /dev/null @@ -1,169 +0,0 @@ ---- -title: createTableHook Guide ---- - -`createTableHook` is an advanced API for building reusable, composable table configurations in Preact. It mirrors the [React `createTableHook` API](../../react/guide/create-table-hook) — you define features, row models, and pre-bound components once, then reuse them across multiple tables with minimal boilerplate. - -> **When to use it:** Use `createTableHook` when you have multiple tables that share the same configuration. For a single table, `useTable` is sufficient. - -## Setup - -Create a shared table configuration file and call `createTableHook` with your features, row models, and component registries: - -```tsx -// hooks/table.ts - -import { - createTableHook, - tableFeatures, - columnFilteringFeature, - rowPaginationFeature, - rowSortingFeature, - createFilteredRowModel, - createPaginatedRowModel, - createSortedRowModel, - filterFns, - sortFns, -} from '@tanstack/preact-table' - -import { PaginationControls, RowCount, TableToolbar } from '../components/table-components' -import { TextCell, NumberCell, StatusCell } from '../components/cell-components' -import { SortIndicator, ColumnFilter } from '../components/header-components' - -export const { - createAppColumnHelper, - useAppTable, - useTableContext, - useCellContext, - useHeaderContext, -} = createTableHook({ - features: tableFeatures({ - columnFilteringFeature, - rowPaginationFeature, - rowSortingFeature, - }), - - rowModels: { - sortedRowModel: createSortedRowModel(sortFns), - filteredRowModel: createFilteredRowModel(filterFns), - paginatedRowModel: createPaginatedRowModel(), - }, - - getRowId: (row) => row.id, - - tableComponents: { - PaginationControls, - RowCount, - TableToolbar, - }, - - cellComponents: { - TextCell, - NumberCell, - StatusCell, - }, - - headerComponents: { - SortIndicator, - ColumnFilter, - }, -}) -``` - -## What `createTableHook` Returns - -| Export | Description | -|--------|-------------| -| `useAppTable` | Hook for creating tables. Merges default options from the hook with per-table options. | -| `createAppColumnHelper` | Column helper with `TFeatures` pre-bound. Only requires `TData`. | -| `useTableContext` | Access the table instance inside `tableComponents`. | -| `useCellContext` | Access the cell instance inside `cellComponents`. | -| `useHeaderContext` | Access the header instance inside `headerComponents`. | - -## Component Registries - -The API matches React's `createTableHook`: - -- **`tableComponents`** — Components attached to the table (`table.PaginationControls`, etc.). Use `useTableContext()` inside them. -- **`cellComponents`** — Components attached to the cell (`cell.TextCell`, etc.). Use `useCellContext()` inside them. -- **`headerComponents`** — Components attached to the header (`header.SortIndicator`, etc.). Use `useHeaderContext()` inside them. - -## Using `useAppTable` - -```tsx -const personColumnHelper = createAppColumnHelper() - -function UsersTable() { - const [data, setData] = useState(() => makeData(100)) - - const columns = useMemo( - () => - personColumnHelper.columns([ - personColumnHelper.accessor('firstName', { - header: 'First Name', - cell: ({ cell }) => , - }), - personColumnHelper.accessor('age', { - header: 'Age', - cell: ({ cell }) => , - }), - ]), - [], - ) - - const table = useAppTable({ - columns, - data, - }) - - return ( - ({ pagination: state.pagination })}> - {() => ( -
- setData(makeData(100))} /> - - - {table.getHeaderGroups().map((headerGroup) => ( - - {headerGroup.headers.map((h) => ( - - {(header) => ( - - )} - - ))} - - ))} - - - {table.getRowModel().rows.map((row) => ( - - {row.getAllCells().map((c) => ( - - {(cell) => } - - ))} - - ))} - -
- - -
- - -
- )} - - ) -} -``` - -## AppTable, AppHeader, AppCell, AppFooter - -Same as React: `table.AppTable`, `table.AppHeader`, `table.AppCell`, and `table.AppFooter` provide context to your registered components. Use the `selector` prop on `AppTable` for optimized re-renders. - -## See Also - -- [React createTableHook Guide](../../react/guide/create-table-hook) — The React guide has more detailed examples and the same API. -- [Composable Tables (React)](../../react/examples/composable-tables) — Reference implementation (Preact API mirrors React). diff --git a/docs/framework/preact/preact-table.md b/docs/framework/preact/preact-table.md index 2c5c8ca5ab..aef913deff 100644 --- a/docs/framework/preact/preact-table.md +++ b/docs/framework/preact/preact-table.md @@ -150,7 +150,7 @@ function App({ data }: { data: Person[] }) { } ``` -See the [createTableHook Guide](./guide/create-table-hook.md) and the [Composable Tables example](./examples/composable-tables) for the full pattern. +See the [Composable Tables Guide](./guide/composable-tables.md) and the [Composable Tables example](./examples/composable-tables) for the full pattern. ## API Reference diff --git a/docs/framework/preact/reference/interfaces/AppCellPropsWithSelector.md b/docs/framework/preact/reference/interfaces/AppCellPropsWithSelector.md index 342572ab7b..a14895c9df 100644 --- a/docs/framework/preact/reference/interfaces/AppCellPropsWithSelector.md +++ b/docs/framework/preact/reference/interfaces/AppCellPropsWithSelector.md @@ -55,7 +55,7 @@ Defined in: [createTableHook.tsx:321](https://github.com/TanStack/table/blob/mai ##### cell -`Cell_Cell`\<`TFeatures`, `TData`, `TValue`\> & `UnionToIntersection`\<`"columnGroupingFeature"` *extends* keyof `TFeatures` ? `Cell_ColumnGrouping` : `never`\> & `UnionToIntersection`\<\{ \[K in string \| number \| symbol\]: K extends "coreReativityFeature" ? never : TFeatures\[K\] extends TableFeature\ ? "Cell" extends keyof FeatureConstructorOptions ? FeatureConstructorOptions\[keyof (...) & "Cell"\] : never : any \}\[keyof `TFeatures`\]\> & `Cell_Plugins`\<`TFeatures`, `TData`, `TValue`\> & `TCellComponents` & `object` +`Cell_Core`\<`TFeatures`, `TData`, `TValue`\> & `ExtractFeatureMapTypes`\<`TFeatures`, `Cell_FeatureMap`\> & `TCellComponents` & `object` ##### state diff --git a/docs/framework/preact/reference/interfaces/AppCellPropsWithoutSelector.md b/docs/framework/preact/reference/interfaces/AppCellPropsWithoutSelector.md index da3737fabc..7c1b9468ff 100644 --- a/docs/framework/preact/reference/interfaces/AppCellPropsWithoutSelector.md +++ b/docs/framework/preact/reference/interfaces/AppCellPropsWithoutSelector.md @@ -51,7 +51,7 @@ Defined in: [createTableHook.tsx:303](https://github.com/TanStack/table/blob/mai ##### cell -`Cell_Cell`\<`TFeatures`, `TData`, `TValue`\> & `UnionToIntersection`\<`"columnGroupingFeature"` *extends* keyof `TFeatures` ? `Cell_ColumnGrouping` : `never`\> & `UnionToIntersection`\<\{ \[K in string \| number \| symbol\]: K extends "coreReativityFeature" ? never : TFeatures\[K\] extends TableFeature\ ? "Cell" extends keyof FeatureConstructorOptions ? FeatureConstructorOptions\[keyof (...) & "Cell"\] : never : any \}\[keyof `TFeatures`\]\> & `Cell_Plugins`\<`TFeatures`, `TData`, `TValue`\> & `TCellComponents` & `object` +`Cell_Core`\<`TFeatures`, `TData`, `TValue`\> & `ExtractFeatureMapTypes`\<`TFeatures`, `Cell_FeatureMap`\> & `TCellComponents` & `object` #### Returns diff --git a/docs/framework/preact/reference/interfaces/AppHeaderPropsWithSelector.md b/docs/framework/preact/reference/interfaces/AppHeaderPropsWithSelector.md index 2717ebe2b8..bf8877dce1 100644 --- a/docs/framework/preact/reference/interfaces/AppHeaderPropsWithSelector.md +++ b/docs/framework/preact/reference/interfaces/AppHeaderPropsWithSelector.md @@ -45,9 +45,7 @@ Defined in: [createTableHook.tsx:357](https://github.com/TanStack/table/blob/mai ##### header -`Header_Core`\<`TFeatures`, `TData`, `TValue`\> & `UnionToIntersection`\< - \| `"columnSizingFeature"` *extends* keyof `TFeatures` ? `Header_ColumnSizing` : `never` - \| `"columnResizingFeature"` *extends* keyof `TFeatures` ? `Header_ColumnResizing` : `never`\> & `UnionToIntersection`\<\{ \[K in string \| number \| symbol\]: K extends "coreReativityFeature" ? never : TFeatures\[K\] extends TableFeature\ ? "Header" extends keyof FeatureConstructorOptions ? FeatureConstructorOptions\[keyof (...) & "Header"\] : never : any \}\[keyof `TFeatures`\]\> & `Header_Plugins`\<`TFeatures`, `TData`, `TValue`\> & `THeaderComponents` & `object` +`Header_Core`\<`TFeatures`, `TData`, `TValue`\> & `ExtractFeatureMapTypes`\<`TFeatures`, `Header_FeatureMap`\> & `THeaderComponents` & `object` ##### state diff --git a/docs/framework/preact/reference/interfaces/AppHeaderPropsWithoutSelector.md b/docs/framework/preact/reference/interfaces/AppHeaderPropsWithoutSelector.md index 4d2db8ee90..e464707882 100644 --- a/docs/framework/preact/reference/interfaces/AppHeaderPropsWithoutSelector.md +++ b/docs/framework/preact/reference/interfaces/AppHeaderPropsWithoutSelector.md @@ -41,9 +41,7 @@ Defined in: [createTableHook.tsx:339](https://github.com/TanStack/table/blob/mai ##### header -`Header_Core`\<`TFeatures`, `TData`, `TValue`\> & `UnionToIntersection`\< - \| `"columnSizingFeature"` *extends* keyof `TFeatures` ? `Header_ColumnSizing` : `never` - \| `"columnResizingFeature"` *extends* keyof `TFeatures` ? `Header_ColumnResizing` : `never`\> & `UnionToIntersection`\<\{ \[K in string \| number \| symbol\]: K extends "coreReativityFeature" ? never : TFeatures\[K\] extends TableFeature\ ? "Header" extends keyof FeatureConstructorOptions ? FeatureConstructorOptions\[keyof (...) & "Header"\] : never : any \}\[keyof `TFeatures`\]\> & `Header_Plugins`\<`TFeatures`, `TData`, `TValue`\> & `THeaderComponents` & `object` +`Header_Core`\<`TFeatures`, `TData`, `TValue`\> & `ExtractFeatureMapTypes`\<`TFeatures`, `Header_FeatureMap`\> & `THeaderComponents` & `object` #### Returns diff --git a/docs/framework/react/guide/composable-tables.md b/docs/framework/react/guide/composable-tables.md new file mode 100644 index 0000000000..9a191dac42 --- /dev/null +++ b/docs/framework/react/guide/composable-tables.md @@ -0,0 +1,210 @@ +--- +title: Composable Tables Guide +--- + +Composable tables are app-level table factories built with `createTableHook`. They let React apps define shared features, row models, default options, and reusable components once, then create multiple tables from that shared setup. + +Use this pattern when several tables should share the same behavior and component conventions. For one standalone table, `useTable` is usually enough. + +## Examples + +- [Composable Tables](../examples/composable-tables) - Users and Products tables sharing `src/hooks/table.ts`. +- [Basic useAppTable](../examples/basic-use-app-table) - Minimal `createTableHook` setup. + +## Setup + +The composable tables example keeps the shared configuration in `src/hooks/table.ts`. + +```tsx +import { + columnFilteringFeature, + createFilteredRowModel, + createPaginatedRowModel, + createSortedRowModel, + createTableHook, + filterFns, + rowPaginationFeature, + rowSortingFeature, + sortFns, + tableFeatures, +} from '@tanstack/react-table' + +import { + PaginationControls, + RowCount, + TableToolbar, +} from '../components/table-components' +import { + CategoryCell, + NumberCell, + PriceCell, + ProgressCell, + RowActionsCell, + StatusCell, + TextCell, +} from '../components/cell-components' +import { + ColumnFilter, + FooterColumnId, + FooterSum, + SortIndicator, +} from '../components/header-components' + +export const { + createAppColumnHelper, + useAppTable, + useTableContext, + useCellContext, + useHeaderContext, +} = createTableHook({ + features: tableFeatures({ + columnFilteringFeature, + rowPaginationFeature, + rowSortingFeature, + }), + rowModels: { + sortedRowModel: createSortedRowModel(sortFns), + filteredRowModel: createFilteredRowModel(filterFns), + paginatedRowModel: createPaginatedRowModel(), + }, + getRowId: (row) => row.id, + tableComponents: { + PaginationControls, + RowCount, + TableToolbar, + }, + cellComponents: { + TextCell, + NumberCell, + StatusCell, + ProgressCell, + RowActionsCell, + PriceCell, + CategoryCell, + }, + headerComponents: { + SortIndicator, + ColumnFilter, + FooterColumnId, + FooterSum, + }, +}) +``` + +## Returned Helpers + +| Helper | Purpose | +|---|---| +| `useAppTable` | Creates a table with shared features, row models, defaults, and registered components. | +| `createAppColumnHelper` | Creates column helpers with `TFeatures` and registered component types already bound. | +| `useTableContext` | Reads the current table inside registered table components. | +| `useCellContext` | Reads the current cell inside registered cell components. | +| `useHeaderContext` | Reads the current header/footer inside registered header components. | + +## Columns + +Create one column helper per row type. Since the helper is already bound to the app table setup, column definitions can reference registered cell and header components directly. + +```tsx +const personColumnHelper = createAppColumnHelper() + +const columns = useMemo( + () => + personColumnHelper.columns([ + personColumnHelper.accessor('firstName', { + header: 'First Name', + footer: (props) => props.column.id, + cell: ({ cell }) => , + }), + personColumnHelper.accessor('age', { + header: 'Age', + footer: (props) => props.column.id, + cell: ({ cell }) => , + }), + personColumnHelper.display({ + id: 'actions', + header: 'Actions', + cell: ({ cell }) => , + }), + ]), + [], +) +``` + +Registered cell components use `useCellContext()` internally, and registered header/footer components use `useHeaderContext()`. + +## Table Rendering + +Create each table with `useAppTable`. You pass table-specific options like `key`, `columns`, and `data`; the shared `features`, `rowModels`, `getRowId`, and component registries come from the hook. + +```tsx +const table = useAppTable( + { + key: 'users-table', + columns, + data, + debugTable: true, + }, + (state) => state, +) +``` + +The returned table includes `AppTable`, `AppHeader`, `AppCell`, and `AppFooter` wrappers. The example uses `AppTable` with a selector so rendering can subscribe to the state slices used by that table. + +```tsx + ({ + pagination: state.pagination, + sorting: state.sorting, + columnFilters: state.columnFilters, + })} +> + {({ sorting, columnFilters }) => ( +
+ + + + + {table.getHeaderGroups().map((headerGroup) => ( + + {headerGroup.headers.map((h) => ( + + {(header) => ( + + )} + + ))} + + ))} + + + {table.getRowModel().rows.map((row) => ( + + {row.getAllCells().map((c) => ( + + {(cell) => ( + + )} + + ))} + + ))} + +
+ + + +
+ +
+ + + +
+ )} + +``` + +## Reusing The Hook + +The example creates both `personColumnHelper` and `productColumnHelper` from the same `createAppColumnHelper`, then renders Users and Products tables with the same `useAppTable` factory. Each table owns its data and columns, while the app hook owns table infrastructure and component conventions. diff --git a/docs/framework/react/guide/create-table-hook.md b/docs/framework/react/guide/create-table-hook.md deleted file mode 100644 index eb19d9d9fb..0000000000 --- a/docs/framework/react/guide/create-table-hook.md +++ /dev/null @@ -1,281 +0,0 @@ ---- -title: createTableHook Guide ---- - -`createTableHook` is an advanced API for building reusable, composable table configurations. It lets you define features, row models, and pre-bound components once, then reuse them across multiple tables with minimal boilerplate. It is inspired by [TanStack Form's `createFormHook`](https://tanstack.com/form/latest/docs/framework/react/guides/form-composition). - -> **When to use it:** Use `createTableHook` when you have multiple tables that share the same configuration (features, row models, and reusable components). For a single table, `useTable` is sufficient. - -## Examples - -- [Composable Tables](../examples/composable-tables) — Two tables (Users and Products) sharing the same `createTableHook` configuration, with table/cell/header components, sorting, filtering, and pagination. -- [Basic useAppTable](../examples/basic-use-app-table) — Minimal example using `createTableHook` with no pre-bound components. - -## Setup - -Create a shared table configuration file and call `createTableHook` with your features, row models, and component registries: - -```tsx -// hooks/table.ts - -import { - createTableHook, - tableFeatures, - columnFilteringFeature, - rowPaginationFeature, - rowSortingFeature, - createFilteredRowModel, - createPaginatedRowModel, - createSortedRowModel, - filterFns, - sortFns, -} from '@tanstack/react-table' - -import { PaginationControls, RowCount, TableToolbar } from '../components/table-components' -import { TextCell, NumberCell, StatusCell, ProgressCell } from '../components/cell-components' -import { SortIndicator, ColumnFilter } from '../components/header-components' - -export const { - createAppColumnHelper, - useAppTable, - useTableContext, - useCellContext, - useHeaderContext, -} = createTableHook({ - features: tableFeatures({ - columnFilteringFeature, - rowPaginationFeature, - rowSortingFeature, - }), - - rowModels: { - sortedRowModel: createSortedRowModel(sortFns), - filteredRowModel: createFilteredRowModel(filterFns), - paginatedRowModel: createPaginatedRowModel(), - }, - - getRowId: (row) => row.id, - - tableComponents: { - PaginationControls, - RowCount, - TableToolbar, - }, - - cellComponents: { - TextCell, - NumberCell, - StatusCell, - ProgressCell, - }, - - headerComponents: { - SortIndicator, - ColumnFilter, - }, -}) -``` - -## What `createTableHook` Returns - -| Export | Description | -|--------|-------------| -| `useAppTable` | Hook for creating tables. Merges default options from the hook with per-table options. No need to pass `features` or `rowModels`—they come from the hook. | -| `createAppColumnHelper` | Column helper with `TFeatures` pre-bound. Only requires `TData`. Use `createAppColumnHelper()` instead of `createColumnHelper()`. | -| `useTableContext` | Access the table instance inside `tableComponents`. | -| `useCellContext` | Access the cell instance inside `cellComponents`. | -| `useHeaderContext` | Access the header instance inside `headerComponents`. | - -## Component Registries - -### `tableComponents` - -Components that need access to the **table instance**. They are attached to the table object, so you use them as `table.PaginationControls`, `table.RowCount`, etc. - -Use `useTableContext()` inside these components: - -```tsx -export function PaginationControls() { - const table = useTableContext() - - return ( -
- - -
- ) -} -``` - -### `cellComponents` - -Components that render **cell content**. They are attached to the `cell` object in column definitions, so you use them as `cell.TextCell`, `cell.NumberCell`, etc. - -Use `useCellContext()` inside these components: - -```tsx -export function TextCell() { - const cell = useCellContext() - return {cell.getValue()} -} - -export function NumberCell() { - const cell = useCellContext() - return {cell.getValue().toLocaleString()} -} -``` - -### `headerComponents` - -Components that render **header/footer content**. They are attached to the `header` object, so you use them as `header.SortIndicator`, `header.ColumnFilter`, etc. - -Use `useHeaderContext()` inside these components: - -```tsx -export function SortIndicator() { - const header = useHeaderContext() - const sorted = header.column.getIsSorted() - if (!sorted) return null - return {sorted === 'asc' ? '🔼' : '🔽'} -} -``` - -## Using `useAppTable` - -Create tables with `useAppTable`—`features` and `rowModels` are inherited from the hook: - -```tsx -const personColumnHelper = createAppColumnHelper() - -function UsersTable() { - const [data, setData] = useState(() => makeData(1000)) - - const columns = useMemo( - () => - personColumnHelper.columns([ - personColumnHelper.accessor('firstName', { - header: 'First Name', - cell: ({ cell }) => , - }), - personColumnHelper.accessor('age', { - header: 'Age', - cell: ({ cell }) => , - }), - personColumnHelper.accessor('status', { - header: 'Status', - cell: ({ cell }) => , - }), - ]), - [], - ) - - const table = useAppTable({ - columns, - data, - debugTable: true, - }) - - return ( - ({ pagination: state.pagination, sorting: state.sorting })}> - {({ sorting }) => ( -
- setData(makeData(1000))} /> - - - {table.getHeaderGroups().map((headerGroup) => ( - - {headerGroup.headers.map((h) => ( - - {(header) => ( - - )} - - ))} - - ))} - - - {table.getRowModel().rows.map((row) => ( - - {row.getAllCells().map((c) => ( - - {(cell) => } - - ))} - - ))} - -
- - - -
- - -
- )} - - ) -} -``` - -## AppTable, AppHeader, AppCell, AppFooter - -The table returned by `useAppTable` includes wrapper components that provide context to your registered components: - -- **`table.AppTable`** — Wraps the table UI and provides a `selector` prop for optimized re-renders. Renders its children with the selected state. -- **`table.AppHeader`** — Wraps a header and provides the enhanced `header` context (with `header.SortIndicator`, `header.ColumnFilter`, etc.) to its render prop. -- **`table.AppCell`** — Wraps a cell and provides the enhanced `cell` context (with `cell.TextCell`, `cell.FlexRender`, etc.) to its render prop. -- **`table.AppFooter`** — Same as AppHeader but for footer cells. - -## Optimized Rendering with `selector` - -Pass a `selector` to `table.AppTable` to subscribe only to the state slices you need. This reduces re-renders when other state (e.g., column filters) changes but your component doesn't use it: - -```tsx - ({ - pagination: state.pagination, - sorting: state.sorting, - columnFilters: state.columnFilters, - })} -> - {({ sorting, columnFilters }) => ( - // This only re-renders when pagination, sorting, or columnFilters change -
...
- )} - -``` - -For v8-style behavior (re-render on any state change), pass `(state) => state`. - -## Multiple Table Configurations - -You can call `createTableHook` multiple times for different parts of your app: - -```tsx -// admin-tables.ts -export const { useAppTable: useAdminTable, createAppColumnHelper: createAdminColumnHelper } = - createTableHook({ - features: tableFeatures({ rowSortingFeature, columnFilteringFeature, rowSelectionFeature }), - rowModels: { /* ... */ }, - cellComponents: { EditableCell, DeleteButton }, - }) - -// readonly-tables.ts -export const { useAppTable: useReadonlyTable, createAppColumnHelper: createReadonlyColumnHelper } = - createTableHook({ - features: tableFeatures({ rowSortingFeature }), - rowModels: { /* ... */ }, - cellComponents: { TextCell, NumberCell }, - }) -``` - -## See Also - -- [Migrating to v9](./migrating) — Includes a createTableHook section -- [Composable Tables example](../examples/composable-tables) — Full implementation with two tables diff --git a/docs/framework/react/react-table.md b/docs/framework/react/react-table.md index e8ab0738ea..ce144da9b3 100644 --- a/docs/framework/react/react-table.md +++ b/docs/framework/react/react-table.md @@ -150,7 +150,7 @@ function App({ data }: { data: Person[] }) { } ``` -See the [createTableHook Guide](./guide/create-table-hook.md) and the [Composable Tables example](./examples/composable-tables) for the full pattern. +See the [Composable Tables Guide](./guide/composable-tables.md) and the [Composable Tables example](./examples/composable-tables) for the full pattern. ## API Reference diff --git a/docs/framework/react/reference/index/interfaces/AppCellPropsWithSelector.md b/docs/framework/react/reference/index/interfaces/AppCellPropsWithSelector.md index 450dc39ea0..6f4f5715a5 100644 --- a/docs/framework/react/reference/index/interfaces/AppCellPropsWithSelector.md +++ b/docs/framework/react/reference/index/interfaces/AppCellPropsWithSelector.md @@ -55,7 +55,7 @@ Defined in: [createTableHook.tsx:321](https://github.com/TanStack/table/blob/mai ##### cell -`Cell_Cell`\<`TFeatures`, `TData`, `TValue`\> & `UnionToIntersection`\<`"columnGroupingFeature"` *extends* keyof `TFeatures` ? `Cell_ColumnGrouping` : `never`\> & `UnionToIntersection`\<\{ \[K in string \| number \| symbol\]: K extends "coreReativityFeature" ? never : TFeatures\[K\] extends TableFeature\ ? "Cell" extends keyof FeatureConstructorOptions ? FeatureConstructorOptions\[keyof (...) & "Cell"\] : never : any \}\[keyof `TFeatures`\]\> & `Cell_Plugins`\<`TFeatures`, `TData`, `TValue`\> & `TCellComponents` & `object` +`Cell_Core`\<`TFeatures`, `TData`, `TValue`\> & `ExtractFeatureMapTypes`\<`TFeatures`, `Cell_FeatureMap`\> & `TCellComponents` & `object` ##### state diff --git a/docs/framework/react/reference/index/interfaces/AppCellPropsWithoutSelector.md b/docs/framework/react/reference/index/interfaces/AppCellPropsWithoutSelector.md index be593f57dc..42cf968658 100644 --- a/docs/framework/react/reference/index/interfaces/AppCellPropsWithoutSelector.md +++ b/docs/framework/react/reference/index/interfaces/AppCellPropsWithoutSelector.md @@ -51,7 +51,7 @@ Defined in: [createTableHook.tsx:303](https://github.com/TanStack/table/blob/mai ##### cell -`Cell_Cell`\<`TFeatures`, `TData`, `TValue`\> & `UnionToIntersection`\<`"columnGroupingFeature"` *extends* keyof `TFeatures` ? `Cell_ColumnGrouping` : `never`\> & `UnionToIntersection`\<\{ \[K in string \| number \| symbol\]: K extends "coreReativityFeature" ? never : TFeatures\[K\] extends TableFeature\ ? "Cell" extends keyof FeatureConstructorOptions ? FeatureConstructorOptions\[keyof (...) & "Cell"\] : never : any \}\[keyof `TFeatures`\]\> & `Cell_Plugins`\<`TFeatures`, `TData`, `TValue`\> & `TCellComponents` & `object` +`Cell_Core`\<`TFeatures`, `TData`, `TValue`\> & `ExtractFeatureMapTypes`\<`TFeatures`, `Cell_FeatureMap`\> & `TCellComponents` & `object` #### Returns diff --git a/docs/framework/react/reference/index/interfaces/AppHeaderPropsWithSelector.md b/docs/framework/react/reference/index/interfaces/AppHeaderPropsWithSelector.md index 2aa3f06cc6..5f7e6d923d 100644 --- a/docs/framework/react/reference/index/interfaces/AppHeaderPropsWithSelector.md +++ b/docs/framework/react/reference/index/interfaces/AppHeaderPropsWithSelector.md @@ -45,9 +45,7 @@ Defined in: [createTableHook.tsx:357](https://github.com/TanStack/table/blob/mai ##### header -`Header_Core`\<`TFeatures`, `TData`, `TValue`\> & `UnionToIntersection`\< - \| `"columnSizingFeature"` *extends* keyof `TFeatures` ? `Header_ColumnSizing` : `never` - \| `"columnResizingFeature"` *extends* keyof `TFeatures` ? `Header_ColumnResizing` : `never`\> & `UnionToIntersection`\<\{ \[K in string \| number \| symbol\]: K extends "coreReativityFeature" ? never : TFeatures\[K\] extends TableFeature\ ? "Header" extends keyof FeatureConstructorOptions ? FeatureConstructorOptions\[keyof (...) & "Header"\] : never : any \}\[keyof `TFeatures`\]\> & `Header_Plugins`\<`TFeatures`, `TData`, `TValue`\> & `THeaderComponents` & `object` +`Header_Core`\<`TFeatures`, `TData`, `TValue`\> & `ExtractFeatureMapTypes`\<`TFeatures`, `Header_FeatureMap`\> & `THeaderComponents` & `object` ##### state diff --git a/docs/framework/react/reference/index/interfaces/AppHeaderPropsWithoutSelector.md b/docs/framework/react/reference/index/interfaces/AppHeaderPropsWithoutSelector.md index 4636e9a882..2a768aa7e8 100644 --- a/docs/framework/react/reference/index/interfaces/AppHeaderPropsWithoutSelector.md +++ b/docs/framework/react/reference/index/interfaces/AppHeaderPropsWithoutSelector.md @@ -41,9 +41,7 @@ Defined in: [createTableHook.tsx:339](https://github.com/TanStack/table/blob/mai ##### header -`Header_Core`\<`TFeatures`, `TData`, `TValue`\> & `UnionToIntersection`\< - \| `"columnSizingFeature"` *extends* keyof `TFeatures` ? `Header_ColumnSizing` : `never` - \| `"columnResizingFeature"` *extends* keyof `TFeatures` ? `Header_ColumnResizing` : `never`\> & `UnionToIntersection`\<\{ \[K in string \| number \| symbol\]: K extends "coreReativityFeature" ? never : TFeatures\[K\] extends TableFeature\ ? "Header" extends keyof FeatureConstructorOptions ? FeatureConstructorOptions\[keyof (...) & "Header"\] : never : any \}\[keyof `TFeatures`\]\> & `Header_Plugins`\<`TFeatures`, `TData`, `TValue`\> & `THeaderComponents` & `object` +`Header_Core`\<`TFeatures`, `TData`, `TValue`\> & `ExtractFeatureMapTypes`\<`TFeatures`, `Header_FeatureMap`\> & `THeaderComponents` & `object` #### Returns diff --git a/docs/framework/react/reference/legacy/functions/getCoreRowModel.md b/docs/framework/react/reference/legacy/functions/getCoreRowModel.md index 9af0642090..c01728ee04 100644 --- a/docs/framework/react/reference/legacy/functions/getCoreRowModel.md +++ b/docs/framework/react/reference/legacy/functions/getCoreRowModel.md @@ -9,7 +9,7 @@ title: getCoreRowModel function getCoreRowModel(): RowModelFactory; ``` -Defined in: [useLegacyTable.ts:149](https://github.com/TanStack/table/blob/main/packages/react-table/src/useLegacyTable.ts#L149) +Defined in: [useLegacyTable.ts:150](https://github.com/TanStack/table/blob/main/packages/react-table/src/useLegacyTable.ts#L150) ## Type Parameters diff --git a/docs/framework/react/reference/legacy/functions/getExpandedRowModel.md b/docs/framework/react/reference/legacy/functions/getExpandedRowModel.md index 7748277456..e1ebe4dbdd 100644 --- a/docs/framework/react/reference/legacy/functions/getExpandedRowModel.md +++ b/docs/framework/react/reference/legacy/functions/getExpandedRowModel.md @@ -9,7 +9,7 @@ title: getExpandedRowModel function getExpandedRowModel(): RowModelFactory; ``` -Defined in: [useLegacyTable.ts:89](https://github.com/TanStack/table/blob/main/packages/react-table/src/useLegacyTable.ts#L89) +Defined in: [useLegacyTable.ts:90](https://github.com/TanStack/table/blob/main/packages/react-table/src/useLegacyTable.ts#L90) ## Type Parameters diff --git a/docs/framework/react/reference/legacy/functions/getFacetedMinMaxValues.md b/docs/framework/react/reference/legacy/functions/getFacetedMinMaxValues.md index 04f865f813..959cf32bfe 100644 --- a/docs/framework/react/reference/legacy/functions/getFacetedMinMaxValues.md +++ b/docs/framework/react/reference/legacy/functions/getFacetedMinMaxValues.md @@ -9,7 +9,7 @@ title: getFacetedMinMaxValues function getFacetedMinMaxValues(): FacetedMinMaxValuesFactory; ``` -Defined in: [useLegacyTable.ts:125](https://github.com/TanStack/table/blob/main/packages/react-table/src/useLegacyTable.ts#L125) +Defined in: [useLegacyTable.ts:126](https://github.com/TanStack/table/blob/main/packages/react-table/src/useLegacyTable.ts#L126) ## Type Parameters diff --git a/docs/framework/react/reference/legacy/functions/getFacetedRowModel.md b/docs/framework/react/reference/legacy/functions/getFacetedRowModel.md index eaf2e14d0c..d1d2a36bf8 100644 --- a/docs/framework/react/reference/legacy/functions/getFacetedRowModel.md +++ b/docs/framework/react/reference/legacy/functions/getFacetedRowModel.md @@ -9,7 +9,7 @@ title: getFacetedRowModel function getFacetedRowModel(): FacetedRowModelFactory; ``` -Defined in: [useLegacyTable.ts:113](https://github.com/TanStack/table/blob/main/packages/react-table/src/useLegacyTable.ts#L113) +Defined in: [useLegacyTable.ts:114](https://github.com/TanStack/table/blob/main/packages/react-table/src/useLegacyTable.ts#L114) ## Type Parameters diff --git a/docs/framework/react/reference/legacy/functions/getFacetedUniqueValues.md b/docs/framework/react/reference/legacy/functions/getFacetedUniqueValues.md index bfad0c8d02..25cdcc6e35 100644 --- a/docs/framework/react/reference/legacy/functions/getFacetedUniqueValues.md +++ b/docs/framework/react/reference/legacy/functions/getFacetedUniqueValues.md @@ -9,7 +9,7 @@ title: getFacetedUniqueValues function getFacetedUniqueValues(): FacetedUniqueValuesFactory; ``` -Defined in: [useLegacyTable.ts:137](https://github.com/TanStack/table/blob/main/packages/react-table/src/useLegacyTable.ts#L137) +Defined in: [useLegacyTable.ts:138](https://github.com/TanStack/table/blob/main/packages/react-table/src/useLegacyTable.ts#L138) ## Type Parameters diff --git a/docs/framework/react/reference/legacy/functions/getFilteredRowModel.md b/docs/framework/react/reference/legacy/functions/getFilteredRowModel.md index 3ecb26e39f..4e53c9bdcc 100644 --- a/docs/framework/react/reference/legacy/functions/getFilteredRowModel.md +++ b/docs/framework/react/reference/legacy/functions/getFilteredRowModel.md @@ -9,7 +9,7 @@ title: getFilteredRowModel function getFilteredRowModel(): RowModelFactory; ``` -Defined in: [useLegacyTable.ts:53](https://github.com/TanStack/table/blob/main/packages/react-table/src/useLegacyTable.ts#L53) +Defined in: [useLegacyTable.ts:54](https://github.com/TanStack/table/blob/main/packages/react-table/src/useLegacyTable.ts#L54) ## Type Parameters diff --git a/docs/framework/react/reference/legacy/functions/getGroupedRowModel.md b/docs/framework/react/reference/legacy/functions/getGroupedRowModel.md index 92b173ea8d..b6723147c5 100644 --- a/docs/framework/react/reference/legacy/functions/getGroupedRowModel.md +++ b/docs/framework/react/reference/legacy/functions/getGroupedRowModel.md @@ -9,7 +9,7 @@ title: getGroupedRowModel function getGroupedRowModel(): RowModelFactory; ``` -Defined in: [useLegacyTable.ts:101](https://github.com/TanStack/table/blob/main/packages/react-table/src/useLegacyTable.ts#L101) +Defined in: [useLegacyTable.ts:102](https://github.com/TanStack/table/blob/main/packages/react-table/src/useLegacyTable.ts#L102) ## Type Parameters diff --git a/docs/framework/react/reference/legacy/functions/getPaginationRowModel.md b/docs/framework/react/reference/legacy/functions/getPaginationRowModel.md index e0f8cf72d7..1ccfcd8621 100644 --- a/docs/framework/react/reference/legacy/functions/getPaginationRowModel.md +++ b/docs/framework/react/reference/legacy/functions/getPaginationRowModel.md @@ -9,7 +9,7 @@ title: getPaginationRowModel function getPaginationRowModel(): RowModelFactory; ``` -Defined in: [useLegacyTable.ts:77](https://github.com/TanStack/table/blob/main/packages/react-table/src/useLegacyTable.ts#L77) +Defined in: [useLegacyTable.ts:78](https://github.com/TanStack/table/blob/main/packages/react-table/src/useLegacyTable.ts#L78) ## Type Parameters diff --git a/docs/framework/react/reference/legacy/functions/getSortedRowModel.md b/docs/framework/react/reference/legacy/functions/getSortedRowModel.md index 53ed570ccf..c60dd5323d 100644 --- a/docs/framework/react/reference/legacy/functions/getSortedRowModel.md +++ b/docs/framework/react/reference/legacy/functions/getSortedRowModel.md @@ -9,7 +9,7 @@ title: getSortedRowModel function getSortedRowModel(): RowModelFactory; ``` -Defined in: [useLegacyTable.ts:65](https://github.com/TanStack/table/blob/main/packages/react-table/src/useLegacyTable.ts#L65) +Defined in: [useLegacyTable.ts:66](https://github.com/TanStack/table/blob/main/packages/react-table/src/useLegacyTable.ts#L66) ## Type Parameters diff --git a/docs/framework/react/reference/legacy/functions/legacyCreateColumnHelper.md b/docs/framework/react/reference/legacy/functions/legacyCreateColumnHelper.md index 543816bf5c..d2bb7310b0 100644 --- a/docs/framework/react/reference/legacy/functions/legacyCreateColumnHelper.md +++ b/docs/framework/react/reference/legacy/functions/legacyCreateColumnHelper.md @@ -9,7 +9,7 @@ title: legacyCreateColumnHelper function legacyCreateColumnHelper(): ColumnHelper; ``` -Defined in: [useLegacyTable.ts:345](https://github.com/TanStack/table/blob/main/packages/react-table/src/useLegacyTable.ts#L345) +Defined in: [useLegacyTable.ts:346](https://github.com/TanStack/table/blob/main/packages/react-table/src/useLegacyTable.ts#L346) ## Type Parameters diff --git a/docs/framework/react/reference/legacy/functions/useLegacyTable.md b/docs/framework/react/reference/legacy/functions/useLegacyTable.md index 3b5e668ea7..c3baa57a9c 100644 --- a/docs/framework/react/reference/legacy/functions/useLegacyTable.md +++ b/docs/framework/react/reference/legacy/functions/useLegacyTable.md @@ -9,7 +9,7 @@ title: useLegacyTable function useLegacyTable(options): LegacyReactTable; ``` -Defined in: [useLegacyTable.ts:387](https://github.com/TanStack/table/blob/main/packages/react-table/src/useLegacyTable.ts#L387) +Defined in: [useLegacyTable.ts:391](https://github.com/TanStack/table/blob/main/packages/react-table/src/useLegacyTable.ts#L391) ## Type Parameters diff --git a/docs/framework/react/reference/legacy/interfaces/LegacyRowModelOptions.md b/docs/framework/react/reference/legacy/interfaces/LegacyRowModelOptions.md index 060090cd58..250573f1c2 100644 --- a/docs/framework/react/reference/legacy/interfaces/LegacyRowModelOptions.md +++ b/docs/framework/react/reference/legacy/interfaces/LegacyRowModelOptions.md @@ -5,7 +5,7 @@ title: LegacyRowModelOptions # Interface: LegacyRowModelOptions\ -Defined in: [useLegacyTable.ts:193](https://github.com/TanStack/table/blob/main/packages/react-table/src/useLegacyTable.ts#L193) +Defined in: [useLegacyTable.ts:194](https://github.com/TanStack/table/blob/main/packages/react-table/src/useLegacyTable.ts#L194) Legacy v8-style row model options @@ -23,7 +23,7 @@ Legacy v8-style row model options optional aggregationFns: AggregationFns; ``` -Defined in: [useLegacyTable.ts:253](https://github.com/TanStack/table/blob/main/packages/react-table/src/useLegacyTable.ts#L253) +Defined in: [useLegacyTable.ts:254](https://github.com/TanStack/table/blob/main/packages/react-table/src/useLegacyTable.ts#L254) Additional aggregation functions to apply to the table. @@ -39,7 +39,7 @@ Use `rowModels.groupedRowModel` with `createGroupedRowModel(aggregationFns)` ins optional filterFns: FilterFns; ``` -Defined in: [useLegacyTable.ts:243](https://github.com/TanStack/table/blob/main/packages/react-table/src/useLegacyTable.ts#L243) +Defined in: [useLegacyTable.ts:244](https://github.com/TanStack/table/blob/main/packages/react-table/src/useLegacyTable.ts#L244) Additional filter functions to apply to the table. @@ -55,7 +55,7 @@ Use `rowModels.filteredRowModel` with `createFilteredRowModel(filterFns)` instea optional getCoreRowModel: RowModelFactory; ``` -Defined in: [useLegacyTable.ts:198](https://github.com/TanStack/table/blob/main/packages/react-table/src/useLegacyTable.ts#L198) +Defined in: [useLegacyTable.ts:199](https://github.com/TanStack/table/blob/main/packages/react-table/src/useLegacyTable.ts#L199) Returns the core row model for the table. @@ -71,7 +71,7 @@ This option is no longer needed in v9. The core row model is always created auto optional getExpandedRowModel: RowModelFactory; ``` -Defined in: [useLegacyTable.ts:218](https://github.com/TanStack/table/blob/main/packages/react-table/src/useLegacyTable.ts#L218) +Defined in: [useLegacyTable.ts:219](https://github.com/TanStack/table/blob/main/packages/react-table/src/useLegacyTable.ts#L219) Returns the expanded row model for the table. @@ -87,7 +87,7 @@ Use `rowModels.expandedRowModel` with `createExpandedRowModel()` instead. optional getFacetedMinMaxValues: FacetedMinMaxValuesFactory; ``` -Defined in: [useLegacyTable.ts:233](https://github.com/TanStack/table/blob/main/packages/react-table/src/useLegacyTable.ts#L233) +Defined in: [useLegacyTable.ts:234](https://github.com/TanStack/table/blob/main/packages/react-table/src/useLegacyTable.ts#L234) Returns the faceted min/max values for a column. @@ -103,7 +103,7 @@ Use `rowModels.facetedMinMaxValues` with `createFacetedMinMaxValues()` instead. optional getFacetedRowModel: FacetedRowModelFactory; ``` -Defined in: [useLegacyTable.ts:228](https://github.com/TanStack/table/blob/main/packages/react-table/src/useLegacyTable.ts#L228) +Defined in: [useLegacyTable.ts:229](https://github.com/TanStack/table/blob/main/packages/react-table/src/useLegacyTable.ts#L229) Returns the faceted row model for a column. @@ -119,7 +119,7 @@ Use `rowModels.facetedRowModel` with `createFacetedRowModel()` instead. optional getFacetedUniqueValues: FacetedUniqueValuesFactory; ``` -Defined in: [useLegacyTable.ts:238](https://github.com/TanStack/table/blob/main/packages/react-table/src/useLegacyTable.ts#L238) +Defined in: [useLegacyTable.ts:239](https://github.com/TanStack/table/blob/main/packages/react-table/src/useLegacyTable.ts#L239) Returns the faceted unique values for a column. @@ -135,7 +135,7 @@ Use `rowModels.facetedUniqueValues` with `createFacetedUniqueValues()` instead. optional getFilteredRowModel: RowModelFactory; ``` -Defined in: [useLegacyTable.ts:203](https://github.com/TanStack/table/blob/main/packages/react-table/src/useLegacyTable.ts#L203) +Defined in: [useLegacyTable.ts:204](https://github.com/TanStack/table/blob/main/packages/react-table/src/useLegacyTable.ts#L204) Returns the filtered row model for the table. @@ -151,7 +151,7 @@ Use `rowModels.filteredRowModel` with `createFilteredRowModel(filterFns)` instea optional getGroupedRowModel: RowModelFactory; ``` -Defined in: [useLegacyTable.ts:223](https://github.com/TanStack/table/blob/main/packages/react-table/src/useLegacyTable.ts#L223) +Defined in: [useLegacyTable.ts:224](https://github.com/TanStack/table/blob/main/packages/react-table/src/useLegacyTable.ts#L224) Returns the grouped row model for the table. @@ -167,7 +167,7 @@ Use `rowModels.groupedRowModel` with `createGroupedRowModel(aggregationFns)` ins optional getPaginationRowModel: RowModelFactory; ``` -Defined in: [useLegacyTable.ts:213](https://github.com/TanStack/table/blob/main/packages/react-table/src/useLegacyTable.ts#L213) +Defined in: [useLegacyTable.ts:214](https://github.com/TanStack/table/blob/main/packages/react-table/src/useLegacyTable.ts#L214) Returns the paginated row model for the table. @@ -183,7 +183,7 @@ Use `rowModels.paginatedRowModel` with `createPaginatedRowModel()` instead. optional getSortedRowModel: RowModelFactory; ``` -Defined in: [useLegacyTable.ts:208](https://github.com/TanStack/table/blob/main/packages/react-table/src/useLegacyTable.ts#L208) +Defined in: [useLegacyTable.ts:209](https://github.com/TanStack/table/blob/main/packages/react-table/src/useLegacyTable.ts#L209) Returns the sorted row model for the table. @@ -199,7 +199,7 @@ Use `rowModels.sortedRowModel` with `createSortedRowModel(sortFns)` instead. optional sortFns: SortFns; ``` -Defined in: [useLegacyTable.ts:248](https://github.com/TanStack/table/blob/main/packages/react-table/src/useLegacyTable.ts#L248) +Defined in: [useLegacyTable.ts:249](https://github.com/TanStack/table/blob/main/packages/react-table/src/useLegacyTable.ts#L249) Additional sort functions to apply to the table. diff --git a/docs/framework/react/reference/legacy/type-aliases/FacetedMinMaxValuesFactory.md b/docs/framework/react/reference/legacy/type-aliases/FacetedMinMaxValuesFactory.md index d3ca59bf3a..b5a54ae43e 100644 --- a/docs/framework/react/reference/legacy/type-aliases/FacetedMinMaxValuesFactory.md +++ b/docs/framework/react/reference/legacy/type-aliases/FacetedMinMaxValuesFactory.md @@ -9,7 +9,7 @@ title: FacetedMinMaxValuesFactory type FacetedMinMaxValuesFactory = (table, columnId) => () => undefined | [number, number]; ``` -Defined in: [useLegacyTable.ts:177](https://github.com/TanStack/table/blob/main/packages/react-table/src/useLegacyTable.ts#L177) +Defined in: [useLegacyTable.ts:178](https://github.com/TanStack/table/blob/main/packages/react-table/src/useLegacyTable.ts#L178) Faceted min/max values factory function type from v8 API diff --git a/docs/framework/react/reference/legacy/type-aliases/FacetedRowModelFactory.md b/docs/framework/react/reference/legacy/type-aliases/FacetedRowModelFactory.md index 6c27a6aa03..cef731c3c2 100644 --- a/docs/framework/react/reference/legacy/type-aliases/FacetedRowModelFactory.md +++ b/docs/framework/react/reference/legacy/type-aliases/FacetedRowModelFactory.md @@ -9,7 +9,7 @@ title: FacetedRowModelFactory type FacetedRowModelFactory = (table, columnId) => () => RowModel; ``` -Defined in: [useLegacyTable.ts:169](https://github.com/TanStack/table/blob/main/packages/react-table/src/useLegacyTable.ts#L169) +Defined in: [useLegacyTable.ts:170](https://github.com/TanStack/table/blob/main/packages/react-table/src/useLegacyTable.ts#L170) Faceted row model factory function type from v8 API diff --git a/docs/framework/react/reference/legacy/type-aliases/FacetedUniqueValuesFactory.md b/docs/framework/react/reference/legacy/type-aliases/FacetedUniqueValuesFactory.md index a73bd23fe8..e5a700b985 100644 --- a/docs/framework/react/reference/legacy/type-aliases/FacetedUniqueValuesFactory.md +++ b/docs/framework/react/reference/legacy/type-aliases/FacetedUniqueValuesFactory.md @@ -9,7 +9,7 @@ title: FacetedUniqueValuesFactory type FacetedUniqueValuesFactory = (table, columnId) => () => Map; ``` -Defined in: [useLegacyTable.ts:185](https://github.com/TanStack/table/blob/main/packages/react-table/src/useLegacyTable.ts#L185) +Defined in: [useLegacyTable.ts:186](https://github.com/TanStack/table/blob/main/packages/react-table/src/useLegacyTable.ts#L186) Faceted unique values factory function type from v8 API diff --git a/docs/framework/react/reference/legacy/type-aliases/LegacyCell.md b/docs/framework/react/reference/legacy/type-aliases/LegacyCell.md index 00f35e697b..7ea9e41767 100644 --- a/docs/framework/react/reference/legacy/type-aliases/LegacyCell.md +++ b/docs/framework/react/reference/legacy/type-aliases/LegacyCell.md @@ -9,7 +9,7 @@ title: LegacyCell type LegacyCell = Cell; ``` -Defined in: [useLegacyTable.ts:307](https://github.com/TanStack/table/blob/main/packages/react-table/src/useLegacyTable.ts#L307) +Defined in: [useLegacyTable.ts:308](https://github.com/TanStack/table/blob/main/packages/react-table/src/useLegacyTable.ts#L308) ## Type Parameters diff --git a/docs/framework/react/reference/legacy/type-aliases/LegacyColumn.md b/docs/framework/react/reference/legacy/type-aliases/LegacyColumn.md index 4b44ae6069..a75c06fbc1 100644 --- a/docs/framework/react/reference/legacy/type-aliases/LegacyColumn.md +++ b/docs/framework/react/reference/legacy/type-aliases/LegacyColumn.md @@ -9,7 +9,7 @@ title: LegacyColumn type LegacyColumn = Column; ``` -Defined in: [useLegacyTable.ts:297](https://github.com/TanStack/table/blob/main/packages/react-table/src/useLegacyTable.ts#L297) +Defined in: [useLegacyTable.ts:298](https://github.com/TanStack/table/blob/main/packages/react-table/src/useLegacyTable.ts#L298) ## Type Parameters diff --git a/docs/framework/react/reference/legacy/type-aliases/LegacyColumnDef.md b/docs/framework/react/reference/legacy/type-aliases/LegacyColumnDef.md index 8ed0d7dcd7..c2ba047b19 100644 --- a/docs/framework/react/reference/legacy/type-aliases/LegacyColumnDef.md +++ b/docs/framework/react/reference/legacy/type-aliases/LegacyColumnDef.md @@ -9,7 +9,7 @@ title: LegacyColumnDef type LegacyColumnDef = ColumnDef; ``` -Defined in: [useLegacyTable.ts:327](https://github.com/TanStack/table/blob/main/packages/react-table/src/useLegacyTable.ts#L327) +Defined in: [useLegacyTable.ts:328](https://github.com/TanStack/table/blob/main/packages/react-table/src/useLegacyTable.ts#L328) ## Type Parameters diff --git a/docs/framework/react/reference/legacy/type-aliases/LegacyHeader.md b/docs/framework/react/reference/legacy/type-aliases/LegacyHeader.md index c13ad0c498..123612a10a 100644 --- a/docs/framework/react/reference/legacy/type-aliases/LegacyHeader.md +++ b/docs/framework/react/reference/legacy/type-aliases/LegacyHeader.md @@ -9,7 +9,7 @@ title: LegacyHeader type LegacyHeader = Header; ``` -Defined in: [useLegacyTable.ts:314](https://github.com/TanStack/table/blob/main/packages/react-table/src/useLegacyTable.ts#L314) +Defined in: [useLegacyTable.ts:315](https://github.com/TanStack/table/blob/main/packages/react-table/src/useLegacyTable.ts#L315) ## Type Parameters diff --git a/docs/framework/react/reference/legacy/type-aliases/LegacyHeaderGroup.md b/docs/framework/react/reference/legacy/type-aliases/LegacyHeaderGroup.md index c38b276b4b..58d43eb843 100644 --- a/docs/framework/react/reference/legacy/type-aliases/LegacyHeaderGroup.md +++ b/docs/framework/react/reference/legacy/type-aliases/LegacyHeaderGroup.md @@ -9,7 +9,7 @@ title: LegacyHeaderGroup type LegacyHeaderGroup = HeaderGroup; ``` -Defined in: [useLegacyTable.ts:321](https://github.com/TanStack/table/blob/main/packages/react-table/src/useLegacyTable.ts#L321) +Defined in: [useLegacyTable.ts:322](https://github.com/TanStack/table/blob/main/packages/react-table/src/useLegacyTable.ts#L322) ## Type Parameters diff --git a/docs/framework/react/reference/legacy/type-aliases/LegacyReactTable.md b/docs/framework/react/reference/legacy/type-aliases/LegacyReactTable.md index c88d558ec7..d08eea9bae 100644 --- a/docs/framework/react/reference/legacy/type-aliases/LegacyReactTable.md +++ b/docs/framework/react/reference/legacy/type-aliases/LegacyReactTable.md @@ -9,7 +9,7 @@ title: LegacyReactTable type LegacyReactTable = ReactTable> & object; ``` -Defined in: [useLegacyTable.ts:275](https://github.com/TanStack/table/blob/main/packages/react-table/src/useLegacyTable.ts#L275) +Defined in: [useLegacyTable.ts:276](https://github.com/TanStack/table/blob/main/packages/react-table/src/useLegacyTable.ts#L276) Legacy table instance type that includes the v8-style `getState()` method. diff --git a/docs/framework/react/reference/legacy/type-aliases/LegacyRow.md b/docs/framework/react/reference/legacy/type-aliases/LegacyRow.md index 64c9f1adb1..a196f1bae1 100644 --- a/docs/framework/react/reference/legacy/type-aliases/LegacyRow.md +++ b/docs/framework/react/reference/legacy/type-aliases/LegacyRow.md @@ -9,7 +9,7 @@ title: LegacyRow type LegacyRow = Row; ``` -Defined in: [useLegacyTable.ts:304](https://github.com/TanStack/table/blob/main/packages/react-table/src/useLegacyTable.ts#L304) +Defined in: [useLegacyTable.ts:305](https://github.com/TanStack/table/blob/main/packages/react-table/src/useLegacyTable.ts#L305) ## Type Parameters diff --git a/docs/framework/react/reference/legacy/type-aliases/LegacyTable.md b/docs/framework/react/reference/legacy/type-aliases/LegacyTable.md index 0d4757e41b..9d829e0749 100644 --- a/docs/framework/react/reference/legacy/type-aliases/LegacyTable.md +++ b/docs/framework/react/reference/legacy/type-aliases/LegacyTable.md @@ -9,7 +9,7 @@ title: LegacyTable type LegacyTable = Table; ``` -Defined in: [useLegacyTable.ts:333](https://github.com/TanStack/table/blob/main/packages/react-table/src/useLegacyTable.ts#L333) +Defined in: [useLegacyTable.ts:334](https://github.com/TanStack/table/blob/main/packages/react-table/src/useLegacyTable.ts#L334) ## Type Parameters diff --git a/docs/framework/react/reference/legacy/type-aliases/LegacyTableOptions.md b/docs/framework/react/reference/legacy/type-aliases/LegacyTableOptions.md index e2b63ee894..4bab6eccb1 100644 --- a/docs/framework/react/reference/legacy/type-aliases/LegacyTableOptions.md +++ b/docs/framework/react/reference/legacy/type-aliases/LegacyTableOptions.md @@ -9,7 +9,7 @@ title: LegacyTableOptions type LegacyTableOptions = Omit, "features" | "rowModels"> & LegacyRowModelOptions; ``` -Defined in: [useLegacyTable.ts:264](https://github.com/TanStack/table/blob/main/packages/react-table/src/useLegacyTable.ts#L264) +Defined in: [useLegacyTable.ts:265](https://github.com/TanStack/table/blob/main/packages/react-table/src/useLegacyTable.ts#L265) Legacy v8-style table options that work with useLegacyTable. diff --git a/docs/framework/react/reference/legacy/type-aliases/RowModelFactory.md b/docs/framework/react/reference/legacy/type-aliases/RowModelFactory.md index fb7d34bffc..264dcff6bf 100644 --- a/docs/framework/react/reference/legacy/type-aliases/RowModelFactory.md +++ b/docs/framework/react/reference/legacy/type-aliases/RowModelFactory.md @@ -9,7 +9,7 @@ title: RowModelFactory type RowModelFactory = (table) => () => RowModel; ``` -Defined in: [useLegacyTable.ts:162](https://github.com/TanStack/table/blob/main/packages/react-table/src/useLegacyTable.ts#L162) +Defined in: [useLegacyTable.ts:163](https://github.com/TanStack/table/blob/main/packages/react-table/src/useLegacyTable.ts#L163) Row model factory function type from v8 API diff --git a/docs/framework/solid/guide/composable-tables.md b/docs/framework/solid/guide/composable-tables.md new file mode 100644 index 0000000000..44cdaf321f --- /dev/null +++ b/docs/framework/solid/guide/composable-tables.md @@ -0,0 +1,217 @@ +--- +title: Composable Tables Guide +--- + +Composable tables are app-level table factories built with `createTableHook`. They let Solid apps define shared features, row models, default options, and reusable JSX components once, then create multiple tables from that shared setup. + +Use this pattern when several tables should share behavior and rendering conventions. For one standalone table, `createTable` is usually enough. + +## Examples + +- [Composable Tables](../examples/composable-tables) - Users and Products tables sharing `src/hooks/table.ts`. +- [Basic App Table](../examples/basic-app-table) - Minimal `createTableHook` setup. + +## Setup + +The composable tables example keeps the shared configuration in `src/hooks/table.ts`. + +```tsx +import { + columnFilteringFeature, + createFilteredRowModel, + createPaginatedRowModel, + createSortedRowModel, + createTableHook, + filterFns, + rowPaginationFeature, + rowSortingFeature, + sortFns, + tableFeatures, +} from '@tanstack/solid-table' + +import { + PaginationControls, + RowCount, + TableToolbar, +} from '../components/table-components' +import { + CategoryCell, + NumberCell, + PriceCell, + ProgressCell, + RowActionsCell, + StatusCell, + TextCell, +} from '../components/cell-components' +import { + ColumnFilter, + FooterColumnId, + FooterSum, + SortIndicator, +} from '../components/header-components' + +export const { + createAppColumnHelper, + createAppTable, + useTableContext, + useCellContext, + useHeaderContext, +} = createTableHook({ + features: tableFeatures({ + columnFilteringFeature, + rowPaginationFeature, + rowSortingFeature, + }), + rowModels: { + sortedRowModel: createSortedRowModel(sortFns), + filteredRowModel: createFilteredRowModel(filterFns), + paginatedRowModel: createPaginatedRowModel(), + }, + getRowId: (row) => row.id, + tableComponents: { + PaginationControls, + RowCount, + TableToolbar, + }, + cellComponents: { + TextCell, + NumberCell, + StatusCell, + ProgressCell, + RowActionsCell, + PriceCell, + CategoryCell, + }, + headerComponents: { + SortIndicator, + ColumnFilter, + FooterColumnId, + FooterSum, + }, +}) +``` + +## Returned Helpers + +| Helper | Purpose | +|---|---| +| `createAppTable` | Creates a Solid table with shared features, row models, defaults, and registered components. | +| `createAppColumnHelper` | Creates column helpers with `TFeatures` and registered component types already bound. | +| `useTableContext` | Reads the current table inside registered table components. | +| `useCellContext` | Reads the current cell inside registered cell components. | +| `useHeaderContext` | Reads the current header/footer inside registered header components. | + +## Columns + +Create one column helper per row type. Since the helper is bound to the app setup, registered JSX components are available on cell and header contexts. + +```tsx +const personColumnHelper = createAppColumnHelper() + +const columns = personColumnHelper.columns([ + personColumnHelper.accessor('firstName', { + header: 'First Name', + footer: (props) => props.column.id, + cell: ({ cell }) => , + }), + personColumnHelper.accessor('age', { + header: 'Age', + footer: (props) => props.column.id, + cell: ({ cell }) => , + }), + personColumnHelper.display({ + id: 'actions', + header: 'Actions', + cell: ({ cell }) => , + }), +]) +``` + +## Table Rendering + +Create each table with `createAppTable`. You provide table-specific options like `key`, `columns`, and reactive data; the shared table infrastructure comes from the hook. + +```tsx +const [data, setData] = createSignal(makeData(1_000)) + +const table = createAppTable({ + key: 'users-table', + columns, + get data() { + return data() + }, + debugTable: true, +}) +``` + +The returned table includes JSX wrappers. The example uses `table.AppTable` with a selector to subscribe to the state slices used by the table UI. + +```tsx + ({ + pagination: state.pagination, + sorting: state.sorting, + columnFilters: state.columnFilters, + })} +> + {(state) => { + const sorting = () => state().sorting + + return ( +
+ + + + + + {(headerGroup) => ( + + + {(h) => ( + + {(header) => ( + + )} + + )} + + + )} + + + + + {(row) => ( + + + {(c) => ( + + {(cell) => ( + + )} + + )} + + + )} + + +
+ + + +
+ +
+ + + +
+ ) + }} + +``` + +## Reusing The Hook + +The example creates `personColumnHelper` and `productColumnHelper` from the same `createAppColumnHelper`, then creates both Users and Products tables with `createAppTable`. Each table keeps its own signals and columns, while the shared hook owns features, row models, row IDs, and component conventions. diff --git a/docs/framework/solid/reference/functions/createTable.md b/docs/framework/solid/reference/functions/createTable.md index d60f35e72a..a11a607325 100644 --- a/docs/framework/solid/reference/functions/createTable.md +++ b/docs/framework/solid/reference/functions/createTable.md @@ -6,17 +6,16 @@ title: createTable # Function: createTable() ```ts -function createTable(tableOptions, selector?): SolidTable; +function createTable(tableOptions): SolidTable; ``` -Defined in: [createTable.ts:109](https://github.com/TanStack/table/blob/main/packages/solid-table/src/createTable.ts#L109) +Defined in: [createTable.ts:69](https://github.com/TanStack/table/blob/main/packages/solid-table/src/createTable.ts#L69) Creates a Solid table instance backed by Solid-aware TanStack Store atoms. -The optional selector projects from `table.store`; the selected value is -exposed as the `table.state` accessor. Table APIs and atom reads participate -in Solid dependency tracking, so computations that read a specific slice can -update without invalidating unrelated UI. +Table APIs and atom reads participate in Solid dependency tracking, so +computations that read a specific slice can update without invalidating +unrelated UI. Use `table.Subscribe` to create atom-tracked render boundaries. ## Type Parameters @@ -28,23 +27,15 @@ update without invalidating unrelated UI. `TData` *extends* `RowData` -### TSelected - -`TSelected` = `TableState`\<`TFeatures`\> - ## Parameters ### tableOptions `TableOptions`\<`TFeatures`, `TData`\> -### selector? - -(`state`) => `TSelected` - ## Returns -[`SolidTable`](../type-aliases/SolidTable.md)\<`TFeatures`, `TData`, `TSelected`\> +[`SolidTable`](../type-aliases/SolidTable.md)\<`TFeatures`, `TData`\> ## Example @@ -56,8 +47,5 @@ const table = createTable( columns, data, }, - (state) => ({ pagination: state.pagination }), ) - -table.state().pagination ``` diff --git a/docs/framework/solid/reference/functions/createTableHook.md b/docs/framework/solid/reference/functions/createTableHook.md index 5509088f56..53994c4651 100644 --- a/docs/framework/solid/reference/functions/createTableHook.md +++ b/docs/framework/solid/reference/functions/createTableHook.md @@ -9,7 +9,7 @@ title: createTableHook function createTableHook(__namedParameters): object; ``` -Defined in: [createTableHook.tsx:611](https://github.com/TanStack/table/blob/main/packages/solid-table/src/createTableHook.tsx#L611) +Defined in: [createTableHook.tsx:508](https://github.com/TanStack/table/blob/main/packages/solid-table/src/createTableHook.tsx#L508) Creates a custom table hook with pre-bound components for composition. @@ -91,7 +91,7 @@ const columns = [ ### createAppTable() ```ts -createAppTable: (tableOptions, selector?) => AppSolidTable; +createAppTable: (tableOptions) => AppSolidTable, TTableComponents, TCellComponents, THeaderComponents>; ``` Enhanced useTable hook that returns a table with App wrapper components @@ -108,23 +108,15 @@ TFeatures is already known from the createTableHook call; TData is inferred from `TData` *extends* `RowData` -##### TSelected - -`TSelected` = `TableState`\<`TFeatures`\> - #### Parameters ##### tableOptions `Omit`\<`TableOptions`\<`TFeatures`, `TData`\>, `"features"` \| `"rowModels"`\> -##### selector? - -(`state`) => `TSelected` - #### Returns -[`AppSolidTable`](../type-aliases/AppSolidTable.md)\<`TFeatures`, `TData`, `TSelected`, `TTableComponents`, `TCellComponents`, `THeaderComponents`\> +[`AppSolidTable`](../type-aliases/AppSolidTable.md)\<`TFeatures`, `TData`, `TableState`\<`TFeatures`\>, `TTableComponents`, `TCellComponents`, `THeaderComponents`\> ### useCellContext() @@ -228,14 +220,16 @@ TFeatures is already known from the createTableHook call. function PaginationControls() { const table = useTableContext() return ( - s.pagination}> - {(pagination) => ( + + {(atoms) => { + const pagination = atoms.pagination.get() + return (
Page {pagination.pageIndex + 1}
- )} + )}} ) } @@ -273,7 +267,11 @@ const columnHelper = createAppColumnHelper() // components/table-components.tsx function PaginationControls() { const table = useTableContext() // TFeatures already known! - return s.pagination}>... + return ( + + {(atoms) => Page {atoms.pagination.get().pageIndex + 1}} + + ) } // features/users.tsx diff --git a/docs/framework/solid/reference/index.md b/docs/framework/solid/reference/index.md index 20748fc535..196c3fe9bd 100644 --- a/docs/framework/solid/reference/index.md +++ b/docs/framework/solid/reference/index.md @@ -8,14 +8,11 @@ title: "@tanstack/solid-table" ## Interfaces - [AppCellComponent](interfaces/AppCellComponent.md) -- [AppCellPropsWithoutSelector](interfaces/AppCellPropsWithoutSelector.md) -- [AppCellPropsWithSelector](interfaces/AppCellPropsWithSelector.md) +- [AppCellProps](interfaces/AppCellProps.md) - [AppHeaderComponent](interfaces/AppHeaderComponent.md) -- [AppHeaderPropsWithoutSelector](interfaces/AppHeaderPropsWithoutSelector.md) -- [AppHeaderPropsWithSelector](interfaces/AppHeaderPropsWithSelector.md) +- [AppHeaderProps](interfaces/AppHeaderProps.md) - [AppTableComponent](interfaces/AppTableComponent.md) -- [AppTablePropsWithoutSelector](interfaces/AppTablePropsWithoutSelector.md) -- [AppTablePropsWithSelector](interfaces/AppTablePropsWithSelector.md) +- [AppTableProps](interfaces/AppTableProps.md) ## Type Aliases @@ -31,7 +28,6 @@ title: "@tanstack/solid-table" - [CreateTableHookOptions](type-aliases/CreateTableHookOptions.md) - [FlexRenderProps](type-aliases/FlexRenderProps.md) - [SolidTable](type-aliases/SolidTable.md) -- [SubscribeSource](type-aliases/SubscribeSource.md) ## Functions diff --git a/docs/framework/solid/reference/interfaces/AppCellComponent.md b/docs/framework/solid/reference/interfaces/AppCellComponent.md index 97a96782dc..3e59c43cb3 100644 --- a/docs/framework/solid/reference/interfaces/AppCellComponent.md +++ b/docs/framework/solid/reference/interfaces/AppCellComponent.md @@ -5,9 +5,9 @@ title: AppCellComponent # Interface: AppCellComponent()\ -Defined in: [createTableHook.tsx:368](https://github.com/TanStack/table/blob/main/packages/solid-table/src/createTableHook.tsx#L368) +Defined in: [createTableHook.tsx:313](https://github.com/TanStack/table/blob/main/packages/solid-table/src/createTableHook.tsx#L313) -Component type for AppCell - wraps a cell and provides cell context with optional Subscribe +Component type for AppCell - wraps a cell and provides cell context. ## Type Parameters @@ -23,58 +23,26 @@ Component type for AppCell - wraps a cell and provides cell context with optiona `TCellComponents` *extends* `Record`\<`string`, [`ComponentType`](../type-aliases/ComponentType.md)\<`any`\>\> -## Call Signature - ```ts AppCellComponent(props): Element; ``` -Defined in: [createTableHook.tsx:373](https://github.com/TanStack/table/blob/main/packages/solid-table/src/createTableHook.tsx#L373) - -Component type for AppCell - wraps a cell and provides cell context with optional Subscribe - -### Type Parameters - -#### TValue - -`TValue` *extends* `unknown` = `unknown` - -### Parameters - -#### props - -[`AppCellPropsWithoutSelector`](AppCellPropsWithoutSelector.md)\<`TFeatures`, `TData`, `TValue`, `TCellComponents`\> - -### Returns - -`Element` - -## Call Signature - -```ts -AppCellComponent(props): Element; -``` - -Defined in: [createTableHook.tsx:381](https://github.com/TanStack/table/blob/main/packages/solid-table/src/createTableHook.tsx#L381) +Defined in: [createTableHook.tsx:318](https://github.com/TanStack/table/blob/main/packages/solid-table/src/createTableHook.tsx#L318) -Component type for AppCell - wraps a cell and provides cell context with optional Subscribe +Component type for AppCell - wraps a cell and provides cell context. -### Type Parameters +## Type Parameters -#### TValue +### TValue `TValue` *extends* `unknown` = `unknown` -#### TSelected - -`TSelected` = `unknown` - -### Parameters +## Parameters -#### props +### props -[`AppCellPropsWithSelector`](AppCellPropsWithSelector.md)\<`TFeatures`, `TData`, `TValue`, `TCellComponents`, `TSelected`\> +[`AppCellProps`](AppCellProps.md)\<`TFeatures`, `TData`, `TValue`, `TCellComponents`\> -### Returns +## Returns `Element` diff --git a/docs/framework/solid/reference/interfaces/AppCellProps.md b/docs/framework/solid/reference/interfaces/AppCellProps.md new file mode 100644 index 0000000000..35dfe1aa6f --- /dev/null +++ b/docs/framework/solid/reference/interfaces/AppCellProps.md @@ -0,0 +1,58 @@ +--- +id: AppCellProps +title: AppCellProps +--- + +# Interface: AppCellProps\ + +Defined in: [createTableHook.tsx:281](https://github.com/TanStack/table/blob/main/packages/solid-table/src/createTableHook.tsx#L281) + +Props for AppCell component. + +## Type Parameters + +### TFeatures + +`TFeatures` *extends* `TableFeatures` + +### TData + +`TData` *extends* `RowData` + +### TValue + +`TValue` *extends* `CellData` + +### TCellComponents + +`TCellComponents` *extends* `Record`\<`string`, [`ComponentType`](../type-aliases/ComponentType.md)\<`any`\>\> + +## Properties + +### cell + +```ts +cell: Cell; +``` + +Defined in: [createTableHook.tsx:287](https://github.com/TanStack/table/blob/main/packages/solid-table/src/createTableHook.tsx#L287) + +*** + +### children() + +```ts +children: (cell) => Element; +``` + +Defined in: [createTableHook.tsx:288](https://github.com/TanStack/table/blob/main/packages/solid-table/src/createTableHook.tsx#L288) + +#### Parameters + +##### cell + +`Cell_Core`\<`TFeatures`, `TData`, `TValue`\> & `ExtractFeatureMapTypes`\<`TFeatures`, `Cell_FeatureMap`\> & `TCellComponents` & `object` + +#### Returns + +`Element` diff --git a/docs/framework/solid/reference/interfaces/AppCellPropsWithSelector.md b/docs/framework/solid/reference/interfaces/AppCellPropsWithSelector.md deleted file mode 100644 index cab29a5142..0000000000 --- a/docs/framework/solid/reference/interfaces/AppCellPropsWithSelector.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -id: AppCellPropsWithSelector -title: AppCellPropsWithSelector ---- - -# Interface: AppCellPropsWithSelector\ - -Defined in: [createTableHook.tsx:313](https://github.com/TanStack/table/blob/main/packages/solid-table/src/createTableHook.tsx#L313) - -Props for AppCell component - with selector - -## Type Parameters - -### TFeatures - -`TFeatures` *extends* `TableFeatures` - -### TData - -`TData` *extends* `RowData` - -### TValue - -`TValue` *extends* `CellData` - -### TCellComponents - -`TCellComponents` *extends* `Record`\<`string`, [`ComponentType`](../type-aliases/ComponentType.md)\<`any`\>\> - -### TSelected - -`TSelected` - -## Properties - -### cell - -```ts -cell: Cell; -``` - -Defined in: [createTableHook.tsx:320](https://github.com/TanStack/table/blob/main/packages/solid-table/src/createTableHook.tsx#L320) - -*** - -### children() - -```ts -children: (cell, state) => Element; -``` - -Defined in: [createTableHook.tsx:321](https://github.com/TanStack/table/blob/main/packages/solid-table/src/createTableHook.tsx#L321) - -#### Parameters - -##### cell - -`Cell_Cell`\<`TFeatures`, `TData`, `TValue`\> & `UnionToIntersection`\<`"columnGroupingFeature"` *extends* keyof `TFeatures` ? `Cell_ColumnGrouping` : `never`\> & `UnionToIntersection`\<\{ \[K in string \| number \| symbol\]: K extends "coreReativityFeature" ? never : TFeatures\[K\] extends TableFeature\ ? "Cell" extends keyof FeatureConstructorOptions ? FeatureConstructorOptions\[keyof (...) & "Cell"\] : never : any \}\[keyof `TFeatures`\]\> & `Cell_Plugins`\<`TFeatures`, `TData`, `TValue`\> & `TCellComponents` & `object` - -##### state - -`Accessor`\<`TSelected`\> - -#### Returns - -`Element` - -*** - -### selector() - -```ts -selector: (state) => TSelected; -``` - -Defined in: [createTableHook.tsx:326](https://github.com/TanStack/table/blob/main/packages/solid-table/src/createTableHook.tsx#L326) - -#### Parameters - -##### state - -`TableState`\<`TFeatures`\> - -#### Returns - -`TSelected` diff --git a/docs/framework/solid/reference/interfaces/AppCellPropsWithoutSelector.md b/docs/framework/solid/reference/interfaces/AppCellPropsWithoutSelector.md deleted file mode 100644 index 273ed03135..0000000000 --- a/docs/framework/solid/reference/interfaces/AppCellPropsWithoutSelector.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -id: AppCellPropsWithoutSelector -title: AppCellPropsWithoutSelector ---- - -# Interface: AppCellPropsWithoutSelector\ - -Defined in: [createTableHook.tsx:296](https://github.com/TanStack/table/blob/main/packages/solid-table/src/createTableHook.tsx#L296) - -Props for AppCell component - without selector - -## Type Parameters - -### TFeatures - -`TFeatures` *extends* `TableFeatures` - -### TData - -`TData` *extends* `RowData` - -### TValue - -`TValue` *extends* `CellData` - -### TCellComponents - -`TCellComponents` *extends* `Record`\<`string`, [`ComponentType`](../type-aliases/ComponentType.md)\<`any`\>\> - -## Properties - -### cell - -```ts -cell: Cell; -``` - -Defined in: [createTableHook.tsx:302](https://github.com/TanStack/table/blob/main/packages/solid-table/src/createTableHook.tsx#L302) - -*** - -### children() - -```ts -children: (cell) => Element; -``` - -Defined in: [createTableHook.tsx:303](https://github.com/TanStack/table/blob/main/packages/solid-table/src/createTableHook.tsx#L303) - -#### Parameters - -##### cell - -`Cell_Cell`\<`TFeatures`, `TData`, `TValue`\> & `UnionToIntersection`\<`"columnGroupingFeature"` *extends* keyof `TFeatures` ? `Cell_ColumnGrouping` : `never`\> & `UnionToIntersection`\<\{ \[K in string \| number \| symbol\]: K extends "coreReativityFeature" ? never : TFeatures\[K\] extends TableFeature\ ? "Cell" extends keyof FeatureConstructorOptions ? FeatureConstructorOptions\[keyof (...) & "Cell"\] : never : any \}\[keyof `TFeatures`\]\> & `Cell_Plugins`\<`TFeatures`, `TData`, `TValue`\> & `TCellComponents` & `object` - -#### Returns - -`Element` - -*** - -### selector? - -```ts -optional selector: undefined; -``` - -Defined in: [createTableHook.tsx:307](https://github.com/TanStack/table/blob/main/packages/solid-table/src/createTableHook.tsx#L307) diff --git a/docs/framework/solid/reference/interfaces/AppHeaderComponent.md b/docs/framework/solid/reference/interfaces/AppHeaderComponent.md index 58275d620d..d98fe0b707 100644 --- a/docs/framework/solid/reference/interfaces/AppHeaderComponent.md +++ b/docs/framework/solid/reference/interfaces/AppHeaderComponent.md @@ -5,9 +5,9 @@ title: AppHeaderComponent # Interface: AppHeaderComponent()\ -Defined in: [createTableHook.tsx:395](https://github.com/TanStack/table/blob/main/packages/solid-table/src/createTableHook.tsx#L395) +Defined in: [createTableHook.tsx:326](https://github.com/TanStack/table/blob/main/packages/solid-table/src/createTableHook.tsx#L326) -Component type for AppHeader/AppFooter - wraps a header and provides header context with optional Subscribe +Component type for AppHeader/AppFooter - wraps a header and provides header context. ## Type Parameters @@ -23,58 +23,26 @@ Component type for AppHeader/AppFooter - wraps a header and provides header cont `THeaderComponents` *extends* `Record`\<`string`, [`ComponentType`](../type-aliases/ComponentType.md)\<`any`\>\> -## Call Signature - ```ts AppHeaderComponent(props): Element; ``` -Defined in: [createTableHook.tsx:400](https://github.com/TanStack/table/blob/main/packages/solid-table/src/createTableHook.tsx#L400) - -Component type for AppHeader/AppFooter - wraps a header and provides header context with optional Subscribe - -### Type Parameters - -#### TValue - -`TValue` *extends* `unknown` = `unknown` - -### Parameters - -#### props - -[`AppHeaderPropsWithoutSelector`](AppHeaderPropsWithoutSelector.md)\<`TFeatures`, `TData`, `TValue`, `THeaderComponents`\> - -### Returns - -`Element` - -## Call Signature - -```ts -AppHeaderComponent(props): Element; -``` - -Defined in: [createTableHook.tsx:408](https://github.com/TanStack/table/blob/main/packages/solid-table/src/createTableHook.tsx#L408) +Defined in: [createTableHook.tsx:331](https://github.com/TanStack/table/blob/main/packages/solid-table/src/createTableHook.tsx#L331) -Component type for AppHeader/AppFooter - wraps a header and provides header context with optional Subscribe +Component type for AppHeader/AppFooter - wraps a header and provides header context. -### Type Parameters +## Type Parameters -#### TValue +### TValue `TValue` *extends* `unknown` = `unknown` -#### TSelected - -`TSelected` = `unknown` - -### Parameters +## Parameters -#### props +### props -[`AppHeaderPropsWithSelector`](AppHeaderPropsWithSelector.md)\<`TFeatures`, `TData`, `TValue`, `THeaderComponents`, `TSelected`\> +[`AppHeaderProps`](AppHeaderProps.md)\<`TFeatures`, `TData`, `TValue`, `THeaderComponents`\> -### Returns +## Returns `Element` diff --git a/docs/framework/solid/reference/interfaces/AppHeaderProps.md b/docs/framework/solid/reference/interfaces/AppHeaderProps.md new file mode 100644 index 0000000000..5ed7f890d7 --- /dev/null +++ b/docs/framework/solid/reference/interfaces/AppHeaderProps.md @@ -0,0 +1,58 @@ +--- +id: AppHeaderProps +title: AppHeaderProps +--- + +# Interface: AppHeaderProps\ + +Defined in: [createTableHook.tsx:297](https://github.com/TanStack/table/blob/main/packages/solid-table/src/createTableHook.tsx#L297) + +Props for AppHeader/AppFooter component. + +## Type Parameters + +### TFeatures + +`TFeatures` *extends* `TableFeatures` + +### TData + +`TData` *extends* `RowData` + +### TValue + +`TValue` *extends* `CellData` + +### THeaderComponents + +`THeaderComponents` *extends* `Record`\<`string`, [`ComponentType`](../type-aliases/ComponentType.md)\<`any`\>\> + +## Properties + +### children() + +```ts +children: (header) => Element; +``` + +Defined in: [createTableHook.tsx:304](https://github.com/TanStack/table/blob/main/packages/solid-table/src/createTableHook.tsx#L304) + +#### Parameters + +##### header + +`Header_Core`\<`TFeatures`, `TData`, `TValue`\> & `ExtractFeatureMapTypes`\<`TFeatures`, `Header_FeatureMap`\> & `THeaderComponents` & `object` + +#### Returns + +`Element` + +*** + +### header + +```ts +header: Header; +``` + +Defined in: [createTableHook.tsx:303](https://github.com/TanStack/table/blob/main/packages/solid-table/src/createTableHook.tsx#L303) diff --git a/docs/framework/solid/reference/interfaces/AppHeaderPropsWithSelector.md b/docs/framework/solid/reference/interfaces/AppHeaderPropsWithSelector.md deleted file mode 100644 index f665eba0e4..0000000000 --- a/docs/framework/solid/reference/interfaces/AppHeaderPropsWithSelector.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -id: AppHeaderPropsWithSelector -title: AppHeaderPropsWithSelector ---- - -# Interface: AppHeaderPropsWithSelector\ - -Defined in: [createTableHook.tsx:349](https://github.com/TanStack/table/blob/main/packages/solid-table/src/createTableHook.tsx#L349) - -Props for AppHeader/AppFooter component - with selector - -## Type Parameters - -### TFeatures - -`TFeatures` *extends* `TableFeatures` - -### TData - -`TData` *extends* `RowData` - -### TValue - -`TValue` *extends* `CellData` - -### THeaderComponents - -`THeaderComponents` *extends* `Record`\<`string`, [`ComponentType`](../type-aliases/ComponentType.md)\<`any`\>\> - -### TSelected - -`TSelected` - -## Properties - -### children() - -```ts -children: (header, state) => Element; -``` - -Defined in: [createTableHook.tsx:357](https://github.com/TanStack/table/blob/main/packages/solid-table/src/createTableHook.tsx#L357) - -#### Parameters - -##### header - -`Header_Core`\<`TFeatures`, `TData`, `TValue`\> & `UnionToIntersection`\< - \| `"columnSizingFeature"` *extends* keyof `TFeatures` ? `Header_ColumnSizing` : `never` - \| `"columnResizingFeature"` *extends* keyof `TFeatures` ? `Header_ColumnResizing` : `never`\> & `UnionToIntersection`\<\{ \[K in string \| number \| symbol\]: K extends "coreReativityFeature" ? never : TFeatures\[K\] extends TableFeature\ ? "Header" extends keyof FeatureConstructorOptions ? FeatureConstructorOptions\[keyof (...) & "Header"\] : never : any \}\[keyof `TFeatures`\]\> & `Header_Plugins`\<`TFeatures`, `TData`, `TValue`\> & `THeaderComponents` & `object` - -##### state - -`Accessor`\<`TSelected`\> - -#### Returns - -`Element` - -*** - -### header - -```ts -header: Header; -``` - -Defined in: [createTableHook.tsx:356](https://github.com/TanStack/table/blob/main/packages/solid-table/src/createTableHook.tsx#L356) - -*** - -### selector() - -```ts -selector: (state) => TSelected; -``` - -Defined in: [createTableHook.tsx:362](https://github.com/TanStack/table/blob/main/packages/solid-table/src/createTableHook.tsx#L362) - -#### Parameters - -##### state - -`TableState`\<`TFeatures`\> - -#### Returns - -`TSelected` diff --git a/docs/framework/solid/reference/interfaces/AppHeaderPropsWithoutSelector.md b/docs/framework/solid/reference/interfaces/AppHeaderPropsWithoutSelector.md deleted file mode 100644 index 6cde73cdff..0000000000 --- a/docs/framework/solid/reference/interfaces/AppHeaderPropsWithoutSelector.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -id: AppHeaderPropsWithoutSelector -title: AppHeaderPropsWithoutSelector ---- - -# Interface: AppHeaderPropsWithoutSelector\ - -Defined in: [createTableHook.tsx:332](https://github.com/TanStack/table/blob/main/packages/solid-table/src/createTableHook.tsx#L332) - -Props for AppHeader/AppFooter component - without selector - -## Type Parameters - -### TFeatures - -`TFeatures` *extends* `TableFeatures` - -### TData - -`TData` *extends* `RowData` - -### TValue - -`TValue` *extends* `CellData` - -### THeaderComponents - -`THeaderComponents` *extends* `Record`\<`string`, [`ComponentType`](../type-aliases/ComponentType.md)\<`any`\>\> - -## Properties - -### children() - -```ts -children: (header) => Element; -``` - -Defined in: [createTableHook.tsx:339](https://github.com/TanStack/table/blob/main/packages/solid-table/src/createTableHook.tsx#L339) - -#### Parameters - -##### header - -`Header_Core`\<`TFeatures`, `TData`, `TValue`\> & `UnionToIntersection`\< - \| `"columnSizingFeature"` *extends* keyof `TFeatures` ? `Header_ColumnSizing` : `never` - \| `"columnResizingFeature"` *extends* keyof `TFeatures` ? `Header_ColumnResizing` : `never`\> & `UnionToIntersection`\<\{ \[K in string \| number \| symbol\]: K extends "coreReativityFeature" ? never : TFeatures\[K\] extends TableFeature\ ? "Header" extends keyof FeatureConstructorOptions ? FeatureConstructorOptions\[keyof (...) & "Header"\] : never : any \}\[keyof `TFeatures`\]\> & `Header_Plugins`\<`TFeatures`, `TData`, `TValue`\> & `THeaderComponents` & `object` - -#### Returns - -`Element` - -*** - -### header - -```ts -header: Header; -``` - -Defined in: [createTableHook.tsx:338](https://github.com/TanStack/table/blob/main/packages/solid-table/src/createTableHook.tsx#L338) - -*** - -### selector? - -```ts -optional selector: undefined; -``` - -Defined in: [createTableHook.tsx:343](https://github.com/TanStack/table/blob/main/packages/solid-table/src/createTableHook.tsx#L343) diff --git a/docs/framework/solid/reference/interfaces/AppTableComponent.md b/docs/framework/solid/reference/interfaces/AppTableComponent.md index 57e3eed2ee..d2643bf5cc 100644 --- a/docs/framework/solid/reference/interfaces/AppTableComponent.md +++ b/docs/framework/solid/reference/interfaces/AppTableComponent.md @@ -5,7 +5,7 @@ title: AppTableComponent # Interface: AppTableComponent()\ -Defined in: [createTableHook.tsx:422](https://github.com/TanStack/table/blob/main/packages/solid-table/src/createTableHook.tsx#L422) +Defined in: [createTableHook.tsx:339](https://github.com/TanStack/table/blob/main/packages/solid-table/src/createTableHook.tsx#L339) Component type for AppTable - root wrapper with optional Subscribe @@ -15,48 +15,20 @@ Component type for AppTable - root wrapper with optional Subscribe `TFeatures` *extends* `TableFeatures` -## Call Signature - ```ts AppTableComponent(props): Element; ``` -Defined in: [createTableHook.tsx:423](https://github.com/TanStack/table/blob/main/packages/solid-table/src/createTableHook.tsx#L423) +Defined in: [createTableHook.tsx:340](https://github.com/TanStack/table/blob/main/packages/solid-table/src/createTableHook.tsx#L340) Component type for AppTable - root wrapper with optional Subscribe -### Parameters - -#### props - -[`AppTablePropsWithoutSelector`](AppTablePropsWithoutSelector.md) - -### Returns - -`Element` - -## Call Signature - -```ts -AppTableComponent(props): Element; -``` - -Defined in: [createTableHook.tsx:424](https://github.com/TanStack/table/blob/main/packages/solid-table/src/createTableHook.tsx#L424) - -Component type for AppTable - root wrapper with optional Subscribe - -### Type Parameters - -#### TSelected - -`TSelected` - -### Parameters +## Parameters -#### props +### props -[`AppTablePropsWithSelector`](AppTablePropsWithSelector.md)\<`TFeatures`, `TSelected`\> +[`AppTableProps`](AppTableProps.md) -### Returns +## Returns `Element` diff --git a/docs/framework/solid/reference/interfaces/AppTableProps.md b/docs/framework/solid/reference/interfaces/AppTableProps.md new file mode 100644 index 0000000000..d4bd747fa1 --- /dev/null +++ b/docs/framework/solid/reference/interfaces/AppTableProps.md @@ -0,0 +1,18 @@ +--- +id: AppTableProps +title: AppTableProps +--- + +# Interface: AppTableProps + +Defined in: [createTableHook.tsx:274](https://github.com/TanStack/table/blob/main/packages/solid-table/src/createTableHook.tsx#L274) + +## Properties + +### children + +```ts +children: Element; +``` + +Defined in: [createTableHook.tsx:275](https://github.com/TanStack/table/blob/main/packages/solid-table/src/createTableHook.tsx#L275) diff --git a/docs/framework/solid/reference/interfaces/AppTablePropsWithSelector.md b/docs/framework/solid/reference/interfaces/AppTablePropsWithSelector.md deleted file mode 100644 index fc67006634..0000000000 --- a/docs/framework/solid/reference/interfaces/AppTablePropsWithSelector.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -id: AppTablePropsWithSelector -title: AppTablePropsWithSelector ---- - -# Interface: AppTablePropsWithSelector\ - -Defined in: [createTableHook.tsx:285](https://github.com/TanStack/table/blob/main/packages/solid-table/src/createTableHook.tsx#L285) - -Props for AppTable component - with selector - -## Type Parameters - -### TFeatures - -`TFeatures` *extends* `TableFeatures` - -### TSelected - -`TSelected` - -## Properties - -### children() - -```ts -children: (state) => Element; -``` - -Defined in: [createTableHook.tsx:289](https://github.com/TanStack/table/blob/main/packages/solid-table/src/createTableHook.tsx#L289) - -#### Parameters - -##### state - -`Accessor`\<`TSelected`\> - -#### Returns - -`Element` - -*** - -### selector() - -```ts -selector: (state) => TSelected; -``` - -Defined in: [createTableHook.tsx:290](https://github.com/TanStack/table/blob/main/packages/solid-table/src/createTableHook.tsx#L290) - -#### Parameters - -##### state - -`TableState`\<`TFeatures`\> - -#### Returns - -`TSelected` diff --git a/docs/framework/solid/reference/interfaces/AppTablePropsWithoutSelector.md b/docs/framework/solid/reference/interfaces/AppTablePropsWithoutSelector.md deleted file mode 100644 index 02194c4cdf..0000000000 --- a/docs/framework/solid/reference/interfaces/AppTablePropsWithoutSelector.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -id: AppTablePropsWithoutSelector -title: AppTablePropsWithoutSelector ---- - -# Interface: AppTablePropsWithoutSelector - -Defined in: [createTableHook.tsx:277](https://github.com/TanStack/table/blob/main/packages/solid-table/src/createTableHook.tsx#L277) - -Props for AppTable component - without selector - -## Properties - -### children - -```ts -children: Element; -``` - -Defined in: [createTableHook.tsx:278](https://github.com/TanStack/table/blob/main/packages/solid-table/src/createTableHook.tsx#L278) - -*** - -### selector? - -```ts -optional selector: undefined; -``` - -Defined in: [createTableHook.tsx:279](https://github.com/TanStack/table/blob/main/packages/solid-table/src/createTableHook.tsx#L279) diff --git a/docs/framework/solid/reference/type-aliases/AppSolidTable.md b/docs/framework/solid/reference/type-aliases/AppSolidTable.md index 8b4f002a11..3764e50c93 100644 --- a/docs/framework/solid/reference/type-aliases/AppSolidTable.md +++ b/docs/framework/solid/reference/type-aliases/AppSolidTable.md @@ -6,10 +6,10 @@ title: AppSolidTable # Type Alias: AppSolidTable\ ```ts -type AppSolidTable = SolidTable & NoInfer & object; +type AppSolidTable = SolidTable & NoInfer & object; ``` -Defined in: [createTableHook.tsx:432](https://github.com/TanStack/table/blob/main/packages/solid-table/src/createTableHook.tsx#L432) +Defined in: [createTableHook.tsx:346](https://github.com/TanStack/table/blob/main/packages/solid-table/src/createTableHook.tsx#L346) Extended table API returned by createAppTable with all App wrapper components @@ -22,20 +22,13 @@ AppCell: AppCellComponent>; ``` Wraps a cell and provides cell context with pre-bound cellComponents. -Optionally accepts a selector for Subscribe functionality. #### Example ```tsx -// Without selector {(c) => } - -// With selector - children receives cell and selected state - s.columnFilters}> - {(c, filters) => {filters.length}} - ``` ### AppFooter @@ -45,7 +38,6 @@ AppFooter: AppHeaderComponent>; ``` Wraps a footer and provides header context with pre-bound headerComponents. -Optionally accepts a selector for Subscribe functionality. #### Example @@ -62,20 +54,13 @@ AppHeader: AppHeaderComponent>; ``` Wraps a header and provides header context with pre-bound headerComponents. -Optionally accepts a selector for Subscribe functionality. #### Example ```tsx -// Without selector {(h) => } - -// With selector - s.sorting}> - {(h, sorting) => {sorting.length} sorted} - ``` ### AppTable @@ -84,20 +69,14 @@ Optionally accepts a selector for Subscribe functionality. AppTable: AppTableComponent; ``` -Root wrapper component that provides table context with optional Subscribe. +Root wrapper component that provides table context. #### Example ```tsx -// Without selector - children is JSXElement ...
 - -// With selector - children receives selected state - s.pagination}> - {(pagination) =>
Page {pagination.pageIndex}
} - ``` ### FlexRender diff --git a/docs/framework/solid/reference/type-aliases/SolidTable.md b/docs/framework/solid/reference/type-aliases/SolidTable.md index 37c72d0b6d..15c5ae3302 100644 --- a/docs/framework/solid/reference/type-aliases/SolidTable.md +++ b/docs/framework/solid/reference/type-aliases/SolidTable.md @@ -3,13 +3,13 @@ id: SolidTable title: SolidTable --- -# Type Alias: SolidTable\ +# Type Alias: SolidTable\ ```ts -type SolidTable = Omit, "store"> & object; +type SolidTable = Omit, "store"> & object; ``` -Defined in: [createTable.ts:27](https://github.com/TanStack/table/blob/main/packages/solid-table/src/createTable.ts#L27) +Defined in: [createTable.ts:20](https://github.com/TanStack/table/blob/main/packages/solid-table/src/createTable.ts#L20) ## Type Declaration @@ -31,24 +31,6 @@ rendering headers, cells, or footers with custom markup. Mirrors the ``` -### state - -```ts -readonly state: Accessor>; -``` - -The selected state of the table. This state may not match the structure of -the full table state because it is selected by the selector function that -you pass as the 2nd argument to `createTable`. - -#### Example - -```ts -const table = createTable(options, (state) => ({ globalFilter: state.globalFilter })) // only globalFilter is part of the selected state - -console.log(table.state().globalFilter) -``` - ### ~~store~~ ```ts @@ -57,122 +39,30 @@ readonly store: Table["store"]; #### Deprecated -Prefer `table.state()` for component-level reactive reads, -`table.atoms..get()` for slice-level reactive reads, or -`table.Subscribe` / `useSelector(table.store, selector)` for explicit -subscriptions. Reading `table.state` directly does not follow Solid's -accessor convention and may not update render code as expected. +Prefer `table.atoms..get()` for slice-level reactive +reads, or `table.Subscribe` for explicit subscriptions. `table.store.state` +is a current-value snapshot and is easy to misuse in render code. ### Subscribe() ```ts -Subscribe: { - (props): Element; - (props): Element; - (props): Element; -}; -``` - -Subscribe to the store (selector required) or a single source (atom or store). -Source **without** `selector` is a separate overload so children receive -`Accessor` (identity projection). Source overloads are listed first -for JSX contextual typing. - -#### Call Signature - -```ts -(props): Element; -``` - -##### Type Parameters - -###### TSourceValue - -`TSourceValue` - -##### Parameters - -###### props - -###### children - -(`state`) => `JSX.Element` \| `JSX.Element` - -###### selector? - -`undefined` - -###### source - -[`SubscribeSource`](SubscribeSource.md)\<`TSourceValue`\> - -##### Returns - -`Element` - -#### Call Signature - -```ts -(props): Element; -``` - -##### Type Parameters - -###### TSourceValue - -`TSourceValue` - -###### TSubSelected - -`TSubSelected` - -##### Parameters - -###### props - -###### children - -(`state`) => `JSX.Element` \| `JSX.Element` - -###### selector - -(`state`) => `TSubSelected` - -###### source - -[`SubscribeSource`](SubscribeSource.md)\<`TSourceValue`\> - -##### Returns - -`Element` - -#### Call Signature - -```ts -(props): Element; +Subscribe: (props) => JSX.Element; ``` -##### Type Parameters - -###### TSubSelected +Creates a reactive render boundary. The child function reads the table +atoms it needs, so Solid only tracks those atom reads. -`TSubSelected` +#### Parameters -##### Parameters - -###### props +##### props ###### children -(`state`) => `JSX.Element` \| `JSX.Element` - -###### selector +(`atoms`) => `JSX.Element` -(`state`) => `TSubSelected` +#### Returns -##### Returns - -`Element` +`JSX.Element` ## Type Parameters @@ -183,7 +73,3 @@ for JSX contextual typing. ### TData `TData` *extends* `RowData` - -### TSelected - -`TSelected` = `TableState`\<`TFeatures`\> diff --git a/docs/framework/solid/reference/type-aliases/SubscribeSource.md b/docs/framework/solid/reference/type-aliases/SubscribeSource.md deleted file mode 100644 index 78280a3c73..0000000000 --- a/docs/framework/solid/reference/type-aliases/SubscribeSource.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -id: SubscribeSource -title: SubscribeSource ---- - -# Type Alias: SubscribeSource\ - -```ts -type SubscribeSource = - | Atom - | ReadonlyAtom - | Store -| ReadonlyStore; -``` - -Defined in: [createTable.ts:21](https://github.com/TanStack/table/blob/main/packages/solid-table/src/createTable.ts#L21) - -## Type Parameters - -### TValue - -`TValue` diff --git a/docs/framework/svelte/guide/composable-tables.md b/docs/framework/svelte/guide/composable-tables.md new file mode 100644 index 0000000000..130da4d6f5 --- /dev/null +++ b/docs/framework/svelte/guide/composable-tables.md @@ -0,0 +1,201 @@ +--- +title: Composable Tables Guide +--- + +Composable tables are app-level table factories built with `createTableHook`. They let Svelte apps define shared features, row models, default options, and reusable Svelte components once, then create multiple tables from that setup. + +Use this pattern when several tables should share behavior and rendering conventions. For one standalone table, `createTable` is usually enough. + +## Examples + +- [Composable Tables](../examples/composable-tables) - Users and Products tables sharing `src/hooks/table.ts`. +- [Basic App Table](../examples/basic-app-table) - Minimal `createTableHook` setup. + +## Setup + +The composable tables example keeps the shared configuration in `src/hooks/table.ts`. + +```ts +import { + columnFilteringFeature, + createFilteredRowModel, + createPaginatedRowModel, + createSortedRowModel, + createTableHook, + filterFns, + rowPaginationFeature, + rowSortingFeature, + sortFns, + tableFeatures, +} from '@tanstack/svelte-table' + +import PaginationControls from '../components/PaginationControls.svelte' +import RowCount from '../components/RowCount.svelte' +import TableToolbar from '../components/TableToolbar.svelte' +import CategoryCell from '../components/CategoryCell.svelte' +import NumberCell from '../components/NumberCell.svelte' +import PriceCell from '../components/PriceCell.svelte' +import ProgressCell from '../components/ProgressCell.svelte' +import RowActionsCell from '../components/RowActionsCell.svelte' +import StatusCell from '../components/StatusCell.svelte' +import TextCell from '../components/TextCell.svelte' +import ColumnFilter from '../components/ColumnFilter.svelte' +import FooterColumnId from '../components/FooterColumnId.svelte' +import FooterSum from '../components/FooterSum.svelte' +import SortIndicator from '../components/SortIndicator.svelte' + +export const { + createAppColumnHelper, + createAppTable, + useTableContext, + useCellContext, + useHeaderContext, +} = createTableHook({ + features: tableFeatures({ + columnFilteringFeature, + rowPaginationFeature, + rowSortingFeature, + }), + rowModels: { + sortedRowModel: createSortedRowModel(sortFns), + filteredRowModel: createFilteredRowModel(filterFns), + paginatedRowModel: createPaginatedRowModel(), + }, + getRowId: (row) => row.id, + tableComponents: { + PaginationControls, + RowCount, + TableToolbar, + }, + cellComponents: { + TextCell, + NumberCell, + StatusCell, + ProgressCell, + RowActionsCell, + PriceCell, + CategoryCell, + }, + headerComponents: { + SortIndicator, + ColumnFilter, + FooterColumnId, + FooterSum, + }, +}) +``` + +## Returned Helpers + +| Helper | Purpose | +|---|---| +| `createAppTable` | Creates a Svelte table with shared features, row models, defaults, and registered components. | +| `createAppColumnHelper` | Creates column helpers with `TFeatures` and registered component types already bound. | +| `useTableContext` | Reads the current table inside registered table components. | +| `useCellContext` | Reads the current cell inside registered cell components. | +| `useHeaderContext` | Reads the current header/footer inside registered header components. | + +## Columns + +Create one column helper per row type. The Svelte example uses `renderComponent(...)` when a column def returns a registered Svelte component. + +```svelte + +``` + +## Table Rendering + +Create each table with `createAppTable`. In Svelte 5, pass reactive data through a getter so table options read the current rune value. + +```svelte + +``` + +The returned table includes Svelte components for `AppTable`, `AppHeader`, `AppCell`, and `AppFooter`, plus the registered table components. + +```svelte + +
+ + + + + {#each table.getHeaderGroups() as headerGroup (headerGroup.id)} + + {#each headerGroup.headers as h (h.id)} + + {#snippet children(header)} + + {/snippet} + + {/each} + + {/each} + + + {#each rows as row (row.id)} + + {#each row.getAllCells() as cell (cell.id)} + + {#snippet children(appCell)} + + {/snippet} + + {/each} + + {/each} + +
+ + + +
+ +
+ + + +
+ +``` + +## Reusing The Hook + +The Users and Products Svelte components import the same `createAppColumnHelper` and `createAppTable` from `src/hooks/table.ts`. Each component owns its `$state` data and columns, while the shared hook owns features, row models, row IDs, and the component registry. diff --git a/docs/framework/svelte/reference/type-aliases/FlexRender.md b/docs/framework/svelte/reference/type-aliases/FlexRender.md index 4ea2097953..42c3fbe70c 100644 --- a/docs/framework/svelte/reference/type-aliases/FlexRender.md +++ b/docs/framework/svelte/reference/type-aliases/FlexRender.md @@ -9,4 +9,4 @@ title: FlexRender type FlexRender = SvelteComponent; ``` -Defined in: node\_modules/.pnpm/svelte@5.55.9\_@typescript-eslint+types@8.59.4/node\_modules/svelte/types/index.d.ts:3204 +Defined in: node\_modules/.pnpm/svelte@5.56.2\_@typescript-eslint+types@8.60.1/node\_modules/svelte/types/index.d.ts:3211 diff --git a/docs/framework/svelte/reference/variables/FlexRender.md b/docs/framework/svelte/reference/variables/FlexRender.md index 1e2fd7c29c..289f9344c7 100644 --- a/docs/framework/svelte/reference/variables/FlexRender.md +++ b/docs/framework/svelte/reference/variables/FlexRender.md @@ -9,4 +9,4 @@ title: FlexRender const FlexRender: LegacyComponentType; ``` -Defined in: node\_modules/.pnpm/svelte@5.55.9\_@typescript-eslint+types@8.59.4/node\_modules/svelte/types/index.d.ts:3204 +Defined in: node\_modules/.pnpm/svelte@5.56.2\_@typescript-eslint+types@8.60.1/node\_modules/svelte/types/index.d.ts:3211 diff --git a/docs/framework/vue/guide/composable-tables.md b/docs/framework/vue/guide/composable-tables.md new file mode 100644 index 0000000000..7c22e396ae --- /dev/null +++ b/docs/framework/vue/guide/composable-tables.md @@ -0,0 +1,233 @@ +--- +title: Composable Tables Guide +--- + +Composable tables are app-level table factories built with `createTableHook`. They let Vue apps define shared features, row models, default options, and reusable components once, then create multiple tables from that setup. + +Use this pattern when several tables should share behavior and rendering conventions. For one standalone table, `useTable` is usually enough. + +## Examples + +- [Composable Tables](../examples/composable-tables) - Users and Products tables sharing `src/hooks/table.ts`. +- [Basic useAppTable](../examples/basic-use-app-table) - Minimal `createTableHook` setup. + +## Setup + +The composable tables example keeps the shared configuration in `src/hooks/table.ts`. + +```ts +import { + columnFilteringFeature, + createFilteredRowModel, + createPaginatedRowModel, + createSortedRowModel, + createTableHook, + filterFns, + globalFilteringFeature, + rowPaginationFeature, + rowSortingFeature, + sortFns, + tableFeatures, +} from '@tanstack/vue-table' + +import { + CategoryCell, + NumberCell, + PriceCell, + ProgressCell, + RowActionsCell, + StatusCell, + TextCell, +} from '../components/cell-components' +import { + ColumnFilter, + FooterColumnId, + FooterSum, + SortIndicator, +} from '../components/header-components' +import { + PaginationControls, + RowCount, + TableToolbar, +} from '../components/table-components' +import type { + Cell, + CellData, + Header, + RowData, + VueTable, +} from '@tanstack/vue-table' + +const features = tableFeatures({ + columnFilteringFeature, + globalFilteringFeature, + rowPaginationFeature, + rowSortingFeature, +}) + +const _hook = createTableHook({ + features, + rowModels: { + filteredRowModel: createFilteredRowModel(filterFns), + paginatedRowModel: createPaginatedRowModel(), + sortedRowModel: createSortedRowModel(sortFns), + }, + getRowId: (row) => row.id, + tableComponents: { + PaginationControls, + RowCount, + TableToolbar, + }, + cellComponents: { + TextCell, + NumberCell, + StatusCell, + ProgressCell, + RowActionsCell, + PriceCell, + CategoryCell, + }, + headerComponents: { + SortIndicator, + ColumnFilter, + FooterColumnId, + FooterSum, + }, +}) + +export const createAppColumnHelper = _hook.createAppColumnHelper +export const useAppTable = _hook.useAppTable +``` + +The example also exports explicit type annotations for `useTableContext`, `useCellContext`, and `useHeaderContext`. Those annotations break the circular inference chain caused by component files importing context helpers from this file while this file imports those components. + +```ts +export const useTableContext: () => VueTable< + typeof features, + TData +> = _hook.useTableContext + +export const useCellContext: () => Cell< + typeof features, + any, + TValue +> = _hook.useCellContext + +export const useHeaderContext: () => Header< + typeof features, + any, + TValue +> = _hook.useHeaderContext +``` + +## Returned Helpers + +| Helper | Purpose | +|---|---| +| `useAppTable` | Creates a Vue table with shared features, row models, defaults, and registered components. | +| `createAppColumnHelper` | Creates column helpers with `TFeatures` and registered component types already bound. | +| `useTableContext` | Reads the current table inside registered table components. | +| `useCellContext` | Reads the current cell inside registered cell components. | +| `useHeaderContext` | Reads the current header/footer inside registered header components. | + +## Columns + +Create one column helper per row type. Vue registered components are returned from column definitions and then rendered through dynamic `` usage. + +```vue + +``` + +## Table Rendering + +Create each table with `useAppTable`. Pass table-specific options like `key`, `columns`, reactive `data`, and any per-table state. + +```ts +const table = useAppTable({ + key: 'users-table', + debugTable: true, + columns, + data, + initialState: { + pagination: { + pageIndex: 0, + pageSize: 10, + }, + }, +}) +``` + +The returned table includes Vue components for `AppTable`, `AppHeader`, `AppCell`, and `AppFooter`. The example renders them with dynamic components and slot props. + +```vue + +``` + +## Reusing The Hook + +The Users and Products Vue components import the same `createAppColumnHelper` and `useAppTable` from `src/hooks/table.ts`. Each component owns its refs and columns, while the shared hook owns features, row models, row IDs, table components, cell components, and header/footer components. diff --git a/docs/framework/vue/reference/functions/createTableHook.md b/docs/framework/vue/reference/functions/createTableHook.md index 82b7818453..1ca287a2d0 100644 --- a/docs/framework/vue/reference/functions/createTableHook.md +++ b/docs/framework/vue/reference/functions/createTableHook.md @@ -9,7 +9,7 @@ title: createTableHook function createTableHook(__namedParameters): object; ``` -Defined in: [packages/vue-table/src/createTableHook.ts:300](https://github.com/TanStack/table/blob/main/packages/vue-table/src/createTableHook.ts#L300) +Defined in: [packages/vue-table/src/createTableHook.ts:291](https://github.com/TanStack/table/blob/main/packages/vue-table/src/createTableHook.ts#L291) Creates app-scoped Vue table helpers with features, row models, and renderable component maps pre-bound. @@ -70,7 +70,7 @@ createAppColumnHelper: () => AppColumnHelper(tableOptions, selector?) => AppVueTable; +useAppTable: (tableOptions) => AppVueTable, TTableComponents, TCellComponents, THeaderComponents>; ``` #### Type Parameters @@ -79,23 +79,15 @@ useAppTable: (tableOptions, selector?) => AppVueTable - #### Parameters ##### tableOptions `Omit`\<[`TableOptionsWithReactiveData`](../type-aliases/TableOptionsWithReactiveData.md)\<`TFeatures`, `TData`\>, `"features"` \| `"rowModels"`\> -##### selector? - -(`state`) => `TSelected` - #### Returns -[`AppVueTable`](../type-aliases/AppVueTable.md)\<`TFeatures`, `TData`, `TSelected`, `TTableComponents`, `TCellComponents`, `THeaderComponents`\> +[`AppVueTable`](../type-aliases/AppVueTable.md)\<`TFeatures`, `TData`, `TableState`\<`TFeatures`\>, `TTableComponents`, `TCellComponents`, `THeaderComponents`\> ### useCellContext() diff --git a/docs/framework/vue/reference/functions/flexRender.md b/docs/framework/vue/reference/functions/flexRender.md index 5a34ace877..6ec2204f98 100644 --- a/docs/framework/vue/reference/functions/flexRender.md +++ b/docs/framework/vue/reference/functions/flexRender.md @@ -9,7 +9,7 @@ title: flexRender function flexRender(render, props): any; ``` -Defined in: [packages/vue-table/src/FlexRender.ts:15](https://github.com/TanStack/table/blob/main/packages/vue-table/src/FlexRender.ts#L15) +Defined in: [packages/vue-table/src/FlexRender.ts:30](https://github.com/TanStack/table/blob/main/packages/vue-table/src/FlexRender.ts#L30) If rendering headers, cells, or footers with custom markup, use flexRender instead of `cell.getValue()` or `cell.renderValue()`. diff --git a/docs/framework/vue/reference/functions/useTable.md b/docs/framework/vue/reference/functions/useTable.md index 3a5ac9c98c..8d59746a79 100644 --- a/docs/framework/vue/reference/functions/useTable.md +++ b/docs/framework/vue/reference/functions/useTable.md @@ -6,17 +6,17 @@ title: useTable # Function: useTable() ```ts -function useTable(tableOptions, selector?): VueTable; +function useTable(tableOptions): VueTable; ``` -Defined in: [packages/vue-table/src/useTable.ts:140](https://github.com/TanStack/table/blob/main/packages/vue-table/src/useTable.ts#L140) +Defined in: [packages/vue-table/src/useTable.ts:85](https://github.com/TanStack/table/blob/main/packages/vue-table/src/useTable.ts#L85) Creates a Vue table instance backed by Vue-aware TanStack Store atoms. Table options may contain Vue refs or computed values. The adapter unwraps those reactive inputs, watches them with synchronous flushing, and keeps the -table options in sync. The optional selector projects from `table.store` and -exposes the selected value on `table.state`. +table options in sync. Use `table.Subscribe` or native Vue computed values +around `table.atoms..get()` for selected reactive reads. ## Type Parameters @@ -28,23 +28,15 @@ exposes the selected value on `table.state`. `TData` *extends* `RowData` -### TSelected - -`TSelected` = `TableState`\<`TFeatures`\> - ## Parameters ### tableOptions `TableOptions`\<`TFeatures`, `TData`\> | [`TableOptionsWithReactiveData`](../type-aliases/TableOptionsWithReactiveData.md)\<`TFeatures`, `TData`\> -### selector? - -(`state`) => `TSelected` - ## Returns -[`VueTable`](../type-aliases/VueTable.md)\<`TFeatures`, `TData`, `TSelected`\> +[`VueTable`](../type-aliases/VueTable.md)\<`TFeatures`, `TData`\> ## Example @@ -56,8 +48,5 @@ const table = useTable( columns, data, }, - (state) => ({ pagination: state.pagination }), ) - -table.state.pagination ``` diff --git a/docs/framework/vue/reference/index.md b/docs/framework/vue/reference/index.md index de56c21f33..edef6b70b3 100644 --- a/docs/framework/vue/reference/index.md +++ b/docs/framework/vue/reference/index.md @@ -10,6 +10,8 @@ title: "@tanstack/vue-table" - [AppCellProps](interfaces/AppCellProps.md) - [AppHeaderProps](interfaces/AppHeaderProps.md) - [AppTableProps](interfaces/AppTableProps.md) +- [FlexRenderCell](interfaces/FlexRenderCell.md) +- [FlexRenderHeader](interfaces/FlexRenderHeader.md) ## Type Aliases @@ -23,7 +25,6 @@ title: "@tanstack/vue-table" - [AppVueTable](type-aliases/AppVueTable.md) - [ComponentType](type-aliases/ComponentType.md) - [CreateTableHookOptions](type-aliases/CreateTableHookOptions.md) -- [SubscribeSource](type-aliases/SubscribeSource.md) - [TableOptionsWithReactiveData](type-aliases/TableOptionsWithReactiveData.md) - [VueTable](type-aliases/VueTable.md) diff --git a/docs/framework/vue/reference/interfaces/AppCellProps.md b/docs/framework/vue/reference/interfaces/AppCellProps.md index cb4f5fcc1e..36edf94b9a 100644 --- a/docs/framework/vue/reference/interfaces/AppCellProps.md +++ b/docs/framework/vue/reference/interfaces/AppCellProps.md @@ -3,9 +3,9 @@ id: AppCellProps title: AppCellProps --- -# Interface: AppCellProps\ +# Interface: AppCellProps\ -Defined in: [packages/vue-table/src/createTableHook.ts:202](https://github.com/TanStack/table/blob/main/packages/vue-table/src/createTableHook.ts#L202) +Defined in: [packages/vue-table/src/createTableHook.ts:197](https://github.com/TanStack/table/blob/main/packages/vue-table/src/createTableHook.ts#L197) ## Type Parameters @@ -21,10 +21,6 @@ Defined in: [packages/vue-table/src/createTableHook.ts:202](https://github.com/T `TValue` *extends* `CellData` = `CellData` -### TSelected - -`TSelected` = `unknown` - ## Properties ### cell @@ -33,24 +29,4 @@ Defined in: [packages/vue-table/src/createTableHook.ts:202](https://github.com/T cell: Cell; ``` -Defined in: [packages/vue-table/src/createTableHook.ts:208](https://github.com/TanStack/table/blob/main/packages/vue-table/src/createTableHook.ts#L208) - -*** - -### selector()? - -```ts -optional selector: (state) => TSelected; -``` - -Defined in: [packages/vue-table/src/createTableHook.ts:209](https://github.com/TanStack/table/blob/main/packages/vue-table/src/createTableHook.ts#L209) - -#### Parameters - -##### state - -`TableState`\<`TFeatures`\> - -#### Returns - -`TSelected` +Defined in: [packages/vue-table/src/createTableHook.ts:202](https://github.com/TanStack/table/blob/main/packages/vue-table/src/createTableHook.ts#L202) diff --git a/docs/framework/vue/reference/interfaces/AppHeaderProps.md b/docs/framework/vue/reference/interfaces/AppHeaderProps.md index 584d7805dc..e3ec3e00f8 100644 --- a/docs/framework/vue/reference/interfaces/AppHeaderProps.md +++ b/docs/framework/vue/reference/interfaces/AppHeaderProps.md @@ -3,9 +3,9 @@ id: AppHeaderProps title: AppHeaderProps --- -# Interface: AppHeaderProps\ +# Interface: AppHeaderProps\ -Defined in: [packages/vue-table/src/createTableHook.ts:212](https://github.com/TanStack/table/blob/main/packages/vue-table/src/createTableHook.ts#L212) +Defined in: [packages/vue-table/src/createTableHook.ts:205](https://github.com/TanStack/table/blob/main/packages/vue-table/src/createTableHook.ts#L205) ## Type Parameters @@ -21,10 +21,6 @@ Defined in: [packages/vue-table/src/createTableHook.ts:212](https://github.com/T `TValue` *extends* `CellData` = `CellData` -### TSelected - -`TSelected` = `unknown` - ## Properties ### header @@ -33,24 +29,4 @@ Defined in: [packages/vue-table/src/createTableHook.ts:212](https://github.com/T header: Header; ``` -Defined in: [packages/vue-table/src/createTableHook.ts:218](https://github.com/TanStack/table/blob/main/packages/vue-table/src/createTableHook.ts#L218) - -*** - -### selector()? - -```ts -optional selector: (state) => TSelected; -``` - -Defined in: [packages/vue-table/src/createTableHook.ts:219](https://github.com/TanStack/table/blob/main/packages/vue-table/src/createTableHook.ts#L219) - -#### Parameters - -##### state - -`TableState`\<`TFeatures`\> - -#### Returns - -`TSelected` +Defined in: [packages/vue-table/src/createTableHook.ts:210](https://github.com/TanStack/table/blob/main/packages/vue-table/src/createTableHook.ts#L210) diff --git a/docs/framework/vue/reference/interfaces/AppTableProps.md b/docs/framework/vue/reference/interfaces/AppTableProps.md index 3b94e4417d..551911fa5c 100644 --- a/docs/framework/vue/reference/interfaces/AppTableProps.md +++ b/docs/framework/vue/reference/interfaces/AppTableProps.md @@ -3,36 +3,6 @@ id: AppTableProps title: AppTableProps --- -# Interface: AppTableProps\ +# Interface: AppTableProps Defined in: [packages/vue-table/src/createTableHook.ts:195](https://github.com/TanStack/table/blob/main/packages/vue-table/src/createTableHook.ts#L195) - -## Type Parameters - -### TFeatures - -`TFeatures` *extends* `TableFeatures` - -### TSelected - -`TSelected` = `unknown` - -## Properties - -### selector()? - -```ts -optional selector: (state) => TSelected; -``` - -Defined in: [packages/vue-table/src/createTableHook.ts:199](https://github.com/TanStack/table/blob/main/packages/vue-table/src/createTableHook.ts#L199) - -#### Parameters - -##### state - -`TableState`\<`TFeatures`\> - -#### Returns - -`TSelected` diff --git a/docs/framework/vue/reference/interfaces/FlexRenderCell.md b/docs/framework/vue/reference/interfaces/FlexRenderCell.md new file mode 100644 index 0000000000..863de8742c --- /dev/null +++ b/docs/framework/vue/reference/interfaces/FlexRenderCell.md @@ -0,0 +1,78 @@ +--- +id: FlexRenderCell +title: FlexRenderCell +--- + +# Interface: FlexRenderCell + +Defined in: [packages/vue-table/src/FlexRender.ts:4](https://github.com/TanStack/table/blob/main/packages/vue-table/src/FlexRender.ts#L4) + +## Properties + +### column + +```ts +column: object; +``` + +Defined in: [packages/vue-table/src/FlexRender.ts:5](https://github.com/TanStack/table/blob/main/packages/vue-table/src/FlexRender.ts#L5) + +#### columnDef + +```ts +columnDef: object; +``` + +##### columnDef.aggregatedCell? + +```ts +optional aggregatedCell: any; +``` + +##### columnDef.cell? + +```ts +optional cell: any; +``` + +*** + +### getContext() + +```ts +getContext: () => any; +``` + +Defined in: [packages/vue-table/src/FlexRender.ts:11](https://github.com/TanStack/table/blob/main/packages/vue-table/src/FlexRender.ts#L11) + +#### Returns + +`any` + +*** + +### getIsAggregated()? + +```ts +optional getIsAggregated: () => boolean; +``` + +Defined in: [packages/vue-table/src/FlexRender.ts:12](https://github.com/TanStack/table/blob/main/packages/vue-table/src/FlexRender.ts#L12) + +#### Returns + +`boolean` + +*** + +### getIsPlaceholder()? + +```ts +optional getIsPlaceholder: () => boolean; +``` + +Defined in: [packages/vue-table/src/FlexRender.ts:13](https://github.com/TanStack/table/blob/main/packages/vue-table/src/FlexRender.ts#L13) + +#### Returns + +`boolean` diff --git a/docs/framework/vue/reference/interfaces/FlexRenderHeader.md b/docs/framework/vue/reference/interfaces/FlexRenderHeader.md new file mode 100644 index 0000000000..a1b99902ab --- /dev/null +++ b/docs/framework/vue/reference/interfaces/FlexRenderHeader.md @@ -0,0 +1,50 @@ +--- +id: FlexRenderHeader +title: FlexRenderHeader +--- + +# Interface: FlexRenderHeader + +Defined in: [packages/vue-table/src/FlexRender.ts:16](https://github.com/TanStack/table/blob/main/packages/vue-table/src/FlexRender.ts#L16) + +## Properties + +### column + +```ts +column: object; +``` + +Defined in: [packages/vue-table/src/FlexRender.ts:17](https://github.com/TanStack/table/blob/main/packages/vue-table/src/FlexRender.ts#L17) + +#### columnDef + +```ts +columnDef: object; +``` + +##### columnDef.footer? + +```ts +optional footer: any; +``` + +##### columnDef.header? + +```ts +optional header: any; +``` + +*** + +### getContext() + +```ts +getContext: () => any; +``` + +Defined in: [packages/vue-table/src/FlexRender.ts:23](https://github.com/TanStack/table/blob/main/packages/vue-table/src/FlexRender.ts#L23) + +#### Returns + +`any` diff --git a/docs/framework/vue/reference/type-aliases/AppVueTable.md b/docs/framework/vue/reference/type-aliases/AppVueTable.md index 12a3144a78..e71b4e6038 100644 --- a/docs/framework/vue/reference/type-aliases/AppVueTable.md +++ b/docs/framework/vue/reference/type-aliases/AppVueTable.md @@ -6,10 +6,10 @@ title: AppVueTable # Type Alias: AppVueTable\ ```ts -type AppVueTable = VueTable & NoInfer & object; +type AppVueTable = VueTable & NoInfer & object; ``` -Defined in: [packages/vue-table/src/createTableHook.ts:222](https://github.com/TanStack/table/blob/main/packages/vue-table/src/createTableHook.ts#L222) +Defined in: [packages/vue-table/src/createTableHook.ts:213](https://github.com/TanStack/table/blob/main/packages/vue-table/src/createTableHook.ts#L213) ## Type Declaration @@ -34,7 +34,7 @@ AppHeader: Component>; ### AppTable ```ts -AppTable: Component>; +AppTable: Component; ``` ### FlexRender diff --git a/docs/framework/vue/reference/type-aliases/SubscribeSource.md b/docs/framework/vue/reference/type-aliases/SubscribeSource.md deleted file mode 100644 index ab765e22ea..0000000000 --- a/docs/framework/vue/reference/type-aliases/SubscribeSource.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -id: SubscribeSource -title: SubscribeSource ---- - -# Type Alias: SubscribeSource\ - -```ts -type SubscribeSource = - | Atom - | ReadonlyAtom - | Store -| ReadonlyStore; -``` - -Defined in: [packages/vue-table/src/useTable.ts:22](https://github.com/TanStack/table/blob/main/packages/vue-table/src/useTable.ts#L22) - -## Type Parameters - -### TValue - -`TValue` diff --git a/docs/framework/vue/reference/type-aliases/TableOptionsWithReactiveData.md b/docs/framework/vue/reference/type-aliases/TableOptionsWithReactiveData.md index 3c9ac65696..53a119f65f 100644 --- a/docs/framework/vue/reference/type-aliases/TableOptionsWithReactiveData.md +++ b/docs/framework/vue/reference/type-aliases/TableOptionsWithReactiveData.md @@ -9,7 +9,7 @@ title: TableOptionsWithReactiveData type TableOptionsWithReactiveData = { [K in keyof TableOptions]: K extends "data" ? MaybeRef> : MaybeRef[K]> }; ``` -Defined in: [packages/vue-table/src/useTable.ts:28](https://github.com/TanStack/table/blob/main/packages/vue-table/src/useTable.ts#L28) +Defined in: [packages/vue-table/src/useTable.ts:14](https://github.com/TanStack/table/blob/main/packages/vue-table/src/useTable.ts#L14) ## Type Parameters diff --git a/docs/framework/vue/reference/type-aliases/VueTable.md b/docs/framework/vue/reference/type-aliases/VueTable.md index fb1d97a01d..6dd288c920 100644 --- a/docs/framework/vue/reference/type-aliases/VueTable.md +++ b/docs/framework/vue/reference/type-aliases/VueTable.md @@ -3,34 +3,16 @@ id: VueTable title: VueTable --- -# Type Alias: VueTable\ +# Type Alias: VueTable\ ```ts -type VueTable = Omit, "store"> & object; +type VueTable = Omit, "store"> & object; ``` -Defined in: [packages/vue-table/src/useTable.ts:61](https://github.com/TanStack/table/blob/main/packages/vue-table/src/useTable.ts#L61) +Defined in: [packages/vue-table/src/useTable.ts:47](https://github.com/TanStack/table/blob/main/packages/vue-table/src/useTable.ts#L47) ## Type Declaration -### state - -```ts -readonly state: Readonly; -``` - -The selected state of the table. This state may not match the structure of -the full table state because it is selected by the selector function that -you pass as the 2nd argument to `useTable`. - -#### Example - -```ts -const table = useTable(options, (state) => ({ globalFilter: state.globalFilter })) // only globalFilter is part of the selected state - -console.log(table.state.globalFilter) -``` - ### ~~store~~ ```ts @@ -39,172 +21,30 @@ readonly store: Table["store"]; #### Deprecated -Prefer `table.state` for render reads, -`table.atoms..get()` for slice snapshots, or -`table.Subscribe` / `useSelector(table.store, selector)` for explicit -subscriptions. `table.store.state` is a current-value snapshot and is easy -to misuse in render code. +Prefer `table.atoms..get()` for slice snapshots, or +`table.Subscribe` for explicit subscriptions. `table.store.state` is a +current-value snapshot and is easy to misuse in render code. ### Subscribe() ```ts -Subscribe: { - (props): - | VNode - | VNode[]; - (props): - | VNode - | VNode[]; - (props): - | VNode - | VNode[]; -}; -``` - -Store mode: `selector` required. Source mode: pass `source` (atom or store); omit -`selector` for the whole value (identity), or pass `selector` to project. Split -overloads so source-only infers `TSourceValue` for `children` (see React `Subscribe`). - -#### Call Signature - -```ts -(props): - | VNode - | VNode[]; +Subscribe: (props) => VNode | VNode[]; ``` -##### Type Parameters +Creates a reactive render boundary. The child function reads the table +atoms it needs, so Vue only tracks those atom reads. -###### TSourceValue +#### Parameters -`TSourceValue` - -##### Parameters - -###### props +##### props ###### children -(`state`) => `VNode` \| `VNode`[] \| `VNode` \| `VNode`[] - -###### selector? - -`undefined` - -###### source - -[`SubscribeSource`](SubscribeSource.md)\<`TSourceValue`\> - -##### Returns - - \| `VNode`\<`RendererNode`, `RendererElement`, \{ -\[`key`: `string`\]: `any`; -\}\> - \| `VNode`\<`RendererNode`, `RendererElement`, \{ -\[`key`: `string`\]: `any`; -\}\>[] - -#### Call Signature - -```ts -(props): - | VNode - | VNode[]; -``` - -##### Type Parameters - -###### TSourceValue - -`TSourceValue` +(`atoms`) => `VNode` \| `VNode`[] -###### TSubSelected +#### Returns -`TSubSelected` - -##### Parameters - -###### props - -###### children - -(`state`) => `VNode` \| `VNode`[] \| `VNode` \| `VNode`[] - -###### selector - -(`state`) => `TSubSelected` - -###### source - -[`SubscribeSource`](SubscribeSource.md)\<`TSourceValue`\> - -##### Returns - - \| `VNode`\<`RendererNode`, `RendererElement`, \{ -\[`key`: `string`\]: `any`; -\}\> - \| `VNode`\<`RendererNode`, `RendererElement`, \{ -\[`key`: `string`\]: `any`; -\}\>[] - -#### Call Signature - -```ts -(props): - | VNode - | VNode[]; -``` - -##### Type Parameters - -###### TSubSelected - -`TSubSelected` - -##### Parameters - -###### props - -###### children - -(`state`) => `VNode` \| `VNode`[] \| `VNode` \| `VNode`[] - -###### selector - -(`state`) => `TSubSelected` - -##### Returns - - \| `VNode`\<`RendererNode`, `RendererElement`, \{ -\[`key`: `string`\]: `any`; -\}\> - \| `VNode`\<`RendererNode`, `RendererElement`, \{ -\[`key`: `string`\]: `any`; -\}\>[] +`VNode` \| `VNode`[] ## Type Parameters @@ -215,7 +55,3 @@ overloads so source-only infers `TSourceValue` for `children` (see React `Subscr ### TData `TData` *extends* `RowData` - -### TSelected - -`TSelected` = `TableState`\<`TFeatures`\> diff --git a/docs/framework/vue/reference/variables/AppFlexRender.md b/docs/framework/vue/reference/variables/AppFlexRender.md index 079ca0d912..687b121d42 100644 --- a/docs/framework/vue/reference/variables/AppFlexRender.md +++ b/docs/framework/vue/reference/variables/AppFlexRender.md @@ -9,15 +9,15 @@ title: AppFlexRender const AppFlexRender: DefineComponent; + type: PropType; }; footer: { default: undefined; - type: PropType; + type: PropType; }; header: { default: undefined; - type: PropType; + type: PropType; }; }>, () => | VNode; + type: PropType; }; footer: { default: undefined; - type: PropType; + type: PropType; }; header: { default: undefined; - type: PropType; + type: PropType; }; }>, { }>, { - cell: any; - footer: any; - header: any; + cell: FlexRenderCell; + footer: FlexRenderHeader; + header: FlexRenderHeader; }, { }, { }, { @@ -52,4 +52,4 @@ const AppFlexRender: DefineComponent; ``` -Defined in: [packages/vue-table/src/createTableHook.ts:238](https://github.com/TanStack/table/blob/main/packages/vue-table/src/createTableHook.ts#L238) +Defined in: [packages/vue-table/src/createTableHook.ts:229](https://github.com/TanStack/table/blob/main/packages/vue-table/src/createTableHook.ts#L229) diff --git a/docs/framework/vue/reference/variables/FlexRender.md b/docs/framework/vue/reference/variables/FlexRender.md index e3c33b6d49..dd6ce6f32e 100644 --- a/docs/framework/vue/reference/variables/FlexRender.md +++ b/docs/framework/vue/reference/variables/FlexRender.md @@ -7,9 +7,9 @@ title: FlexRender ```ts const FlexRender: DefineComponent<{ - cell?: any; - footer?: any; - header?: any; + cell?: FlexRenderCell; + footer?: FlexRenderHeader; + header?: FlexRenderHeader; props?: any; render?: any; }, () => any, { @@ -17,16 +17,16 @@ const FlexRender: DefineComponent<{ }, { }, ComponentOptionsMixin, ComponentOptionsMixin, { }, string, PublicProps, ToResolvedProps<{ - cell?: any; - footer?: any; - header?: any; + cell?: FlexRenderCell; + footer?: FlexRenderHeader; + header?: FlexRenderHeader; props?: any; render?: any; }, { }>, { - cell: any; - footer: any; - header: any; + cell: FlexRenderCell; + footer: FlexRenderHeader; + header: FlexRenderHeader; props: any; render: any; }, { @@ -36,7 +36,7 @@ const FlexRender: DefineComponent<{ }, any>; ``` -Defined in: [packages/vue-table/src/FlexRender.ts:52](https://github.com/TanStack/table/blob/main/packages/vue-table/src/FlexRender.ts#L52) +Defined in: [packages/vue-table/src/FlexRender.ts:67](https://github.com/TanStack/table/blob/main/packages/vue-table/src/FlexRender.ts#L67) Simplified component for rendering headers, cells, or footers. diff --git a/docs/reference/index/functions/aggregationFn_count.md b/docs/reference/index/functions/aggregationFn_count.md new file mode 100644 index 0000000000..c44c02b963 --- /dev/null +++ b/docs/reference/index/functions/aggregationFn_count.md @@ -0,0 +1,40 @@ +--- +id: aggregationFn_count +title: aggregationFn_count +--- + +# Function: aggregationFn\_count() + +```ts +function aggregationFn_count(_columnId, leafRows): number; +``` + +Defined in: [fns/aggregationFns.ts:221](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/aggregationFns.ts#L221) + +Counts the number of leaf rows in the group. + +The column id is ignored because the result is based only on group size. + +## Type Parameters + +### TFeatures + +`TFeatures` *extends* [`TableFeatures`](../interfaces/TableFeatures.md) + +### TData + +`TData` *extends* [`RowData`](../type-aliases/RowData.md) + +## Parameters + +### \_columnId + +`string` + +### leafRows + +[`Row`](../type-aliases/Row.md)\<`TFeatures`, `TData`\>[] + +## Returns + +`number` diff --git a/docs/reference/index/functions/aggregationFn_extent.md b/docs/reference/index/functions/aggregationFn_extent.md new file mode 100644 index 0000000000..dba9d405ac --- /dev/null +++ b/docs/reference/index/functions/aggregationFn_extent.md @@ -0,0 +1,48 @@ +--- +id: aggregationFn_extent +title: aggregationFn_extent +--- + +# Function: aggregationFn\_extent() + +```ts +function aggregationFn_extent( + columnId, + _leafRows, + childRows): (number | undefined)[]; +``` + +Defined in: [fns/aggregationFns.ts:94](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/aggregationFns.ts#L94) + +Finds the numeric extent for a grouped column. + +Returns `[min, max]`, where each entry is `undefined` when no numeric value is +present. + +## Type Parameters + +### TFeatures + +`TFeatures` *extends* [`TableFeatures`](../interfaces/TableFeatures.md) + +### TData + +`TData` *extends* [`RowData`](../type-aliases/RowData.md) + +## Parameters + +### columnId + +`string` + +### \_leafRows + +[`Row`](../type-aliases/Row.md)\<`TFeatures`, `TData`\>[] + +### childRows + +[`Row`](../type-aliases/Row.md)\<`TFeatures`, `TData`\>[] + +## Returns + +(`number` \| `undefined`)[] diff --git a/docs/reference/index/functions/aggregationFn_max.md b/docs/reference/index/functions/aggregationFn_max.md new file mode 100644 index 0000000000..177b4b9a69 --- /dev/null +++ b/docs/reference/index/functions/aggregationFn_max.md @@ -0,0 +1,48 @@ +--- +id: aggregationFn_max +title: aggregationFn_max +--- + +# Function: aggregationFn\_max() + +```ts +function aggregationFn_max( + columnId, + _leafRows, + childRows): number | undefined; +``` + +Defined in: [fns/aggregationFns.ts:64](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/aggregationFns.ts#L64) + +Finds the maximum numeric child-row value for a grouped column. + +Nullish and non-number values are ignored. Returns `undefined` when no +numeric value is found. + +## Type Parameters + +### TFeatures + +`TFeatures` *extends* [`TableFeatures`](../interfaces/TableFeatures.md) + +### TData + +`TData` *extends* [`RowData`](../type-aliases/RowData.md) + +## Parameters + +### columnId + +`string` + +### \_leafRows + +[`Row`](../type-aliases/Row.md)\<`TFeatures`, `TData`\>[] + +### childRows + +[`Row`](../type-aliases/Row.md)\<`TFeatures`, `TData`\>[] + +## Returns + +`number` \| `undefined` diff --git a/docs/reference/index/functions/aggregationFn_mean.md b/docs/reference/index/functions/aggregationFn_mean.md new file mode 100644 index 0000000000..38b2c7e549 --- /dev/null +++ b/docs/reference/index/functions/aggregationFn_mean.md @@ -0,0 +1,41 @@ +--- +id: aggregationFn_mean +title: aggregationFn_mean +--- + +# Function: aggregationFn\_mean() + +```ts +function aggregationFn_mean(columnId, leafRows): number | undefined; +``` + +Defined in: [fns/aggregationFns.ts:126](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/aggregationFns.ts#L126) + +Averages numeric leaf-row values for a grouped column. + +Number-like values are coerced with unary `+`; nullish and non-numeric values +are ignored. + +## Type Parameters + +### TFeatures + +`TFeatures` *extends* [`TableFeatures`](../interfaces/TableFeatures.md) + +### TData + +`TData` *extends* [`RowData`](../type-aliases/RowData.md) + +## Parameters + +### columnId + +`string` + +### leafRows + +[`Row`](../type-aliases/Row.md)\<`TFeatures`, `TData`\>[] + +## Returns + +`number` \| `undefined` diff --git a/docs/reference/index/functions/aggregationFn_median.md b/docs/reference/index/functions/aggregationFn_median.md new file mode 100644 index 0000000000..115ee3d544 --- /dev/null +++ b/docs/reference/index/functions/aggregationFn_median.md @@ -0,0 +1,41 @@ +--- +id: aggregationFn_median +title: aggregationFn_median +--- + +# Function: aggregationFn\_median() + +```ts +function aggregationFn_median(columnId, leafRows): number | undefined; +``` + +Defined in: [fns/aggregationFns.ts:158](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/aggregationFns.ts#L158) + +Computes the median of numeric leaf-row values for a grouped column. + +All values must be numbers. If any value is non-numeric, or no leaf rows are +present, the result is `undefined`. + +## Type Parameters + +### TFeatures + +`TFeatures` *extends* [`TableFeatures`](../interfaces/TableFeatures.md) + +### TData + +`TData` *extends* [`RowData`](../type-aliases/RowData.md) + +## Parameters + +### columnId + +`string` + +### leafRows + +[`Row`](../type-aliases/Row.md)\<`TFeatures`, `TData`\>[] + +## Returns + +`number` \| `undefined` diff --git a/docs/reference/index/functions/aggregationFn_min.md b/docs/reference/index/functions/aggregationFn_min.md new file mode 100644 index 0000000000..76748717ab --- /dev/null +++ b/docs/reference/index/functions/aggregationFn_min.md @@ -0,0 +1,48 @@ +--- +id: aggregationFn_min +title: aggregationFn_min +--- + +# Function: aggregationFn\_min() + +```ts +function aggregationFn_min( + columnId, + _leafRows, + childRows): number | undefined; +``` + +Defined in: [fns/aggregationFns.ts:33](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/aggregationFns.ts#L33) + +Finds the minimum numeric child-row value for a grouped column. + +Nullish and non-number values are ignored. Returns `undefined` when no +numeric value is found. + +## Type Parameters + +### TFeatures + +`TFeatures` *extends* [`TableFeatures`](../interfaces/TableFeatures.md) + +### TData + +`TData` *extends* [`RowData`](../type-aliases/RowData.md) + +## Parameters + +### columnId + +`string` + +### \_leafRows + +[`Row`](../type-aliases/Row.md)\<`TFeatures`, `TData`\>[] + +### childRows + +[`Row`](../type-aliases/Row.md)\<`TFeatures`, `TData`\>[] + +## Returns + +`number` \| `undefined` diff --git a/docs/reference/index/functions/aggregationFn_sum.md b/docs/reference/index/functions/aggregationFn_sum.md new file mode 100644 index 0000000000..6b0949ab18 --- /dev/null +++ b/docs/reference/index/functions/aggregationFn_sum.md @@ -0,0 +1,48 @@ +--- +id: aggregationFn_sum +title: aggregationFn_sum +--- + +# Function: aggregationFn\_sum() + +```ts +function aggregationFn_sum( + columnId, + _leafRows, + childRows): number; +``` + +Defined in: [fns/aggregationFns.ts:11](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/aggregationFns.ts#L11) + +Sums numeric child-row values for a grouped column. + +Non-number values contribute `0`. Child rows are used so nested group totals +can reuse already aggregated values. + +## Type Parameters + +### TFeatures + +`TFeatures` *extends* [`TableFeatures`](../interfaces/TableFeatures.md) + +### TData + +`TData` *extends* [`RowData`](../type-aliases/RowData.md) + +## Parameters + +### columnId + +`string` + +### \_leafRows + +[`Row`](../type-aliases/Row.md)\<`TFeatures`, `TData`\>[] + +### childRows + +[`Row`](../type-aliases/Row.md)\<`TFeatures`, `TData`\>[] + +## Returns + +`number` diff --git a/docs/reference/index/functions/aggregationFn_unique.md b/docs/reference/index/functions/aggregationFn_unique.md new file mode 100644 index 0000000000..e6c3a39973 --- /dev/null +++ b/docs/reference/index/functions/aggregationFn_unique.md @@ -0,0 +1,40 @@ +--- +id: aggregationFn_unique +title: aggregationFn_unique +--- + +# Function: aggregationFn\_unique() + +```ts +function aggregationFn_unique(columnId, leafRows): unknown[]; +``` + +Defined in: [fns/aggregationFns.ts:189](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/aggregationFns.ts#L189) + +Collects unique leaf-row values for a grouped column. + +Values are compared with JavaScript `Set` semantics. + +## Type Parameters + +### TFeatures + +`TFeatures` *extends* [`TableFeatures`](../interfaces/TableFeatures.md) + +### TData + +`TData` *extends* [`RowData`](../type-aliases/RowData.md) + +## Parameters + +### columnId + +`string` + +### leafRows + +[`Row`](../type-aliases/Row.md)\<`TFeatures`, `TData`\>[] + +## Returns + +`unknown`[] diff --git a/docs/reference/index/functions/aggregationFn_uniqueCount.md b/docs/reference/index/functions/aggregationFn_uniqueCount.md new file mode 100644 index 0000000000..9f3f17f8a4 --- /dev/null +++ b/docs/reference/index/functions/aggregationFn_uniqueCount.md @@ -0,0 +1,40 @@ +--- +id: aggregationFn_uniqueCount +title: aggregationFn_uniqueCount +--- + +# Function: aggregationFn\_uniqueCount() + +```ts +function aggregationFn_uniqueCount(columnId, leafRows): number; +``` + +Defined in: [fns/aggregationFns.ts:205](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/aggregationFns.ts#L205) + +Counts unique leaf-row values for a grouped column. + +Values are compared with JavaScript `Set` semantics. + +## Type Parameters + +### TFeatures + +`TFeatures` *extends* [`TableFeatures`](../interfaces/TableFeatures.md) + +### TData + +`TData` *extends* [`RowData`](../type-aliases/RowData.md) + +## Parameters + +### columnId + +`string` + +### leafRows + +[`Row`](../type-aliases/Row.md)\<`TFeatures`, `TData`\>[] + +## Returns + +`number` diff --git a/docs/reference/index/functions/callMemoOrStaticFn.md b/docs/reference/index/functions/callMemoOrStaticFn.md index 8bdc12f8f5..fe8041de9d 100644 --- a/docs/reference/index/functions/callMemoOrStaticFn.md +++ b/docs/reference/index/functions/callMemoOrStaticFn.md @@ -6,11 +6,11 @@ title: callMemoOrStaticFn # Function: callMemoOrStaticFn() ```ts -function callMemoOrStaticFn( +function callMemoOrStaticFn( obj, fnKey, staticFn, ... -args): ReturnType; + args): TReturn; ``` Defined in: [utils.ts:428](https://github.com/TanStack/table/blob/main/packages/table-core/src/utils.ts#L428) @@ -23,9 +23,13 @@ Looks to run the memoized function with the builder pattern on the object if it `TObject` *extends* `Record`\<`string`, `any`\> -### TStaticFn +### TArgs -`TStaticFn` *extends* `AnyFunction` +`TArgs` *extends* `any`[] + +### TReturn + +`TReturn` ## Parameters @@ -39,12 +43,12 @@ Looks to run the memoized function with the builder pattern on the object if it ### staticFn -`TStaticFn` +(`obj`, ...`args`) => `TReturn` ### args -...`Parameters`\<`TStaticFn`\> *extends* \[`any`, `...Rest[]`\] ? `Rest` : `never` +...`TArgs` ## Returns -`ReturnType`\<`TStaticFn`\> +`TReturn` diff --git a/docs/reference/index/functions/constructColumnFacetingFeature.md b/docs/reference/index/functions/constructColumnFacetingFeature.md deleted file mode 100644 index 122d50defa..0000000000 --- a/docs/reference/index/functions/constructColumnFacetingFeature.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -id: constructColumnFacetingFeature -title: constructColumnFacetingFeature ---- - -# Function: constructColumnFacetingFeature() - -```ts -function constructColumnFacetingFeature(): TableFeature>; -``` - -Defined in: [features/column-faceting/columnFacetingFeature.ts:37](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-faceting/columnFacetingFeature.ts#L37) - -Creates the stock column faceting feature. - -The returned feature registers its state defaults, option defaults, and instance APIs so it can be included in a `tableFeatures({ ... })` call. - -## Type Parameters - -### TFeatures - -`TFeatures` *extends* [`TableFeatures`](../interfaces/TableFeatures.md) - -### TData - -`TData` *extends* [`RowData`](../type-aliases/RowData.md) - -## Returns - -[`TableFeature`](../interfaces/TableFeature.md)\<[`ColumnFacetingFeatureConstructors`](../interfaces/ColumnFacetingFeatureConstructors.md)\<`TFeatures`, `TData`\>\> diff --git a/docs/reference/index/functions/constructColumnFilteringFeature.md b/docs/reference/index/functions/constructColumnFilteringFeature.md deleted file mode 100644 index 2685c27ed1..0000000000 --- a/docs/reference/index/functions/constructColumnFilteringFeature.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -id: constructColumnFilteringFeature -title: constructColumnFilteringFeature ---- - -# Function: constructColumnFilteringFeature() - -```ts -function constructColumnFilteringFeature(): TableFeature>; -``` - -Defined in: [features/column-filtering/columnFilteringFeature.ts:52](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-filtering/columnFilteringFeature.ts#L52) - -Creates the stock column filtering feature. - -The returned feature registers its state defaults, option defaults, and instance APIs so it can be included in a `tableFeatures({ ... })` call. - -## Type Parameters - -### TFeatures - -`TFeatures` *extends* [`TableFeatures`](../interfaces/TableFeatures.md) - -### TData - -`TData` *extends* [`RowData`](../type-aliases/RowData.md) - -## Returns - -[`TableFeature`](../interfaces/TableFeature.md)\<[`ColumnFilteringFeatureConstructors`](../interfaces/ColumnFilteringFeatureConstructors.md)\<`TFeatures`, `TData`\>\> diff --git a/docs/reference/index/functions/constructColumnGroupingFeature.md b/docs/reference/index/functions/constructColumnGroupingFeature.md deleted file mode 100644 index 96fcd8a3d8..0000000000 --- a/docs/reference/index/functions/constructColumnGroupingFeature.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -id: constructColumnGroupingFeature -title: constructColumnGroupingFeature ---- - -# Function: constructColumnGroupingFeature() - -```ts -function constructColumnGroupingFeature(): TableFeature>; -``` - -Defined in: [features/column-grouping/columnGroupingFeature.ts:59](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/columnGroupingFeature.ts#L59) - -Creates the stock column grouping feature. - -The returned feature registers its state defaults, option defaults, and instance APIs so it can be included in a `tableFeatures({ ... })` call. - -## Type Parameters - -### TFeatures - -`TFeatures` *extends* [`TableFeatures`](../interfaces/TableFeatures.md) - -### TData - -`TData` *extends* [`RowData`](../type-aliases/RowData.md) - -## Returns - -[`TableFeature`](../interfaces/TableFeature.md)\<[`ColumnGroupingFeatureConstructors`](../interfaces/ColumnGroupingFeatureConstructors.md)\<`TFeatures`, `TData`\>\> diff --git a/docs/reference/index/functions/constructColumnOrderingFeature.md b/docs/reference/index/functions/constructColumnOrderingFeature.md deleted file mode 100644 index 9a06c10bd9..0000000000 --- a/docs/reference/index/functions/constructColumnOrderingFeature.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -id: constructColumnOrderingFeature -title: constructColumnOrderingFeature ---- - -# Function: constructColumnOrderingFeature() - -```ts -function constructColumnOrderingFeature(): TableFeature>; -``` - -Defined in: [features/column-ordering/columnOrderingFeature.ts:39](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-ordering/columnOrderingFeature.ts#L39) - -Creates the stock column ordering feature. - -The returned feature registers its state defaults, option defaults, and instance APIs so it can be included in a `tableFeatures({ ... })` call. - -## Type Parameters - -### TFeatures - -`TFeatures` *extends* [`TableFeatures`](../interfaces/TableFeatures.md) - -### TData - -`TData` *extends* [`RowData`](../type-aliases/RowData.md) - -## Returns - -[`TableFeature`](../interfaces/TableFeature.md)\<[`ColumnOrderingFeatureConstructors`](../interfaces/ColumnOrderingFeatureConstructors.md)\<`TFeatures`, `TData`\>\> diff --git a/docs/reference/index/functions/constructColumnPinningFeature.md b/docs/reference/index/functions/constructColumnPinningFeature.md deleted file mode 100644 index 4972f931ff..0000000000 --- a/docs/reference/index/functions/constructColumnPinningFeature.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -id: constructColumnPinningFeature -title: constructColumnPinningFeature ---- - -# Function: constructColumnPinningFeature() - -```ts -function constructColumnPinningFeature(): TableFeature>; -``` - -Defined in: [features/column-pinning/columnPinningFeature.ts:69](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-pinning/columnPinningFeature.ts#L69) - -Creates the stock column pinning feature. - -The returned feature registers its state defaults, option defaults, and instance APIs so it can be included in a `tableFeatures({ ... })` call. - -## Type Parameters - -### TFeatures - -`TFeatures` *extends* [`TableFeatures`](../interfaces/TableFeatures.md) - -### TData - -`TData` *extends* [`RowData`](../type-aliases/RowData.md) - -## Returns - -[`TableFeature`](../interfaces/TableFeature.md)\<[`ColumnPinningFeatureConstructors`](../interfaces/ColumnPinningFeatureConstructors.md)\<`TFeatures`, `TData`\>\> diff --git a/docs/reference/index/functions/constructColumnResizingFeature.md b/docs/reference/index/functions/constructColumnResizingFeature.md deleted file mode 100644 index 9debde2a3f..0000000000 --- a/docs/reference/index/functions/constructColumnResizingFeature.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -id: constructColumnResizingFeature -title: constructColumnResizingFeature ---- - -# Function: constructColumnResizingFeature() - -```ts -function constructColumnResizingFeature(): TableFeature>; -``` - -Defined in: [features/column-resizing/columnResizingFeature.ts:40](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-resizing/columnResizingFeature.ts#L40) - -Creates the stock column resizing feature. - -The returned feature registers its state defaults, option defaults, and instance APIs so it can be included in a `tableFeatures({ ... })` call. - -## Type Parameters - -### TFeatures - -`TFeatures` *extends* [`TableFeatures`](../interfaces/TableFeatures.md) - -### TData - -`TData` *extends* [`RowData`](../type-aliases/RowData.md) - -## Returns - -[`TableFeature`](../interfaces/TableFeature.md)\<[`ColumnResizingFeatureConstructors`](../interfaces/ColumnResizingFeatureConstructors.md)\<`TFeatures`, `TData`\>\> diff --git a/docs/reference/index/functions/constructColumnSizingFeature.md b/docs/reference/index/functions/constructColumnSizingFeature.md deleted file mode 100644 index 73dce97e65..0000000000 --- a/docs/reference/index/functions/constructColumnSizingFeature.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -id: constructColumnSizingFeature -title: constructColumnSizingFeature ---- - -# Function: constructColumnSizingFeature() - -```ts -function constructColumnSizingFeature(): TableFeature>; -``` - -Defined in: [features/column-sizing/columnSizingFeature.ts:50](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-sizing/columnSizingFeature.ts#L50) - -Creates the stock column sizing feature. - -The returned feature registers its state defaults, option defaults, and instance APIs so it can be included in a `tableFeatures({ ... })` call. - -## Type Parameters - -### TFeatures - -`TFeatures` *extends* [`TableFeatures`](../interfaces/TableFeatures.md) - -### TData - -`TData` *extends* [`RowData`](../type-aliases/RowData.md) - -## Returns - -[`TableFeature`](../interfaces/TableFeature.md)\<[`ColumnSizingFeatureConstructors`](../interfaces/ColumnSizingFeatureConstructors.md)\<`TFeatures`, `TData`\>\> diff --git a/docs/reference/index/functions/constructColumnVisibilityFeature.md b/docs/reference/index/functions/constructColumnVisibilityFeature.md deleted file mode 100644 index 9b2dd8e8e3..0000000000 --- a/docs/reference/index/functions/constructColumnVisibilityFeature.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -id: constructColumnVisibilityFeature -title: constructColumnVisibilityFeature ---- - -# Function: constructColumnVisibilityFeature() - -```ts -function constructColumnVisibilityFeature(): TableFeature>; -``` - -Defined in: [features/column-visibility/columnVisibilityFeature.ts:51](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/columnVisibilityFeature.ts#L51) - -Creates the stock column visibility feature. - -The returned feature registers its state defaults, option defaults, and instance APIs so it can be included in a `tableFeatures({ ... })` call. - -## Type Parameters - -### TFeatures - -`TFeatures` *extends* [`TableFeatures`](../interfaces/TableFeatures.md) - -### TData - -`TData` *extends* [`RowData`](../type-aliases/RowData.md) - -## Returns - -[`TableFeature`](../interfaces/TableFeature.md)\<[`ColumnVisibilityFeatureConstructors`](../interfaces/ColumnVisibilityFeatureConstructors.md)\<`TFeatures`, `TData`\>\> diff --git a/docs/reference/index/functions/constructCoreCellsFeature.md b/docs/reference/index/functions/constructCoreCellsFeature.md deleted file mode 100644 index d815a4ac2a..0000000000 --- a/docs/reference/index/functions/constructCoreCellsFeature.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -id: constructCoreCellsFeature -title: constructCoreCellsFeature ---- - -# Function: constructCoreCellsFeature() - -```ts -function constructCoreCellsFeature(): TableFeature>; -``` - -Defined in: [core/cells/coreCellsFeature.ts:24](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/cells/coreCellsFeature.ts#L24) - -Creates the stock core cells feature. - -The returned feature registers its state defaults, option defaults, and instance APIs so it can be included in a `tableFeatures({ ... })` call. - -## Type Parameters - -### TFeatures - -`TFeatures` *extends* [`TableFeatures`](../interfaces/TableFeatures.md) - -### TData - -`TData` *extends* [`RowData`](../type-aliases/RowData.md) - -## Returns - -[`TableFeature`](../interfaces/TableFeature.md)\<[`CoreCellsFeatureConstructors`](../interfaces/CoreCellsFeatureConstructors.md)\<`TFeatures`, `TData`\>\> diff --git a/docs/reference/index/functions/constructCoreColumnsFeature.md b/docs/reference/index/functions/constructCoreColumnsFeature.md deleted file mode 100644 index c9cdd4f24c..0000000000 --- a/docs/reference/index/functions/constructCoreColumnsFeature.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -id: constructCoreColumnsFeature -title: constructCoreColumnsFeature ---- - -# Function: constructCoreColumnsFeature() - -```ts -function constructCoreColumnsFeature(): TableFeature>; -``` - -Defined in: [core/columns/coreColumnsFeature.ts:35](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/columns/coreColumnsFeature.ts#L35) - -Creates the stock core columns feature. - -The returned feature registers its state defaults, option defaults, and instance APIs so it can be included in a `tableFeatures({ ... })` call. - -## Type Parameters - -### TFeatures - -`TFeatures` *extends* [`TableFeatures`](../interfaces/TableFeatures.md) - -### TData - -`TData` *extends* [`RowData`](../type-aliases/RowData.md) - -## Returns - -[`TableFeature`](../interfaces/TableFeature.md)\<[`CoreColumnsFeatureConstructors`](../interfaces/CoreColumnsFeatureConstructors.md)\<`TFeatures`, `TData`\>\> diff --git a/docs/reference/index/functions/constructCoreHeadersFeature.md b/docs/reference/index/functions/constructCoreHeadersFeature.md deleted file mode 100644 index 9688ad573e..0000000000 --- a/docs/reference/index/functions/constructCoreHeadersFeature.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -id: constructCoreHeadersFeature -title: constructCoreHeadersFeature ---- - -# Function: constructCoreHeadersFeature() - -```ts -function constructCoreHeadersFeature(): TableFeature>; -``` - -Defined in: [core/headers/coreHeadersFeature.ts:27](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/headers/coreHeadersFeature.ts#L27) - -Creates the stock core headers feature. - -The returned feature registers its state defaults, option defaults, and instance APIs so it can be included in a `tableFeatures({ ... })` call. - -## Type Parameters - -### TFeatures - -`TFeatures` *extends* [`TableFeatures`](../interfaces/TableFeatures.md) - -### TData - -`TData` *extends* [`RowData`](../type-aliases/RowData.md) - -## Returns - -[`TableFeature`](../interfaces/TableFeature.md)\<[`CoreHeadersFeatureConstructors`](../interfaces/CoreHeadersFeatureConstructors.md)\<`TFeatures`, `TData`\>\> diff --git a/docs/reference/index/functions/constructCoreRowModelsFeature.md b/docs/reference/index/functions/constructCoreRowModelsFeature.md deleted file mode 100644 index cdea1e98bb..0000000000 --- a/docs/reference/index/functions/constructCoreRowModelsFeature.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -id: constructCoreRowModelsFeature -title: constructCoreRowModelsFeature ---- - -# Function: constructCoreRowModelsFeature() - -```ts -function constructCoreRowModelsFeature(): TableFeature>; -``` - -Defined in: [core/row-models/coreRowModelsFeature.ts:32](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/row-models/coreRowModelsFeature.ts#L32) - -Creates the stock core row models feature. - -The returned feature registers its state defaults, option defaults, and instance APIs so it can be included in a `tableFeatures({ ... })` call. - -## Type Parameters - -### TFeatures - -`TFeatures` *extends* [`TableFeatures`](../interfaces/TableFeatures.md) - -### TData - -`TData` *extends* [`RowData`](../type-aliases/RowData.md) - -## Returns - -[`TableFeature`](../interfaces/TableFeature.md)\<[`CoreRowModelsFeatureConstructors`](../interfaces/CoreRowModelsFeatureConstructors.md)\<`TFeatures`, `TData`\>\> diff --git a/docs/reference/index/functions/constructCoreRowsFeature.md b/docs/reference/index/functions/constructCoreRowsFeature.md deleted file mode 100644 index cc3244ce65..0000000000 --- a/docs/reference/index/functions/constructCoreRowsFeature.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -id: constructCoreRowsFeature -title: constructCoreRowsFeature ---- - -# Function: constructCoreRowsFeature() - -```ts -function constructCoreRowsFeature(): TableFeature>; -``` - -Defined in: [core/rows/coreRowsFeature.ts:36](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/coreRowsFeature.ts#L36) - -Creates the stock core rows feature. - -The returned feature registers its state defaults, option defaults, and instance APIs so it can be included in a `tableFeatures({ ... })` call. - -## Type Parameters - -### TFeatures - -`TFeatures` *extends* [`TableFeatures`](../interfaces/TableFeatures.md) - -### TData - -`TData` *extends* [`RowData`](../type-aliases/RowData.md) - -## Returns - -[`TableFeature`](../interfaces/TableFeature.md)\<[`CoreRowsFeatureConstructors`](../interfaces/CoreRowsFeatureConstructors.md)\<`TFeatures`, `TData`\>\> diff --git a/docs/reference/index/functions/constructCoreTablesFeature.md b/docs/reference/index/functions/constructCoreTablesFeature.md deleted file mode 100644 index 59fd9a512d..0000000000 --- a/docs/reference/index/functions/constructCoreTablesFeature.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -id: constructCoreTablesFeature -title: constructCoreTablesFeature ---- - -# Function: constructCoreTablesFeature() - -```ts -function constructCoreTablesFeature(): TableFeature>; -``` - -Defined in: [core/table/coreTablesFeature.ts:20](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/table/coreTablesFeature.ts#L20) - -Creates the stock core tables feature. - -The returned feature registers its state defaults, option defaults, and instance APIs so it can be included in a `tableFeatures({ ... })` call. - -## Type Parameters - -### TFeatures - -`TFeatures` *extends* [`TableFeatures`](../interfaces/TableFeatures.md) - -### TData - -`TData` *extends* [`RowData`](../type-aliases/RowData.md) - -## Returns - -[`TableFeature`](../interfaces/TableFeature.md)\<[`CoreTablesFeatureConstructors`](../interfaces/CoreTablesFeatureConstructors.md)\<`TFeatures`, `TData`\>\> diff --git a/docs/reference/index/functions/constructGlobalFilteringFeature.md b/docs/reference/index/functions/constructGlobalFilteringFeature.md deleted file mode 100644 index 07e28b6eb2..0000000000 --- a/docs/reference/index/functions/constructGlobalFilteringFeature.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -id: constructGlobalFilteringFeature -title: constructGlobalFilteringFeature ---- - -# Function: constructGlobalFilteringFeature() - -```ts -function constructGlobalFilteringFeature(): TableFeature>; -``` - -Defined in: [features/global-filtering/globalFilteringFeature.ts:39](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/global-filtering/globalFilteringFeature.ts#L39) - -Creates the stock global filtering feature. - -The returned feature registers its state defaults, option defaults, and instance APIs so it can be included in a `tableFeatures({ ... })` call. - -## Type Parameters - -### TFeatures - -`TFeatures` *extends* [`TableFeatures`](../interfaces/TableFeatures.md) - -### TData - -`TData` *extends* [`RowData`](../type-aliases/RowData.md) - -## Returns - -[`TableFeature`](../interfaces/TableFeature.md)\<[`GlobalFilteringFeatureConstructors`](../interfaces/GlobalFilteringFeatureConstructors.md)\<`TFeatures`, `TData`\>\> diff --git a/docs/reference/index/functions/constructRowExpandingFeature.md b/docs/reference/index/functions/constructRowExpandingFeature.md deleted file mode 100644 index f12f8e8a36..0000000000 --- a/docs/reference/index/functions/constructRowExpandingFeature.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -id: constructRowExpandingFeature -title: constructRowExpandingFeature ---- - -# Function: constructRowExpandingFeature() - -```ts -function constructRowExpandingFeature(): TableFeature>; -``` - -Defined in: [features/row-expanding/rowExpandingFeature.ts:51](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-expanding/rowExpandingFeature.ts#L51) - -Creates the stock row expanding feature. - -The returned feature registers its state defaults, option defaults, and instance APIs so it can be included in a `tableFeatures({ ... })` call. - -## Type Parameters - -### TFeatures - -`TFeatures` *extends* [`TableFeatures`](../interfaces/TableFeatures.md) - -### TData - -`TData` *extends* [`RowData`](../type-aliases/RowData.md) - -## Returns - -[`TableFeature`](../interfaces/TableFeature.md)\<[`RowExpandingFeatureConstructors`](../interfaces/RowExpandingFeatureConstructors.md)\<`TFeatures`, `TData`\>\> diff --git a/docs/reference/index/functions/constructRowPaginationFeature.md b/docs/reference/index/functions/constructRowPaginationFeature.md deleted file mode 100644 index d7af1271c4..0000000000 --- a/docs/reference/index/functions/constructRowPaginationFeature.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -id: constructRowPaginationFeature -title: constructRowPaginationFeature ---- - -# Function: constructRowPaginationFeature() - -```ts -function constructRowPaginationFeature(): TableFeature>; -``` - -Defined in: [features/row-pagination/rowPaginationFeature.ts:47](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pagination/rowPaginationFeature.ts#L47) - -Creates the stock row pagination feature. - -The returned feature registers its state defaults, option defaults, and instance APIs so it can be included in a `tableFeatures({ ... })` call. - -## Type Parameters - -### TFeatures - -`TFeatures` *extends* [`TableFeatures`](../interfaces/TableFeatures.md) - -### TData - -`TData` *extends* [`RowData`](../type-aliases/RowData.md) - -## Returns - -[`TableFeature`](../interfaces/TableFeature.md)\<[`RowPaginationFeatureConstructors`](../interfaces/RowPaginationFeatureConstructors.md)\<`TFeatures`, `TData`\>\> diff --git a/docs/reference/index/functions/constructRowPinningFeature.md b/docs/reference/index/functions/constructRowPinningFeature.md deleted file mode 100644 index 42450c459d..0000000000 --- a/docs/reference/index/functions/constructRowPinningFeature.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -id: constructRowPinningFeature -title: constructRowPinningFeature ---- - -# Function: constructRowPinningFeature() - -```ts -function constructRowPinningFeature(): TableFeature>; -``` - -Defined in: [features/row-pinning/rowPinningFeature.ts:43](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pinning/rowPinningFeature.ts#L43) - -Creates the stock row pinning feature. - -The returned feature registers its state defaults, option defaults, and instance APIs so it can be included in a `tableFeatures({ ... })` call. - -## Type Parameters - -### TFeatures - -`TFeatures` *extends* [`TableFeatures`](../interfaces/TableFeatures.md) - -### TData - -`TData` *extends* [`RowData`](../type-aliases/RowData.md) - -## Returns - -[`TableFeature`](../interfaces/TableFeature.md)\<[`RowPinningFeatureConstructors`](../interfaces/RowPinningFeatureConstructors.md)\<`TFeatures`, `TData`\>\> diff --git a/docs/reference/index/functions/constructRowSelectionFeature.md b/docs/reference/index/functions/constructRowSelectionFeature.md deleted file mode 100644 index e443b17b11..0000000000 --- a/docs/reference/index/functions/constructRowSelectionFeature.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -id: constructRowSelectionFeature -title: constructRowSelectionFeature ---- - -# Function: constructRowSelectionFeature() - -```ts -function constructRowSelectionFeature(): TableFeature>; -``` - -Defined in: [features/row-selection/rowSelectionFeature.ts:55](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/rowSelectionFeature.ts#L55) - -Creates the stock row selection feature. - -The returned feature registers its state defaults, option defaults, and instance APIs so it can be included in a `tableFeatures({ ... })` call. - -## Type Parameters - -### TFeatures - -`TFeatures` *extends* [`TableFeatures`](../interfaces/TableFeatures.md) - -### TData - -`TData` *extends* [`RowData`](../type-aliases/RowData.md) - -## Returns - -[`TableFeature`](../interfaces/TableFeature.md)\<[`RowSelectionFeatureConstructors`](../interfaces/RowSelectionFeatureConstructors.md)\<`TFeatures`, `TData`\>\> diff --git a/docs/reference/index/functions/constructRowSortingFeature.md b/docs/reference/index/functions/constructRowSortingFeature.md deleted file mode 100644 index 9b1aae9ad2..0000000000 --- a/docs/reference/index/functions/constructRowSortingFeature.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -id: constructRowSortingFeature -title: constructRowSortingFeature ---- - -# Function: constructRowSortingFeature() - -```ts -function constructRowSortingFeature(): TableFeature>; -``` - -Defined in: [features/row-sorting/rowSortingFeature.ts:55](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/rowSortingFeature.ts#L55) - -Creates the stock row sorting feature. - -The returned feature registers its state defaults, option defaults, and instance APIs so it can be included in a `tableFeatures({ ... })` call. - -## Type Parameters - -### TFeatures - -`TFeatures` *extends* [`TableFeatures`](../interfaces/TableFeatures.md) - -### TData - -`TData` *extends* [`RowData`](../type-aliases/RowData.md) - -## Returns - -[`TableFeature`](../interfaces/TableFeature.md)\<[`RowSortingFeatureConstructors`](../interfaces/RowSortingFeatureConstructors.md)\<`TFeatures`, `TData`\>\> diff --git a/docs/reference/index/functions/constructTable.md b/docs/reference/index/functions/constructTable.md index 544a93cc0c..553dc74793 100644 --- a/docs/reference/index/functions/constructTable.md +++ b/docs/reference/index/functions/constructTable.md @@ -9,7 +9,7 @@ title: constructTable function constructTable(tableOptions): Table; ``` -Defined in: [core/table/constructTable.ts:31](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/table/constructTable.ts#L31) +Defined in: [core/table/constructTable.ts:32](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/table/constructTable.ts#L32) Constructs a table instance from normalized table internals. diff --git a/docs/reference/index/functions/createFilteredRowModel.md b/docs/reference/index/functions/createFilteredRowModel.md index 5182eb3295..c19e574a1d 100644 --- a/docs/reference/index/functions/createFilteredRowModel.md +++ b/docs/reference/index/functions/createFilteredRowModel.md @@ -29,7 +29,7 @@ The factory reads the relevant table state atoms and options, then returns a row ### filterFns -`Record`\\> +`Record`\\> ## Returns diff --git a/docs/reference/index/functions/filterFn_arrHas.md b/docs/reference/index/functions/filterFn_arrHas.md new file mode 100644 index 0000000000..21ae293a31 --- /dev/null +++ b/docs/reference/index/functions/filterFn_arrHas.md @@ -0,0 +1,45 @@ +--- +id: filterFn_arrHas +title: filterFn_arrHas +--- + +# Function: filterFn\_arrHas() + +```ts +function filterFn_arrHas( + row, + columnId, + filterValue): boolean; +``` + +Defined in: [fns/filterFns.ts:293](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/filterFns.ts#L293) + +Keeps rows whose scalar column value equals at least one filter value. + +## Type Parameters + +### TFeatures + +`TFeatures` *extends* [`TableFeatures`](../interfaces/TableFeatures.md) + +### TData + +`TData` *extends* [`RowData`](../type-aliases/RowData.md) + +## Parameters + +### row + +[`Row`](../type-aliases/Row.md)\<`TFeatures`, `TData`\> + +### columnId + +`string` + +### filterValue + +`unknown`[] + +## Returns + +`boolean` diff --git a/docs/reference/index/functions/getInitialTableState.md b/docs/reference/index/functions/getInitialTableState.md index 07fbff1cbe..8a55f27c28 100644 --- a/docs/reference/index/functions/getInitialTableState.md +++ b/docs/reference/index/functions/getInitialTableState.md @@ -9,7 +9,7 @@ title: getInitialTableState function getInitialTableState(features, initialState): TableState; ``` -Defined in: [core/table/constructTable.ts:16](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/table/constructTable.ts#L16) +Defined in: [core/table/constructTable.ts:17](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/table/constructTable.ts#L17) Builds the initial table state from registered features and user initial state. diff --git a/docs/reference/index/functions/makeStateUpdater.md b/docs/reference/index/functions/makeStateUpdater.md index bbd2bee1b7..8010798acf 100644 --- a/docs/reference/index/functions/makeStateUpdater.md +++ b/docs/reference/index/functions/makeStateUpdater.md @@ -45,7 +45,20 @@ The updater writes through the table base atom for the slice and supports both v #### updater -`any` +[`Updater`](../type-aliases/Updater.md)\<[`TableState_RowSorting`](../interfaces/TableState_RowSorting.md) & [`TableState_ColumnSizing`](../interfaces/TableState_ColumnSizing.md) & [`TableState_ColumnResizing`](../interfaces/TableState_ColumnResizing.md) & [`TableState_ColumnPinning`](../interfaces/TableState_ColumnPinning.md) & [`TableState_ColumnOrdering`](../interfaces/TableState_ColumnOrdering.md) & [`TableState_GlobalFiltering`](../interfaces/TableState_GlobalFiltering.md) & [`TableState_ColumnVisibility`](../interfaces/TableState_ColumnVisibility.md) & [`TableState_RowExpanding`](../interfaces/TableState_RowExpanding.md) & [`TableState_RowPinning`](../interfaces/TableState_RowPinning.md) & [`TableState_RowSelection`](../interfaces/TableState_RowSelection.md) & [`TableState_ColumnFiltering`](../interfaces/TableState_ColumnFiltering.md) & [`TableState_RowPagination`](../interfaces/TableState_RowPagination.md) & [`TableState_ColumnGrouping`](../interfaces/TableState_ColumnGrouping.md)\[`K` & + \| `"sorting"` + \| `"columnSizing"` + \| `"columnResizing"` + \| `"columnPinning"` + \| `"columnOrder"` + \| `"globalFilter"` + \| `"columnVisibility"` + \| `"expanded"` + \| `"rowPinning"` + \| `"rowSelection"` + \| `"columnFilters"` + \| `"pagination"` + \| `"grouping"`\]\> ### Returns diff --git a/docs/reference/index/functions/sortFn_alphanumeric.md b/docs/reference/index/functions/sortFn_alphanumeric.md new file mode 100644 index 0000000000..d091acc940 --- /dev/null +++ b/docs/reference/index/functions/sortFn_alphanumeric.md @@ -0,0 +1,47 @@ +--- +id: sortFn_alphanumeric +title: sortFn_alphanumeric +--- + +# Function: sortFn\_alphanumeric() + +```ts +function sortFn_alphanumeric( + rowA, + rowB, + columnId): number; +``` + +Defined in: [fns/sortFns.ts:18](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/sortFns.ts#L18) + +Sorts rows with the built-in alphanumeric strategy. + +This comparator returns ascending-order results; descending order is applied by the sorting row model. + +## Type Parameters + +### TFeatures + +`TFeatures` *extends* [`TableFeatures`](../interfaces/TableFeatures.md) + +### TData + +`TData` *extends* [`RowData`](../type-aliases/RowData.md) + +## Parameters + +### rowA + +[`Row`](../type-aliases/Row.md)\<`TFeatures`, `TData`\> + +### rowB + +[`Row`](../type-aliases/Row.md)\<`TFeatures`, `TData`\> + +### columnId + +`string` + +## Returns + +`number` diff --git a/docs/reference/index/functions/sortFn_alphanumericCaseSensitive.md b/docs/reference/index/functions/sortFn_alphanumericCaseSensitive.md new file mode 100644 index 0000000000..33fa9bd69d --- /dev/null +++ b/docs/reference/index/functions/sortFn_alphanumericCaseSensitive.md @@ -0,0 +1,47 @@ +--- +id: sortFn_alphanumericCaseSensitive +title: sortFn_alphanumericCaseSensitive +--- + +# Function: sortFn\_alphanumericCaseSensitive() + +```ts +function sortFn_alphanumericCaseSensitive( + rowA, + rowB, + columnId): number; +``` + +Defined in: [fns/sortFns.ts:37](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/sortFns.ts#L37) + +Sorts rows with the built-in alphanumeric case sensitive strategy. + +This comparator returns ascending-order results; descending order is applied by the sorting row model. + +## Type Parameters + +### TFeatures + +`TFeatures` *extends* [`TableFeatures`](../interfaces/TableFeatures.md) + +### TData + +`TData` *extends* [`RowData`](../type-aliases/RowData.md) + +## Parameters + +### rowA + +[`Row`](../type-aliases/Row.md)\<`TFeatures`, `TData`\> + +### rowB + +[`Row`](../type-aliases/Row.md)\<`TFeatures`, `TData`\> + +### columnId + +`string` + +## Returns + +`number` diff --git a/docs/reference/index/functions/sortFn_basic.md b/docs/reference/index/functions/sortFn_basic.md new file mode 100644 index 0000000000..33d938da75 --- /dev/null +++ b/docs/reference/index/functions/sortFn_basic.md @@ -0,0 +1,47 @@ +--- +id: sortFn_basic +title: sortFn_basic +--- + +# Function: sortFn\_basic() + +```ts +function sortFn_basic( + rowA, + rowB, + columnId): -1 | 0 | 1; +``` + +Defined in: [fns/sortFns.ts:120](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/sortFns.ts#L120) + +Sorts rows with the built-in basic strategy. + +This comparator returns ascending-order results; descending order is applied by the sorting row model. + +## Type Parameters + +### TFeatures + +`TFeatures` *extends* [`TableFeatures`](../interfaces/TableFeatures.md) + +### TData + +`TData` *extends* [`RowData`](../type-aliases/RowData.md) + +## Parameters + +### rowA + +[`Row`](../type-aliases/Row.md)\<`TFeatures`, `TData`\> + +### rowB + +[`Row`](../type-aliases/Row.md)\<`TFeatures`, `TData`\> + +### columnId + +`string` + +## Returns + +`-1` \| `0` \| `1` diff --git a/docs/reference/index/functions/sortFn_datetime.md b/docs/reference/index/functions/sortFn_datetime.md new file mode 100644 index 0000000000..b0a4cf9e62 --- /dev/null +++ b/docs/reference/index/functions/sortFn_datetime.md @@ -0,0 +1,47 @@ +--- +id: sortFn_datetime +title: sortFn_datetime +--- + +# Function: sortFn\_datetime() + +```ts +function sortFn_datetime( + rowA, + rowB, + columnId): -1 | 0 | 1; +``` + +Defined in: [fns/sortFns.ts:98](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/sortFns.ts#L98) + +Sorts rows with the built-in datetime strategy. + +This comparator returns ascending-order results; descending order is applied by the sorting row model. + +## Type Parameters + +### TFeatures + +`TFeatures` *extends* [`TableFeatures`](../interfaces/TableFeatures.md) + +### TData + +`TData` *extends* [`RowData`](../type-aliases/RowData.md) + +## Parameters + +### rowA + +[`Row`](../type-aliases/Row.md)\<`TFeatures`, `TData`\> + +### rowB + +[`Row`](../type-aliases/Row.md)\<`TFeatures`, `TData`\> + +### columnId + +`string` + +## Returns + +`-1` \| `0` \| `1` diff --git a/docs/reference/index/functions/sortFn_text.md b/docs/reference/index/functions/sortFn_text.md new file mode 100644 index 0000000000..be1b0e0b7d --- /dev/null +++ b/docs/reference/index/functions/sortFn_text.md @@ -0,0 +1,47 @@ +--- +id: sortFn_text +title: sortFn_text +--- + +# Function: sortFn\_text() + +```ts +function sortFn_text( + rowA, + rowB, + columnId): -1 | 0 | 1; +``` + +Defined in: [fns/sortFns.ts:58](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/sortFns.ts#L58) + +Sorts rows with the built-in text strategy. + +This comparator returns ascending-order results; descending order is applied by the sorting row model. + +## Type Parameters + +### TFeatures + +`TFeatures` *extends* [`TableFeatures`](../interfaces/TableFeatures.md) + +### TData + +`TData` *extends* [`RowData`](../type-aliases/RowData.md) + +## Parameters + +### rowA + +[`Row`](../type-aliases/Row.md)\<`TFeatures`, `TData`\> + +### rowB + +[`Row`](../type-aliases/Row.md)\<`TFeatures`, `TData`\> + +### columnId + +`string` + +## Returns + +`-1` \| `0` \| `1` diff --git a/docs/reference/index/functions/sortFn_textCaseSensitive.md b/docs/reference/index/functions/sortFn_textCaseSensitive.md new file mode 100644 index 0000000000..99f962b079 --- /dev/null +++ b/docs/reference/index/functions/sortFn_textCaseSensitive.md @@ -0,0 +1,47 @@ +--- +id: sortFn_textCaseSensitive +title: sortFn_textCaseSensitive +--- + +# Function: sortFn\_textCaseSensitive() + +```ts +function sortFn_textCaseSensitive( + rowA, + rowB, + columnId): -1 | 0 | 1; +``` + +Defined in: [fns/sortFns.ts:79](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/sortFns.ts#L79) + +Sorts rows with the built-in text case sensitive strategy. + +This comparator returns ascending-order results; descending order is applied by the sorting row model. + +## Type Parameters + +### TFeatures + +`TFeatures` *extends* [`TableFeatures`](../interfaces/TableFeatures.md) + +### TData + +`TData` *extends* [`RowData`](../type-aliases/RowData.md) + +## Parameters + +### rowA + +[`Row`](../type-aliases/Row.md)\<`TFeatures`, `TData`\> + +### rowB + +[`Row`](../type-aliases/Row.md)\<`TFeatures`, `TData`\> + +### columnId + +`string` + +## Returns + +`-1` \| `0` \| `1` diff --git a/docs/reference/index/functions/tableOptions.md b/docs/reference/index/functions/tableOptions.md index 42adade17f..d634b5a898 100644 --- a/docs/reference/index/functions/tableOptions.md +++ b/docs/reference/index/functions/tableOptions.md @@ -13,7 +13,7 @@ overloads preserving table option inference at compile time. ## Call Signature ```ts -function tableOptions(options): Omit, "features" | "columns"> & object; +function tableOptions(options): Omit, "columns" | "features"> & object; ``` Defined in: [helpers/tableOptions.ts:11](https://github.com/TanStack/table/blob/main/packages/table-core/src/helpers/tableOptions.ts#L11) @@ -41,7 +41,7 @@ from a framework adapter or table factory. ### Returns -`Omit`\<[`TableOptions`](../type-aliases/TableOptions.md)\<`TFeatures`, `TData`\>, `"features"` \| `"columns"`\> & `object` +`Omit`\<[`TableOptions`](../type-aliases/TableOptions.md)\<`TFeatures`, `TData`\>, `"columns"` \| `"features"`\> & `object` ## Call Signature @@ -76,7 +76,7 @@ Preserves table option inference when reusable options omit `data`. ## Call Signature ```ts -function tableOptions(options): Omit, "features" | "data" | "columns"> & object; +function tableOptions(options): Omit, "columns" | "features" | "data"> & object; ``` Defined in: [helpers/tableOptions.ts:40](https://github.com/TanStack/table/blob/main/packages/table-core/src/helpers/tableOptions.ts#L40) @@ -98,11 +98,11 @@ Preserves table option inference when reusable options omit both `data` and #### options -`Omit`\<[`TableOptions`](../type-aliases/TableOptions.md)\<`TFeatures`, `TData`\>, `"data"` \| `"columns"`\> & `object` +`Omit`\<[`TableOptions`](../type-aliases/TableOptions.md)\<`TFeatures`, `TData`\>, `"columns"` \| `"data"`\> & `object` ### Returns -`Omit`\<[`TableOptions`](../type-aliases/TableOptions.md)\<`TFeatures`, `TData`\>, `"features"` \| `"data"` \| `"columns"`\> & `object` +`Omit`\<[`TableOptions`](../type-aliases/TableOptions.md)\<`TFeatures`, `TData`\>, `"columns"` \| `"features"` \| `"data"`\> & `object` ## Call Signature diff --git a/docs/reference/index/index.md b/docs/reference/index/index.md index 1650494f9b..31dd15863c 100644 --- a/docs/reference/index/index.md +++ b/docs/reference/index/index.md @@ -5,23 +5,6 @@ title: index # index -## Namespaces - -- [filterFn\_arrIncludes](namespaces/filterFn_arrIncludes/index.md) -- [filterFn\_arrIncludesAll](namespaces/filterFn_arrIncludesAll/index.md) -- [filterFn\_arrIncludesSome](namespaces/filterFn_arrIncludesSome/index.md) -- [filterFn\_equals](namespaces/filterFn_equals/index.md) -- [filterFn\_equalsString](namespaces/filterFn_equalsString/index.md) -- [filterFn\_equalsStringSensitive](namespaces/filterFn_equalsStringSensitive/index.md) -- [filterFn\_greaterThan](namespaces/filterFn_greaterThan/index.md) -- [filterFn\_greaterThanOrEqualTo](namespaces/filterFn_greaterThanOrEqualTo/index.md) -- [filterFn\_includesString](namespaces/filterFn_includesString/index.md) -- [filterFn\_includesStringSensitive](namespaces/filterFn_includesStringSensitive/index.md) -- [filterFn\_inNumberRange](namespaces/filterFn_inNumberRange/index.md) -- [filterFn\_lessThan](namespaces/filterFn_lessThan/index.md) -- [filterFn\_lessThanOrEqualTo](namespaces/filterFn_lessThanOrEqualTo/index.md) -- [filterFn\_weakEquals](namespaces/filterFn_weakEquals/index.md) - ## Interfaces - [AggregationFns](interfaces/AggregationFns.md) @@ -32,14 +15,13 @@ title: index - [CachedRowModel\_Filtered](interfaces/CachedRowModel_Filtered.md) - [CachedRowModel\_Grouped](interfaces/CachedRowModel_Grouped.md) - [CachedRowModel\_Paginated](interfaces/CachedRowModel_Paginated.md) -- [CachedRowModel\_Plugins](interfaces/CachedRowModel_Plugins.md) - [CachedRowModel\_Sorted](interfaces/CachedRowModel_Sorted.md) -- [CachedRowModels\_Plugins](interfaces/CachedRowModels_Plugins.md) +- [CachedRowModels\_FeatureMap](interfaces/CachedRowModels_FeatureMap.md) - [Cell\_Cell](interfaces/Cell_Cell.md) - [Cell\_ColumnGrouping](interfaces/Cell_ColumnGrouping.md) - [Cell\_Core](interfaces/Cell_Core.md) - [Cell\_CoreProperties](interfaces/Cell_CoreProperties.md) -- [Cell\_Plugins](interfaces/Cell_Plugins.md) +- [Cell\_FeatureMap](interfaces/Cell_FeatureMap.md) - [CellContext](interfaces/CellContext.md) - [Column\_Column](interfaces/Column_Column.md) - [Column\_ColumnFaceting](interfaces/Column_ColumnFaceting.md) @@ -52,8 +34,8 @@ title: index - [Column\_ColumnVisibility](interfaces/Column_ColumnVisibility.md) - [Column\_Core](interfaces/Column_Core.md) - [Column\_CoreProperties](interfaces/Column_CoreProperties.md) +- [Column\_FeatureMap](interfaces/Column_FeatureMap.md) - [Column\_GlobalFiltering](interfaces/Column_GlobalFiltering.md) -- [Column\_Plugins](interfaces/Column_Plugins.md) - [Column\_RowSorting](interfaces/Column_RowSorting.md) - [ColumnDef\_ColumnFiltering](interfaces/ColumnDef_ColumnFiltering.md) - [ColumnDef\_ColumnGrouping](interfaces/ColumnDef_ColumnGrouping.md) @@ -61,56 +43,38 @@ title: index - [ColumnDef\_ColumnResizing](interfaces/ColumnDef_ColumnResizing.md) - [ColumnDef\_ColumnSizing](interfaces/ColumnDef_ColumnSizing.md) - [ColumnDef\_ColumnVisibility](interfaces/ColumnDef_ColumnVisibility.md) +- [ColumnDef\_FeatureMap](interfaces/ColumnDef_FeatureMap.md) - [ColumnDef\_GlobalFiltering](interfaces/ColumnDef_GlobalFiltering.md) -- [ColumnDef\_Plugins](interfaces/ColumnDef_Plugins.md) - [ColumnDef\_RowSorting](interfaces/ColumnDef_RowSorting.md) - [ColumnDefaultOptions](interfaces/ColumnDefaultOptions.md) -- [ColumnFacetingFeatureConstructors](interfaces/ColumnFacetingFeatureConstructors.md) - [ColumnFilter](interfaces/ColumnFilter.md) -- [ColumnFilteringFeatureConstructors](interfaces/ColumnFilteringFeatureConstructors.md) -- [ColumnGroupingFeatureConstructors](interfaces/ColumnGroupingFeatureConstructors.md) - [ColumnMeta](interfaces/ColumnMeta.md) - [ColumnOrderDefaultOptions](interfaces/ColumnOrderDefaultOptions.md) -- [ColumnOrderingFeatureConstructors](interfaces/ColumnOrderingFeatureConstructors.md) - [ColumnPinningDefaultOptions](interfaces/ColumnPinningDefaultOptions.md) -- [ColumnPinningFeatureConstructors](interfaces/ColumnPinningFeatureConstructors.md) - [ColumnPinningState](interfaces/ColumnPinningState.md) -- [ColumnResizingFeatureConstructors](interfaces/ColumnResizingFeatureConstructors.md) - [columnResizingState](interfaces/columnResizingState.md) -- [ColumnSizingFeatureConstructors](interfaces/ColumnSizingFeatureConstructors.md) - [ColumnSort](interfaces/ColumnSort.md) -- [ColumnVisibilityFeatureConstructors](interfaces/ColumnVisibilityFeatureConstructors.md) -- [CoreCellsFeatureConstructors](interfaces/CoreCellsFeatureConstructors.md) -- [CoreColumnsFeatureConstructors](interfaces/CoreColumnsFeatureConstructors.md) - [CoreFeatures](interfaces/CoreFeatures.md) -- [CoreHeadersFeatureConstructors](interfaces/CoreHeadersFeatureConstructors.md) -- [CoreRowModelsFeatureConstructors](interfaces/CoreRowModelsFeatureConstructors.md) -- [CoreRowsFeatureConstructors](interfaces/CoreRowsFeatureConstructors.md) -- [CoreTablesFeatureConstructors](interfaces/CoreTablesFeatureConstructors.md) - [CreateRowModel\_Core](interfaces/CreateRowModel_Core.md) - [CreateRowModel\_Expanded](interfaces/CreateRowModel_Expanded.md) - [CreateRowModel\_Faceted](interfaces/CreateRowModel_Faceted.md) - [CreateRowModel\_Filtered](interfaces/CreateRowModel_Filtered.md) - [CreateRowModel\_Grouped](interfaces/CreateRowModel_Grouped.md) - [CreateRowModel\_Paginated](interfaces/CreateRowModel_Paginated.md) -- [CreateRowModel\_Plugins](interfaces/CreateRowModel_Plugins.md) - [CreateRowModel\_Sorted](interfaces/CreateRowModel_Sorted.md) -- [CreateRowModels\_Plugins](interfaces/CreateRowModels_Plugins.md) -- [FeatureConstructors](interfaces/FeatureConstructors.md) +- [CreateRowModels\_FeatureMap](interfaces/CreateRowModels_FeatureMap.md) - [FilterFn](interfaces/FilterFn.md) - [FilterFns](interfaces/FilterFns.md) - [FilterMeta](interfaces/FilterMeta.md) -- [GlobalFilteringFeatureConstructors](interfaces/GlobalFilteringFeatureConstructors.md) - [Header\_ColumnResizing](interfaces/Header_ColumnResizing.md) - [Header\_ColumnSizing](interfaces/Header_ColumnSizing.md) - [Header\_Core](interfaces/Header_Core.md) - [Header\_CoreProperties](interfaces/Header_CoreProperties.md) +- [Header\_FeatureMap](interfaces/Header_FeatureMap.md) - [Header\_Header](interfaces/Header_Header.md) -- [Header\_Plugins](interfaces/Header_Plugins.md) - [HeaderContext](interfaces/HeaderContext.md) - [HeaderGroup\_Core](interfaces/HeaderGroup_Core.md) - [HeaderGroup\_Header](interfaces/HeaderGroup_Header.md) -- [HeaderGroup\_Plugins](interfaces/HeaderGroup_Plugins.md) - [IdIdentifier](interfaces/IdIdentifier.md) - [PaginationDefaultOptions](interfaces/PaginationDefaultOptions.md) - [PaginationState](interfaces/PaginationState.md) @@ -123,24 +87,19 @@ title: index - [Row\_ColumnVisibility](interfaces/Row_ColumnVisibility.md) - [Row\_Core](interfaces/Row_Core.md) - [Row\_CoreProperties](interfaces/Row_CoreProperties.md) -- [Row\_Plugins](interfaces/Row_Plugins.md) +- [Row\_FeatureMap](interfaces/Row_FeatureMap.md) - [Row\_Row](interfaces/Row_Row.md) - [Row\_RowExpanding](interfaces/Row_RowExpanding.md) - [Row\_RowPinning](interfaces/Row_RowPinning.md) - [Row\_RowSelection](interfaces/Row_RowSelection.md) -- [RowExpandingFeatureConstructors](interfaces/RowExpandingFeatureConstructors.md) - [RowModel](interfaces/RowModel.md) - [RowModelFns\_ColumnFiltering](interfaces/RowModelFns_ColumnFiltering.md) - [RowModelFns\_ColumnGrouping](interfaces/RowModelFns_ColumnGrouping.md) - [RowModelFns\_Core](interfaces/RowModelFns_Core.md) -- [RowModelFns\_Plugins](interfaces/RowModelFns_Plugins.md) +- [RowModelFns\_FeatureMap](interfaces/RowModelFns_FeatureMap.md) - [RowModelFns\_RowSorting](interfaces/RowModelFns_RowSorting.md) -- [RowPaginationFeatureConstructors](interfaces/RowPaginationFeatureConstructors.md) - [RowPinningDefaultOptions](interfaces/RowPinningDefaultOptions.md) -- [RowPinningFeatureConstructors](interfaces/RowPinningFeatureConstructors.md) - [RowPinningState](interfaces/RowPinningState.md) -- [RowSelectionFeatureConstructors](interfaces/RowSelectionFeatureConstructors.md) -- [RowSortingFeatureConstructors](interfaces/RowSortingFeatureConstructors.md) - [SortFn](interfaces/SortFn.md) - [SortFns](interfaces/SortFns.md) - [StockFeatures](interfaces/StockFeatures.md) @@ -155,9 +114,9 @@ title: index - [Table\_ColumnSizing](interfaces/Table_ColumnSizing.md) - [Table\_ColumnVisibility](interfaces/Table_ColumnVisibility.md) - [Table\_CoreProperties](interfaces/Table_CoreProperties.md) +- [Table\_FeatureMap](interfaces/Table_FeatureMap.md) - [Table\_GlobalFiltering](interfaces/Table_GlobalFiltering.md) - [Table\_Headers](interfaces/Table_Headers.md) -- [Table\_Plugins](interfaces/Table_Plugins.md) - [Table\_RowExpanding](interfaces/Table_RowExpanding.md) - [Table\_RowModels\_Core](interfaces/Table_RowModels_Core.md) - [Table\_RowModels\_Expanded](interfaces/Table_RowModels_Expanded.md) @@ -185,8 +144,8 @@ title: index - [TableOptions\_ColumnSizing](interfaces/TableOptions_ColumnSizing.md) - [TableOptions\_ColumnVisibility](interfaces/TableOptions_ColumnVisibility.md) - [TableOptions\_Core](interfaces/TableOptions_Core.md) +- [TableOptions\_FeatureMap](interfaces/TableOptions_FeatureMap.md) - [TableOptions\_GlobalFiltering](interfaces/TableOptions_GlobalFiltering.md) -- [TableOptions\_Plugins](interfaces/TableOptions_Plugins.md) - [TableOptions\_RowExpanding](interfaces/TableOptions_RowExpanding.md) - [TableOptions\_RowPagination](interfaces/TableOptions_RowPagination.md) - [TableOptions\_RowPinning](interfaces/TableOptions_RowPinning.md) @@ -201,8 +160,8 @@ title: index - [TableState\_ColumnResizing](interfaces/TableState_ColumnResizing.md) - [TableState\_ColumnSizing](interfaces/TableState_ColumnSizing.md) - [TableState\_ColumnVisibility](interfaces/TableState_ColumnVisibility.md) +- [TableState\_FeatureMap](interfaces/TableState_FeatureMap.md) - [TableState\_GlobalFiltering](interfaces/TableState_GlobalFiltering.md) -- [TableState\_Plugins](interfaces/TableState_Plugins.md) - [TableState\_RowExpanding](interfaces/TableState_RowExpanding.md) - [TableState\_RowPagination](interfaces/TableState_RowPagination.md) - [TableState\_RowPinning](interfaces/TableState_RowPinning.md) @@ -220,10 +179,6 @@ title: index - [AggregationFn](type-aliases/AggregationFn.md) - [AggregationFnOption](type-aliases/AggregationFnOption.md) - [APIObject](type-aliases/APIObject.md) -- [AssignCellPrototype](type-aliases/AssignCellPrototype.md) -- [AssignColumnPrototype](type-aliases/AssignColumnPrototype.md) -- [AssignHeaderPrototype](type-aliases/AssignHeaderPrototype.md) -- [AssignRowPrototype](type-aliases/AssignRowPrototype.md) - [Atoms](type-aliases/Atoms.md) - [Atoms\_All](type-aliases/Atoms_All.md) - [BaseAtoms](type-aliases/BaseAtoms.md) @@ -253,7 +208,6 @@ title: index - [ColumnSizingDefaultOptions](type-aliases/ColumnSizingDefaultOptions.md) - [ColumnSizingState](type-aliases/ColumnSizingState.md) - [ColumnVisibilityState](type-aliases/ColumnVisibilityState.md) -- [ConstructTableAPIs](type-aliases/ConstructTableAPIs.md) - [CreateRowModels](type-aliases/CreateRowModels.md) - [CreateRowModels\_All](type-aliases/CreateRowModels_All.md) - [CustomAggregationFns](type-aliases/CustomAggregationFns.md) @@ -267,12 +221,8 @@ title: index - [ExpandedStateList](type-aliases/ExpandedStateList.md) - [ExternalAtoms](type-aliases/ExternalAtoms.md) - [ExternalAtoms\_All](type-aliases/ExternalAtoms_All.md) -- [ExtractFeatureTypes](type-aliases/ExtractFeatureTypes.md) +- [ExtractFeatureMapTypes](type-aliases/ExtractFeatureMapTypes.md) - [FilterFnOption](type-aliases/FilterFnOption.md) -- [GetDefaultColumnDef](type-aliases/GetDefaultColumnDef.md) -- [GetDefaultStateSelector](type-aliases/GetDefaultStateSelector.md) -- [GetDefaultTableOptions](type-aliases/GetDefaultTableOptions.md) -- [GetInitialState](type-aliases/GetInitialState.md) - [Getter](type-aliases/Getter.md) - [GroupColumnDef](type-aliases/GroupColumnDef.md) - [GroupingColumnMode](type-aliases/GroupingColumnMode.md) @@ -280,7 +230,6 @@ title: index - [Header](type-aliases/Header.md) - [HeaderGroup](type-aliases/HeaderGroup.md) - [IdentifiedColumnDef](type-aliases/IdentifiedColumnDef.md) -- [InitRowInstanceData](type-aliases/InitRowInstanceData.md) - [NoInfer](type-aliases/NoInfer.md) - [OnChangeFn](type-aliases/OnChangeFn.md) - [PartialKeys](type-aliases/PartialKeys.md) @@ -303,6 +252,7 @@ title: index - [Table\_RowModels](type-aliases/Table_RowModels.md) - [TableOptions](type-aliases/TableOptions.md) - [TableOptions\_All](type-aliases/TableOptions_All.md) +- [TableOptions\_FeatureMap\_All](type-aliases/TableOptions_FeatureMap_All.md) - [TableState](type-aliases/TableState.md) - [TableState\_All](type-aliases/TableState_All.md) - [TransformFilterValueFn](type-aliases/TransformFilterValueFn.md) @@ -312,15 +262,6 @@ title: index ## Variables -- [aggregationFn\_count](variables/aggregationFn_count.md) -- [aggregationFn\_extent](variables/aggregationFn_extent.md) -- [aggregationFn\_max](variables/aggregationFn_max.md) -- [aggregationFn\_mean](variables/aggregationFn_mean.md) -- [aggregationFn\_median](variables/aggregationFn_median.md) -- [aggregationFn\_min](variables/aggregationFn_min.md) -- [aggregationFn\_sum](variables/aggregationFn_sum.md) -- [aggregationFn\_unique](variables/aggregationFn_unique.md) -- [aggregationFn\_uniqueCount](variables/aggregationFn_uniqueCount.md) - [aggregationFns](variables/aggregationFns.md) - [columnFacetingFeature](variables/columnFacetingFeature.md) - [columnFilteringFeature](variables/columnFilteringFeature.md) @@ -337,7 +278,6 @@ title: index - [coreRowModelsFeature](variables/coreRowModelsFeature.md) - [coreRowsFeature](variables/coreRowsFeature.md) - [coreTablesFeature](variables/coreTablesFeature.md) -- [filterFn\_arrHas](variables/filterFn_arrHas.md) - [filterFn\_arrIncludes](variables/filterFn_arrIncludes.md) - [filterFn\_arrIncludesAll](variables/filterFn_arrIncludesAll.md) - [filterFn\_arrIncludesSome](variables/filterFn_arrIncludesSome.md) @@ -360,17 +300,20 @@ title: index - [rowPinningFeature](variables/rowPinningFeature.md) - [rowSelectionFeature](variables/rowSelectionFeature.md) - [rowSortingFeature](variables/rowSortingFeature.md) -- [sortFn\_alphanumeric](variables/sortFn_alphanumeric.md) -- [sortFn\_alphanumericCaseSensitive](variables/sortFn_alphanumericCaseSensitive.md) -- [sortFn\_basic](variables/sortFn_basic.md) -- [sortFn\_datetime](variables/sortFn_datetime.md) -- [sortFn\_text](variables/sortFn_text.md) -- [sortFn\_textCaseSensitive](variables/sortFn_textCaseSensitive.md) - [sortFns](variables/sortFns.md) - [stockFeatures](variables/stockFeatures.md) ## Functions +- [aggregationFn\_count](functions/aggregationFn_count.md) +- [aggregationFn\_extent](functions/aggregationFn_extent.md) +- [aggregationFn\_max](functions/aggregationFn_max.md) +- [aggregationFn\_mean](functions/aggregationFn_mean.md) +- [aggregationFn\_median](functions/aggregationFn_median.md) +- [aggregationFn\_min](functions/aggregationFn_min.md) +- [aggregationFn\_sum](functions/aggregationFn_sum.md) +- [aggregationFn\_unique](functions/aggregationFn_unique.md) +- [aggregationFn\_uniqueCount](functions/aggregationFn_uniqueCount.md) - [assignPrototypeAPIs](functions/assignPrototypeAPIs.md) - [assignTableAPIs](functions/assignTableAPIs.md) - [buildHeaderGroups](functions/buildHeaderGroups.md) @@ -378,28 +321,8 @@ title: index - [cloneState](functions/cloneState.md) - [constructCell](functions/constructCell.md) - [constructColumn](functions/constructColumn.md) -- [constructColumnFacetingFeature](functions/constructColumnFacetingFeature.md) -- [constructColumnFilteringFeature](functions/constructColumnFilteringFeature.md) -- [constructColumnGroupingFeature](functions/constructColumnGroupingFeature.md) -- [constructColumnOrderingFeature](functions/constructColumnOrderingFeature.md) -- [constructColumnPinningFeature](functions/constructColumnPinningFeature.md) -- [constructColumnResizingFeature](functions/constructColumnResizingFeature.md) -- [constructColumnSizingFeature](functions/constructColumnSizingFeature.md) -- [constructColumnVisibilityFeature](functions/constructColumnVisibilityFeature.md) -- [constructCoreCellsFeature](functions/constructCoreCellsFeature.md) -- [constructCoreColumnsFeature](functions/constructCoreColumnsFeature.md) -- [constructCoreHeadersFeature](functions/constructCoreHeadersFeature.md) -- [constructCoreRowModelsFeature](functions/constructCoreRowModelsFeature.md) -- [constructCoreRowsFeature](functions/constructCoreRowsFeature.md) -- [constructCoreTablesFeature](functions/constructCoreTablesFeature.md) -- [constructGlobalFilteringFeature](functions/constructGlobalFilteringFeature.md) - [constructHeader](functions/constructHeader.md) - [constructRow](functions/constructRow.md) -- [constructRowExpandingFeature](functions/constructRowExpandingFeature.md) -- [constructRowPaginationFeature](functions/constructRowPaginationFeature.md) -- [constructRowPinningFeature](functions/constructRowPinningFeature.md) -- [constructRowSelectionFeature](functions/constructRowSelectionFeature.md) -- [constructRowSortingFeature](functions/constructRowSortingFeature.md) - [constructTable](functions/constructTable.md) - [createColumnHelper](functions/createColumnHelper.md) - [createCoreRowModel](functions/createCoreRowModel.md) @@ -412,6 +335,7 @@ title: index - [createPaginatedRowModel](functions/createPaginatedRowModel.md) - [createSortedRowModel](functions/createSortedRowModel.md) - [expandRows](functions/expandRows.md) +- [filterFn\_arrHas](functions/filterFn_arrHas.md) - [flattenBy](functions/flattenBy.md) - [functionalUpdate](functions/functionalUpdate.md) - [getFunctionNameInfo](functions/getFunctionNameInfo.md) @@ -419,6 +343,12 @@ title: index - [isFunction](functions/isFunction.md) - [makeStateUpdater](functions/makeStateUpdater.md) - [memo](functions/memo.md) +- [sortFn\_alphanumeric](functions/sortFn_alphanumeric.md) +- [sortFn\_alphanumericCaseSensitive](functions/sortFn_alphanumericCaseSensitive.md) +- [sortFn\_basic](functions/sortFn_basic.md) +- [sortFn\_datetime](functions/sortFn_datetime.md) +- [sortFn\_text](functions/sortFn_text.md) +- [sortFn\_textCaseSensitive](functions/sortFn_textCaseSensitive.md) - [tableFeatures](functions/tableFeatures.md) - [tableMemo](functions/tableMemo.md) - [tableOptions](functions/tableOptions.md) diff --git a/docs/reference/index/interfaces/CachedRowModel_Core.md b/docs/reference/index/interfaces/CachedRowModel_Core.md index 3cf72ad556..a1dae6ca2d 100644 --- a/docs/reference/index/interfaces/CachedRowModel_Core.md +++ b/docs/reference/index/interfaces/CachedRowModel_Core.md @@ -5,11 +5,7 @@ title: CachedRowModel_Core # Interface: CachedRowModel\_Core\ -Defined in: [core/row-models/coreRowModelsFeature.types.ts:38](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/row-models/coreRowModelsFeature.types.ts#L38) - -## Extends - -- [`CachedRowModel_Plugins`](CachedRowModel_Plugins.md) +Defined in: [core/row-models/coreRowModelsFeature.types.ts:34](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/row-models/coreRowModelsFeature.types.ts#L34) ## Type Parameters @@ -29,7 +25,7 @@ Defined in: [core/row-models/coreRowModelsFeature.types.ts:38](https://github.co coreRowModel: () => RowModel; ``` -Defined in: [core/row-models/coreRowModelsFeature.types.ts:42](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/row-models/coreRowModelsFeature.types.ts#L42) +Defined in: [core/row-models/coreRowModelsFeature.types.ts:38](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/row-models/coreRowModelsFeature.types.ts#L38) #### Returns diff --git a/docs/reference/index/interfaces/CachedRowModel_Plugins.md b/docs/reference/index/interfaces/CachedRowModel_Plugins.md deleted file mode 100644 index 4a4bc510b6..0000000000 --- a/docs/reference/index/interfaces/CachedRowModel_Plugins.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -id: CachedRowModel_Plugins -title: CachedRowModel_Plugins ---- - -# Interface: CachedRowModel\_Plugins - -Defined in: [core/row-models/coreRowModelsFeature.types.ts:36](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/row-models/coreRowModelsFeature.types.ts#L36) - -## Extended by - -- [`CachedRowModel_Core`](CachedRowModel_Core.md) diff --git a/docs/reference/index/interfaces/CachedRowModels_FeatureMap.md b/docs/reference/index/interfaces/CachedRowModels_FeatureMap.md new file mode 100644 index 0000000000..28c3988e79 --- /dev/null +++ b/docs/reference/index/interfaces/CachedRowModels_FeatureMap.md @@ -0,0 +1,78 @@ +--- +id: CachedRowModels_FeatureMap +title: CachedRowModels_FeatureMap +--- + +# Interface: CachedRowModels\_FeatureMap\ + +Defined in: [types/RowModel.ts:65](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/RowModel.ts#L65) + +## Type Parameters + +### TFeatures + +`TFeatures` *extends* [`TableFeatures`](TableFeatures.md) + +### TData + +`TData` *extends* [`RowData`](../type-aliases/RowData.md) + +## Properties + +### columnFacetingFeature + +```ts +columnFacetingFeature: CachedRowModel_Faceted; +``` + +Defined in: [types/RowModel.ts:69](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/RowModel.ts#L69) + +*** + +### columnFilteringFeature + +```ts +columnFilteringFeature: CachedRowModel_Filtered; +``` + +Defined in: [types/RowModel.ts:70](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/RowModel.ts#L70) + +*** + +### columnGroupingFeature + +```ts +columnGroupingFeature: CachedRowModel_Grouped; +``` + +Defined in: [types/RowModel.ts:72](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/RowModel.ts#L72) + +*** + +### rowExpandingFeature + +```ts +rowExpandingFeature: CachedRowModel_Expanded; +``` + +Defined in: [types/RowModel.ts:71](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/RowModel.ts#L71) + +*** + +### rowPaginationFeature + +```ts +rowPaginationFeature: CachedRowModel_Paginated; +``` + +Defined in: [types/RowModel.ts:73](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/RowModel.ts#L73) + +*** + +### rowSortingFeature + +```ts +rowSortingFeature: CachedRowModel_Sorted; +``` + +Defined in: [types/RowModel.ts:74](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/RowModel.ts#L74) diff --git a/docs/reference/index/interfaces/CachedRowModels_Plugins.md b/docs/reference/index/interfaces/CachedRowModels_Plugins.md deleted file mode 100644 index 178e9a9cfc..0000000000 --- a/docs/reference/index/interfaces/CachedRowModels_Plugins.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -id: CachedRowModels_Plugins -title: CachedRowModels_Plugins ---- - -# Interface: CachedRowModels\_Plugins\ - -Defined in: [types/RowModel.ts:87](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/RowModel.ts#L87) - -## Type Parameters - -### TFeatures - -`TFeatures` *extends* [`TableFeatures`](TableFeatures.md) - -### TData - -`TData` *extends* [`RowData`](../type-aliases/RowData.md) diff --git a/docs/reference/index/interfaces/Cell_Core.md b/docs/reference/index/interfaces/Cell_Core.md index fa1c036d2e..4ba49aab95 100644 --- a/docs/reference/index/interfaces/Cell_Core.md +++ b/docs/reference/index/interfaces/Cell_Core.md @@ -5,7 +5,7 @@ title: Cell_Core # Interface: Cell\_Core\ -Defined in: [types/Cell.ts:16](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/Cell.ts#L16) +Defined in: [types/Cell.ts:6](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/Cell.ts#L6) ## Extends diff --git a/docs/reference/index/interfaces/Cell_FeatureMap.md b/docs/reference/index/interfaces/Cell_FeatureMap.md new file mode 100644 index 0000000000..2d92ac0aa9 --- /dev/null +++ b/docs/reference/index/interfaces/Cell_FeatureMap.md @@ -0,0 +1,18 @@ +--- +id: Cell_FeatureMap +title: Cell_FeatureMap +--- + +# Interface: Cell\_FeatureMap + +Defined in: [types/Cell.ts:12](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/Cell.ts#L12) + +## Properties + +### columnGroupingFeature + +```ts +columnGroupingFeature: Cell_ColumnGrouping; +``` + +Defined in: [types/Cell.ts:13](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/Cell.ts#L13) diff --git a/docs/reference/index/interfaces/Cell_Plugins.md b/docs/reference/index/interfaces/Cell_Plugins.md deleted file mode 100644 index a751054438..0000000000 --- a/docs/reference/index/interfaces/Cell_Plugins.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -id: Cell_Plugins -title: Cell_Plugins ---- - -# Interface: Cell\_Plugins\ - -Defined in: [types/Cell.ts:10](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/Cell.ts#L10) - -Use this interface as a target for declaration merging to add your own plugin properties. -Note: This will affect the types of all tables in your project. - -## Type Parameters - -### TFeatures - -`TFeatures` *extends* [`TableFeatures`](TableFeatures.md) - -### TData - -`TData` *extends* [`RowData`](../type-aliases/RowData.md) - -### TValue - -`TValue` *extends* [`CellData`](../type-aliases/CellData.md) = [`CellData`](../type-aliases/CellData.md) diff --git a/docs/reference/index/interfaces/ColumnDef_FeatureMap.md b/docs/reference/index/interfaces/ColumnDef_FeatureMap.md new file mode 100644 index 0000000000..6fc32f363a --- /dev/null +++ b/docs/reference/index/interfaces/ColumnDef_FeatureMap.md @@ -0,0 +1,102 @@ +--- +id: ColumnDef_FeatureMap +title: ColumnDef_FeatureMap +--- + +# Interface: ColumnDef\_FeatureMap\ + +Defined in: [types/ColumnDef.ts:103](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/ColumnDef.ts#L103) + +## Type Parameters + +### TFeatures + +`TFeatures` *extends* [`TableFeatures`](TableFeatures.md) + +### TData + +`TData` *extends* [`RowData`](../type-aliases/RowData.md) + +### TValue + +`TValue` *extends* [`CellData`](../type-aliases/CellData.md) + +## Properties + +### columnFilteringFeature + +```ts +columnFilteringFeature: ColumnDef_ColumnFiltering; +``` + +Defined in: [types/ColumnDef.ts:110](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/ColumnDef.ts#L110) + +*** + +### columnGroupingFeature + +```ts +columnGroupingFeature: ColumnDef_ColumnGrouping; +``` + +Defined in: [types/ColumnDef.ts:113](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/ColumnDef.ts#L113) + +*** + +### columnPinningFeature + +```ts +columnPinningFeature: ColumnDef_ColumnPinning; +``` + +Defined in: [types/ColumnDef.ts:109](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/ColumnDef.ts#L109) + +*** + +### columnResizingFeature + +```ts +columnResizingFeature: ColumnDef_ColumnResizing; +``` + +Defined in: [types/ColumnDef.ts:115](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/ColumnDef.ts#L115) + +*** + +### columnSizingFeature + +```ts +columnSizingFeature: ColumnDef_ColumnSizing; +``` + +Defined in: [types/ColumnDef.ts:114](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/ColumnDef.ts#L114) + +*** + +### columnVisibilityFeature + +```ts +columnVisibilityFeature: ColumnDef_ColumnVisibility; +``` + +Defined in: [types/ColumnDef.ts:108](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/ColumnDef.ts#L108) + +*** + +### globalFilteringFeature + +```ts +globalFilteringFeature: ColumnDef_GlobalFiltering; +``` + +Defined in: [types/ColumnDef.ts:111](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/ColumnDef.ts#L111) + +*** + +### rowSortingFeature + +```ts +rowSortingFeature: ColumnDef_RowSorting; +``` + +Defined in: [types/ColumnDef.ts:112](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/ColumnDef.ts#L112) diff --git a/docs/reference/index/interfaces/ColumnDef_Plugins.md b/docs/reference/index/interfaces/ColumnDef_Plugins.md deleted file mode 100644 index 0f739f438f..0000000000 --- a/docs/reference/index/interfaces/ColumnDef_Plugins.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -id: ColumnDef_Plugins -title: ColumnDef_Plugins ---- - -# Interface: ColumnDef\_Plugins\ - -Defined in: [types/ColumnDef.ts:18](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/ColumnDef.ts#L18) - -Use this interface as a target for declaration merging to add your own plugin properties. -Note: This will affect the types of all tables in your project. - -## Type Parameters - -### TFeatures - -`TFeatures` *extends* [`TableFeatures`](TableFeatures.md) - -### TData - -`TData` *extends* [`RowData`](../type-aliases/RowData.md) - -### TValue - -`TValue` *extends* [`CellData`](../type-aliases/CellData.md) = [`CellData`](../type-aliases/CellData.md) diff --git a/docs/reference/index/interfaces/ColumnFacetingFeatureConstructors.md b/docs/reference/index/interfaces/ColumnFacetingFeatureConstructors.md deleted file mode 100644 index 1acef999c6..0000000000 --- a/docs/reference/index/interfaces/ColumnFacetingFeatureConstructors.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -id: ColumnFacetingFeatureConstructors -title: ColumnFacetingFeatureConstructors ---- - -# Interface: ColumnFacetingFeatureConstructors\ - -Defined in: [features/column-faceting/columnFacetingFeature.ts:23](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-faceting/columnFacetingFeature.ts#L23) - -## Type Parameters - -### TFeatures - -`TFeatures` *extends* [`TableFeatures`](TableFeatures.md) - -### TData - -`TData` *extends* [`RowData`](../type-aliases/RowData.md) diff --git a/docs/reference/index/interfaces/ColumnFilteringFeatureConstructors.md b/docs/reference/index/interfaces/ColumnFilteringFeatureConstructors.md deleted file mode 100644 index 83e2b2ed46..0000000000 --- a/docs/reference/index/interfaces/ColumnFilteringFeatureConstructors.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -id: ColumnFilteringFeatureConstructors -title: ColumnFilteringFeatureConstructors ---- - -# Interface: ColumnFilteringFeatureConstructors\ - -Defined in: [features/column-filtering/columnFilteringFeature.ts:32](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-filtering/columnFilteringFeature.ts#L32) - -## Type Parameters - -### TFeatures - -`TFeatures` *extends* [`TableFeatures`](TableFeatures.md) - -### TData - -`TData` *extends* [`RowData`](../type-aliases/RowData.md) diff --git a/docs/reference/index/interfaces/ColumnGroupingFeatureConstructors.md b/docs/reference/index/interfaces/ColumnGroupingFeatureConstructors.md deleted file mode 100644 index 5a879a3f78..0000000000 --- a/docs/reference/index/interfaces/ColumnGroupingFeatureConstructors.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -id: ColumnGroupingFeatureConstructors -title: ColumnGroupingFeatureConstructors ---- - -# Interface: ColumnGroupingFeatureConstructors\ - -Defined in: [features/column-grouping/columnGroupingFeature.ts:38](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/columnGroupingFeature.ts#L38) - -## Type Parameters - -### TFeatures - -`TFeatures` *extends* [`TableFeatures`](TableFeatures.md) - -### TData - -`TData` *extends* [`RowData`](../type-aliases/RowData.md) diff --git a/docs/reference/index/interfaces/ColumnMeta.md b/docs/reference/index/interfaces/ColumnMeta.md index 9ecede6d4e..a285c7c657 100644 --- a/docs/reference/index/interfaces/ColumnMeta.md +++ b/docs/reference/index/interfaces/ColumnMeta.md @@ -5,7 +5,7 @@ title: ColumnMeta # Interface: ColumnMeta\ -Defined in: [types/ColumnDef.ts:24](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/ColumnDef.ts#L24) +Defined in: [types/ColumnDef.ts:14](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/ColumnDef.ts#L14) ## Type Parameters diff --git a/docs/reference/index/interfaces/ColumnOrderingFeatureConstructors.md b/docs/reference/index/interfaces/ColumnOrderingFeatureConstructors.md deleted file mode 100644 index 16b3c9006d..0000000000 --- a/docs/reference/index/interfaces/ColumnOrderingFeatureConstructors.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -id: ColumnOrderingFeatureConstructors -title: ColumnOrderingFeatureConstructors ---- - -# Interface: ColumnOrderingFeatureConstructors\ - -Defined in: [features/column-ordering/columnOrderingFeature.ts:24](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-ordering/columnOrderingFeature.ts#L24) - -## Type Parameters - -### TFeatures - -`TFeatures` *extends* [`TableFeatures`](TableFeatures.md) - -### TData - -`TData` *extends* [`RowData`](../type-aliases/RowData.md) diff --git a/docs/reference/index/interfaces/ColumnPinningFeatureConstructors.md b/docs/reference/index/interfaces/ColumnPinningFeatureConstructors.md deleted file mode 100644 index 2f33d027c9..0000000000 --- a/docs/reference/index/interfaces/ColumnPinningFeatureConstructors.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -id: ColumnPinningFeatureConstructors -title: ColumnPinningFeatureConstructors ---- - -# Interface: ColumnPinningFeatureConstructors\ - -Defined in: [features/column-pinning/columnPinningFeature.ts:52](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-pinning/columnPinningFeature.ts#L52) - -## Type Parameters - -### TFeatures - -`TFeatures` *extends* [`TableFeatures`](TableFeatures.md) - -### TData - -`TData` *extends* [`RowData`](../type-aliases/RowData.md) diff --git a/docs/reference/index/interfaces/ColumnResizingFeatureConstructors.md b/docs/reference/index/interfaces/ColumnResizingFeatureConstructors.md deleted file mode 100644 index 8818edd5f1..0000000000 --- a/docs/reference/index/interfaces/ColumnResizingFeatureConstructors.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -id: ColumnResizingFeatureConstructors -title: ColumnResizingFeatureConstructors ---- - -# Interface: ColumnResizingFeatureConstructors\ - -Defined in: [features/column-resizing/columnResizingFeature.ts:24](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-resizing/columnResizingFeature.ts#L24) - -## Type Parameters - -### TFeatures - -`TFeatures` *extends* [`TableFeatures`](TableFeatures.md) - -### TData - -`TData` *extends* [`RowData`](../type-aliases/RowData.md) diff --git a/docs/reference/index/interfaces/ColumnSizingFeatureConstructors.md b/docs/reference/index/interfaces/ColumnSizingFeatureConstructors.md deleted file mode 100644 index 18ea7a81db..0000000000 --- a/docs/reference/index/interfaces/ColumnSizingFeatureConstructors.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -id: ColumnSizingFeatureConstructors -title: ColumnSizingFeatureConstructors ---- - -# Interface: ColumnSizingFeatureConstructors\ - -Defined in: [features/column-sizing/columnSizingFeature.ts:33](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-sizing/columnSizingFeature.ts#L33) - -## Type Parameters - -### TFeatures - -`TFeatures` *extends* [`TableFeatures`](TableFeatures.md) - -### TData - -`TData` *extends* [`RowData`](../type-aliases/RowData.md) diff --git a/docs/reference/index/interfaces/ColumnVisibilityFeatureConstructors.md b/docs/reference/index/interfaces/ColumnVisibilityFeatureConstructors.md deleted file mode 100644 index c2ace874da..0000000000 --- a/docs/reference/index/interfaces/ColumnVisibilityFeatureConstructors.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -id: ColumnVisibilityFeatureConstructors -title: ColumnVisibilityFeatureConstructors ---- - -# Interface: ColumnVisibilityFeatureConstructors\ - -Defined in: [features/column-visibility/columnVisibilityFeature.ts:34](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/columnVisibilityFeature.ts#L34) - -## Type Parameters - -### TFeatures - -`TFeatures` *extends* [`TableFeatures`](TableFeatures.md) - -### TData - -`TData` *extends* [`RowData`](../type-aliases/RowData.md) diff --git a/docs/reference/index/interfaces/Column_Core.md b/docs/reference/index/interfaces/Column_Core.md index 56eb76c1ab..4091b658ba 100644 --- a/docs/reference/index/interfaces/Column_Core.md +++ b/docs/reference/index/interfaces/Column_Core.md @@ -5,7 +5,7 @@ title: Column_Core # Interface: Column\_Core\ -Defined in: [types/Column.ts:26](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/Column.ts#L26) +Defined in: [types/Column.ts:16](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/Column.ts#L16) ## Extends diff --git a/docs/reference/index/interfaces/Column_FeatureMap.md b/docs/reference/index/interfaces/Column_FeatureMap.md new file mode 100644 index 0000000000..6d73d17485 --- /dev/null +++ b/docs/reference/index/interfaces/Column_FeatureMap.md @@ -0,0 +1,118 @@ +--- +id: Column_FeatureMap +title: Column_FeatureMap +--- + +# Interface: Column\_FeatureMap\ + +Defined in: [types/Column.ts:22](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/Column.ts#L22) + +## Type Parameters + +### TFeatures + +`TFeatures` *extends* [`TableFeatures`](TableFeatures.md) + +### TData + +`TData` *extends* [`RowData`](../type-aliases/RowData.md) + +## Properties + +### columnFacetingFeature + +```ts +columnFacetingFeature: Column_ColumnFaceting; +``` + +Defined in: [types/Column.ts:26](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/Column.ts#L26) + +*** + +### columnFilteringFeature + +```ts +columnFilteringFeature: Column_ColumnFiltering; +``` + +Defined in: [types/Column.ts:27](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/Column.ts#L27) + +*** + +### columnGroupingFeature + +```ts +columnGroupingFeature: Column_ColumnGrouping; +``` + +Defined in: [types/Column.ts:28](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/Column.ts#L28) + +*** + +### columnOrderingFeature + +```ts +columnOrderingFeature: Column_ColumnOrdering; +``` + +Defined in: [types/Column.ts:29](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/Column.ts#L29) + +*** + +### columnPinningFeature + +```ts +columnPinningFeature: Column_ColumnPinning; +``` + +Defined in: [types/Column.ts:30](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/Column.ts#L30) + +*** + +### columnResizingFeature + +```ts +columnResizingFeature: Column_ColumnResizing; +``` + +Defined in: [types/Column.ts:31](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/Column.ts#L31) + +*** + +### columnSizingFeature + +```ts +columnSizingFeature: Column_ColumnSizing; +``` + +Defined in: [types/Column.ts:32](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/Column.ts#L32) + +*** + +### columnVisibilityFeature + +```ts +columnVisibilityFeature: Column_ColumnVisibility; +``` + +Defined in: [types/Column.ts:33](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/Column.ts#L33) + +*** + +### globalFilteringFeature + +```ts +globalFilteringFeature: Column_GlobalFiltering; +``` + +Defined in: [types/Column.ts:34](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/Column.ts#L34) + +*** + +### rowSortingFeature + +```ts +rowSortingFeature: Column_RowSorting; +``` + +Defined in: [types/Column.ts:35](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/Column.ts#L35) diff --git a/docs/reference/index/interfaces/Column_Plugins.md b/docs/reference/index/interfaces/Column_Plugins.md deleted file mode 100644 index 1034f8f551..0000000000 --- a/docs/reference/index/interfaces/Column_Plugins.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -id: Column_Plugins -title: Column_Plugins ---- - -# Interface: Column\_Plugins\ - -Defined in: [types/Column.ts:20](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/Column.ts#L20) - -Use this interface as a target for declaration merging to add your own plugin properties. -Note: This will affect the types of all tables in your project. - -## Type Parameters - -### TFeatures - -`TFeatures` *extends* [`TableFeatures`](TableFeatures.md) - -### TData - -`TData` *extends* [`RowData`](../type-aliases/RowData.md) - -### TValue - -`TValue` = `unknown` diff --git a/docs/reference/index/interfaces/CoreCellsFeatureConstructors.md b/docs/reference/index/interfaces/CoreCellsFeatureConstructors.md deleted file mode 100644 index 05ed3f6d91..0000000000 --- a/docs/reference/index/interfaces/CoreCellsFeatureConstructors.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -id: CoreCellsFeatureConstructors -title: CoreCellsFeatureConstructors ---- - -# Interface: CoreCellsFeatureConstructors\ - -Defined in: [core/cells/coreCellsFeature.ts:11](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/cells/coreCellsFeature.ts#L11) - -## Type Parameters - -### TFeatures - -`TFeatures` *extends* [`TableFeatures`](TableFeatures.md) - -### TData - -`TData` *extends* [`RowData`](../type-aliases/RowData.md) diff --git a/docs/reference/index/interfaces/CoreColumnsFeatureConstructors.md b/docs/reference/index/interfaces/CoreColumnsFeatureConstructors.md deleted file mode 100644 index c3886157c9..0000000000 --- a/docs/reference/index/interfaces/CoreColumnsFeatureConstructors.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -id: CoreColumnsFeatureConstructors -title: CoreColumnsFeatureConstructors ---- - -# Interface: CoreColumnsFeatureConstructors\ - -Defined in: [core/columns/coreColumnsFeature.ts:21](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/columns/coreColumnsFeature.ts#L21) - -## Type Parameters - -### TFeatures - -`TFeatures` *extends* [`TableFeatures`](TableFeatures.md) - -### TData - -`TData` *extends* [`RowData`](../type-aliases/RowData.md) diff --git a/docs/reference/index/interfaces/CoreFeatures.md b/docs/reference/index/interfaces/CoreFeatures.md index d3bde6f41f..6b99a945a1 100644 --- a/docs/reference/index/interfaces/CoreFeatures.md +++ b/docs/reference/index/interfaces/CoreFeatures.md @@ -12,7 +12,7 @@ Defined in: [core/coreFeatures.ts:9](https://github.com/TanStack/table/blob/main ### coreCellsFeature ```ts -coreCellsFeature: TableFeature>; +coreCellsFeature: TableFeature; ``` Defined in: [core/coreFeatures.ts:11](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/coreFeatures.ts#L11) @@ -22,7 +22,7 @@ Defined in: [core/coreFeatures.ts:11](https://github.com/TanStack/table/blob/mai ### coreColumnsFeature ```ts -coreColumnsFeature: TableFeature>; +coreColumnsFeature: TableFeature; ``` Defined in: [core/coreFeatures.ts:12](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/coreFeatures.ts#L12) @@ -32,7 +32,7 @@ Defined in: [core/coreFeatures.ts:12](https://github.com/TanStack/table/blob/mai ### coreHeadersFeature ```ts -coreHeadersFeature: TableFeature>; +coreHeadersFeature: TableFeature; ``` Defined in: [core/coreFeatures.ts:13](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/coreFeatures.ts#L13) @@ -52,7 +52,7 @@ Defined in: [core/coreFeatures.ts:10](https://github.com/TanStack/table/blob/mai ### coreRowModelsFeature ```ts -coreRowModelsFeature: TableFeature>; +coreRowModelsFeature: TableFeature; ``` Defined in: [core/coreFeatures.ts:14](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/coreFeatures.ts#L14) @@ -62,7 +62,7 @@ Defined in: [core/coreFeatures.ts:14](https://github.com/TanStack/table/blob/mai ### coreRowsFeature ```ts -coreRowsFeature: TableFeature>; +coreRowsFeature: TableFeature; ``` Defined in: [core/coreFeatures.ts:15](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/coreFeatures.ts#L15) @@ -72,7 +72,7 @@ Defined in: [core/coreFeatures.ts:15](https://github.com/TanStack/table/blob/mai ### coreTablesFeature ```ts -coreTablesFeature: TableFeature>; +coreTablesFeature: TableFeature; ``` Defined in: [core/coreFeatures.ts:16](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/coreFeatures.ts#L16) diff --git a/docs/reference/index/interfaces/CoreHeadersFeatureConstructors.md b/docs/reference/index/interfaces/CoreHeadersFeatureConstructors.md deleted file mode 100644 index e0545b821c..0000000000 --- a/docs/reference/index/interfaces/CoreHeadersFeatureConstructors.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -id: CoreHeadersFeatureConstructors -title: CoreHeadersFeatureConstructors ---- - -# Interface: CoreHeadersFeatureConstructors\ - -Defined in: [core/headers/coreHeadersFeature.ts:14](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/headers/coreHeadersFeature.ts#L14) - -## Type Parameters - -### TFeatures - -`TFeatures` *extends* [`TableFeatures`](TableFeatures.md) - -### TData - -`TData` *extends* [`RowData`](../type-aliases/RowData.md) diff --git a/docs/reference/index/interfaces/CoreRowModelsFeatureConstructors.md b/docs/reference/index/interfaces/CoreRowModelsFeatureConstructors.md deleted file mode 100644 index b0b670a2b2..0000000000 --- a/docs/reference/index/interfaces/CoreRowModelsFeatureConstructors.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -id: CoreRowModelsFeatureConstructors -title: CoreRowModelsFeatureConstructors ---- - -# Interface: CoreRowModelsFeatureConstructors\ - -Defined in: [core/row-models/coreRowModelsFeature.ts:20](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/row-models/coreRowModelsFeature.ts#L20) - -## Type Parameters - -### TFeatures - -`TFeatures` *extends* [`TableFeatures`](TableFeatures.md) - -### TData - -`TData` *extends* [`RowData`](../type-aliases/RowData.md) diff --git a/docs/reference/index/interfaces/CoreRowsFeatureConstructors.md b/docs/reference/index/interfaces/CoreRowsFeatureConstructors.md deleted file mode 100644 index b12db0848e..0000000000 --- a/docs/reference/index/interfaces/CoreRowsFeatureConstructors.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -id: CoreRowsFeatureConstructors -title: CoreRowsFeatureConstructors ---- - -# Interface: CoreRowsFeatureConstructors\ - -Defined in: [core/rows/coreRowsFeature.ts:22](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/coreRowsFeature.ts#L22) - -## Type Parameters - -### TFeatures - -`TFeatures` *extends* [`TableFeatures`](TableFeatures.md) - -### TData - -`TData` *extends* [`RowData`](../type-aliases/RowData.md) diff --git a/docs/reference/index/interfaces/CoreTablesFeatureConstructors.md b/docs/reference/index/interfaces/CoreTablesFeatureConstructors.md deleted file mode 100644 index d17cf0b2f1..0000000000 --- a/docs/reference/index/interfaces/CoreTablesFeatureConstructors.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -id: CoreTablesFeatureConstructors -title: CoreTablesFeatureConstructors ---- - -# Interface: CoreTablesFeatureConstructors\ - -Defined in: [core/table/coreTablesFeature.ts:7](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/table/coreTablesFeature.ts#L7) - -## Type Parameters - -### TFeatures - -`TFeatures` *extends* [`TableFeatures`](TableFeatures.md) - -### TData - -`TData` *extends* [`RowData`](../type-aliases/RowData.md) diff --git a/docs/reference/index/interfaces/CreateRowModel_Core.md b/docs/reference/index/interfaces/CreateRowModel_Core.md index 448cc396bc..0994cf5531 100644 --- a/docs/reference/index/interfaces/CreateRowModel_Core.md +++ b/docs/reference/index/interfaces/CreateRowModel_Core.md @@ -5,11 +5,7 @@ title: CreateRowModel_Core # Interface: CreateRowModel\_Core\ -Defined in: [core/row-models/coreRowModelsFeature.types.ts:23](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/row-models/coreRowModelsFeature.types.ts#L23) - -## Extends - -- [`CreateRowModel_Plugins`](CreateRowModel_Plugins.md) +Defined in: [core/row-models/coreRowModelsFeature.types.ts:21](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/row-models/coreRowModelsFeature.types.ts#L21) ## Type Parameters @@ -29,7 +25,7 @@ Defined in: [core/row-models/coreRowModelsFeature.types.ts:23](https://github.co optional coreRowModel: (table) => () => RowModel; ``` -Defined in: [core/row-models/coreRowModelsFeature.types.ts:31](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/row-models/coreRowModelsFeature.types.ts#L31) +Defined in: [core/row-models/coreRowModelsFeature.types.ts:29](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/row-models/coreRowModelsFeature.types.ts#L29) Optional factory for the core row model. When omitted, the built-in `createCoreRowModel()` factory is used. diff --git a/docs/reference/index/interfaces/CreateRowModel_Plugins.md b/docs/reference/index/interfaces/CreateRowModel_Plugins.md deleted file mode 100644 index d548153f1b..0000000000 --- a/docs/reference/index/interfaces/CreateRowModel_Plugins.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -id: CreateRowModel_Plugins -title: CreateRowModel_Plugins ---- - -# Interface: CreateRowModel\_Plugins - -Defined in: [core/row-models/coreRowModelsFeature.types.ts:21](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/row-models/coreRowModelsFeature.types.ts#L21) - -## Extended by - -- [`CreateRowModel_Core`](CreateRowModel_Core.md) diff --git a/docs/reference/index/interfaces/CreateRowModels_FeatureMap.md b/docs/reference/index/interfaces/CreateRowModels_FeatureMap.md new file mode 100644 index 0000000000..f8a7545b16 --- /dev/null +++ b/docs/reference/index/interfaces/CreateRowModels_FeatureMap.md @@ -0,0 +1,78 @@ +--- +id: CreateRowModels_FeatureMap +title: CreateRowModels_FeatureMap +--- + +# Interface: CreateRowModels\_FeatureMap\ + +Defined in: [types/RowModel.ts:33](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/RowModel.ts#L33) + +## Type Parameters + +### TFeatures + +`TFeatures` *extends* [`TableFeatures`](TableFeatures.md) + +### TData + +`TData` *extends* [`RowData`](../type-aliases/RowData.md) + +## Properties + +### columnFacetingFeature + +```ts +columnFacetingFeature: CreateRowModel_Faceted; +``` + +Defined in: [types/RowModel.ts:37](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/RowModel.ts#L37) + +*** + +### columnFilteringFeature + +```ts +columnFilteringFeature: CreateRowModel_Filtered; +``` + +Defined in: [types/RowModel.ts:38](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/RowModel.ts#L38) + +*** + +### columnGroupingFeature + +```ts +columnGroupingFeature: CreateRowModel_Grouped; +``` + +Defined in: [types/RowModel.ts:40](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/RowModel.ts#L40) + +*** + +### rowExpandingFeature + +```ts +rowExpandingFeature: CreateRowModel_Expanded; +``` + +Defined in: [types/RowModel.ts:39](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/RowModel.ts#L39) + +*** + +### rowPaginationFeature + +```ts +rowPaginationFeature: CreateRowModel_Paginated; +``` + +Defined in: [types/RowModel.ts:41](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/RowModel.ts#L41) + +*** + +### rowSortingFeature + +```ts +rowSortingFeature: CreateRowModel_Sorted; +``` + +Defined in: [types/RowModel.ts:42](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/RowModel.ts#L42) diff --git a/docs/reference/index/interfaces/CreateRowModels_Plugins.md b/docs/reference/index/interfaces/CreateRowModels_Plugins.md deleted file mode 100644 index 6604e4bdfa..0000000000 --- a/docs/reference/index/interfaces/CreateRowModels_Plugins.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -id: CreateRowModels_Plugins -title: CreateRowModels_Plugins ---- - -# Interface: CreateRowModels\_Plugins\ - -Defined in: [types/RowModel.ts:37](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/RowModel.ts#L37) - -Use this interface as a target for declaration merging to add your own plugin properties. -Note: This will affect the types of all tables in your project. - -## Type Parameters - -### TFeatures - -`TFeatures` *extends* [`TableFeatures`](TableFeatures.md) - -### TData - -`TData` *extends* [`RowData`](../type-aliases/RowData.md) diff --git a/docs/reference/index/interfaces/FeatureConstructors.md b/docs/reference/index/interfaces/FeatureConstructors.md deleted file mode 100644 index 2e17fc27f6..0000000000 --- a/docs/reference/index/interfaces/FeatureConstructors.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -id: FeatureConstructors -title: FeatureConstructors ---- - -# Interface: FeatureConstructors - -Defined in: [types/TableFeatures.ts:25](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableFeatures.ts#L25) - -## Properties - -### CachedRowModel? - -```ts -optional CachedRowModel: any; -``` - -Defined in: [types/TableFeatures.ts:26](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableFeatures.ts#L26) - -*** - -### Cell? - -```ts -optional Cell: any; -``` - -Defined in: [types/TableFeatures.ts:27](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableFeatures.ts#L27) - -*** - -### Column? - -```ts -optional Column: any; -``` - -Defined in: [types/TableFeatures.ts:28](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableFeatures.ts#L28) - -*** - -### ColumnDef? - -```ts -optional ColumnDef: any; -``` - -Defined in: [types/TableFeatures.ts:29](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableFeatures.ts#L29) - -*** - -### CreateRowModels? - -```ts -optional CreateRowModels: any; -``` - -Defined in: [types/TableFeatures.ts:30](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableFeatures.ts#L30) - -*** - -### Header? - -```ts -optional Header: any; -``` - -Defined in: [types/TableFeatures.ts:31](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableFeatures.ts#L31) - -*** - -### HeaderGroup? - -```ts -optional HeaderGroup: any; -``` - -Defined in: [types/TableFeatures.ts:32](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableFeatures.ts#L32) - -*** - -### Row? - -```ts -optional Row: any; -``` - -Defined in: [types/TableFeatures.ts:33](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableFeatures.ts#L33) - -*** - -### RowModelFns? - -```ts -optional RowModelFns: any; -``` - -Defined in: [types/TableFeatures.ts:34](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableFeatures.ts#L34) - -*** - -### Table? - -```ts -optional Table: any; -``` - -Defined in: [types/TableFeatures.ts:35](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableFeatures.ts#L35) - -*** - -### TableOptions? - -```ts -optional TableOptions: any; -``` - -Defined in: [types/TableFeatures.ts:36](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableFeatures.ts#L36) - -*** - -### TableState? - -```ts -optional TableState: any; -``` - -Defined in: [types/TableFeatures.ts:37](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableFeatures.ts#L37) diff --git a/docs/reference/index/interfaces/GlobalFilteringFeatureConstructors.md b/docs/reference/index/interfaces/GlobalFilteringFeatureConstructors.md deleted file mode 100644 index 1b518cdcb7..0000000000 --- a/docs/reference/index/interfaces/GlobalFilteringFeatureConstructors.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -id: GlobalFilteringFeatureConstructors -title: GlobalFilteringFeatureConstructors ---- - -# Interface: GlobalFilteringFeatureConstructors\ - -Defined in: [features/global-filtering/globalFilteringFeature.ts:23](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/global-filtering/globalFilteringFeature.ts#L23) - -## Type Parameters - -### TFeatures - -`TFeatures` *extends* [`TableFeatures`](TableFeatures.md) - -### TData - -`TData` *extends* [`RowData`](../type-aliases/RowData.md) diff --git a/docs/reference/index/interfaces/HeaderGroup_Core.md b/docs/reference/index/interfaces/HeaderGroup_Core.md index c96bf83855..c569e31f85 100644 --- a/docs/reference/index/interfaces/HeaderGroup_Core.md +++ b/docs/reference/index/interfaces/HeaderGroup_Core.md @@ -5,7 +5,7 @@ title: HeaderGroup_Core # Interface: HeaderGroup\_Core\ -Defined in: [types/HeaderGroup.ts:14](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/HeaderGroup.ts#L14) +Defined in: [types/HeaderGroup.ts:5](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/HeaderGroup.ts#L5) ## Extends diff --git a/docs/reference/index/interfaces/HeaderGroup_Plugins.md b/docs/reference/index/interfaces/HeaderGroup_Plugins.md deleted file mode 100644 index 0852efdc72..0000000000 --- a/docs/reference/index/interfaces/HeaderGroup_Plugins.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -id: HeaderGroup_Plugins -title: HeaderGroup_Plugins ---- - -# Interface: HeaderGroup\_Plugins\ - -Defined in: [types/HeaderGroup.ts:9](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/HeaderGroup.ts#L9) - -Use this interface as a target for declaration merging to add your own plugin properties. -Note: This will affect the types of all tables in your project. - -## Type Parameters - -### TFeatures - -`TFeatures` *extends* [`TableFeatures`](TableFeatures.md) - -### TData - -`TData` *extends* [`RowData`](../type-aliases/RowData.md) diff --git a/docs/reference/index/interfaces/Header_Core.md b/docs/reference/index/interfaces/Header_Core.md index 57ead494d4..432991dd9c 100644 --- a/docs/reference/index/interfaces/Header_Core.md +++ b/docs/reference/index/interfaces/Header_Core.md @@ -5,7 +5,7 @@ title: Header_Core # Interface: Header\_Core\ -Defined in: [types/Header.ts:17](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/Header.ts#L17) +Defined in: [types/Header.ts:7](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/Header.ts#L7) ## Extends diff --git a/docs/reference/index/interfaces/Header_FeatureMap.md b/docs/reference/index/interfaces/Header_FeatureMap.md new file mode 100644 index 0000000000..46aae50278 --- /dev/null +++ b/docs/reference/index/interfaces/Header_FeatureMap.md @@ -0,0 +1,28 @@ +--- +id: Header_FeatureMap +title: Header_FeatureMap +--- + +# Interface: Header\_FeatureMap + +Defined in: [types/Header.ts:13](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/Header.ts#L13) + +## Properties + +### columnResizingFeature + +```ts +columnResizingFeature: Header_ColumnResizing; +``` + +Defined in: [types/Header.ts:15](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/Header.ts#L15) + +*** + +### columnSizingFeature + +```ts +columnSizingFeature: Header_ColumnSizing; +``` + +Defined in: [types/Header.ts:14](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/Header.ts#L14) diff --git a/docs/reference/index/interfaces/Header_Plugins.md b/docs/reference/index/interfaces/Header_Plugins.md deleted file mode 100644 index c1e09c4777..0000000000 --- a/docs/reference/index/interfaces/Header_Plugins.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -id: Header_Plugins -title: Header_Plugins ---- - -# Interface: Header\_Plugins\ - -Defined in: [types/Header.ts:11](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/Header.ts#L11) - -Use this interface as a target for declaration merging to add your own plugin properties. -Note: This will affect the types of all tables in your project. - -## Type Parameters - -### TFeatures - -`TFeatures` *extends* [`TableFeatures`](TableFeatures.md) - -### TData - -`TData` *extends* [`RowData`](../type-aliases/RowData.md) - -### TValue - -`TValue` *extends* [`CellData`](../type-aliases/CellData.md) = [`CellData`](../type-aliases/CellData.md) diff --git a/docs/reference/index/interfaces/IdIdentifier.md b/docs/reference/index/interfaces/IdIdentifier.md index 416ae96ca7..a238fa8299 100644 --- a/docs/reference/index/interfaces/IdIdentifier.md +++ b/docs/reference/index/interfaces/IdIdentifier.md @@ -5,7 +5,7 @@ title: IdIdentifier # Interface: IdIdentifier\ -Defined in: [types/ColumnDef.ts:68](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/ColumnDef.ts#L68) +Defined in: [types/ColumnDef.ts:58](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/ColumnDef.ts#L58) ## Type Parameters @@ -29,7 +29,7 @@ Defined in: [types/ColumnDef.ts:68](https://github.com/TanStack/table/blob/main/ optional header: ColumnDefTemplate>; ``` -Defined in: [types/ColumnDef.ts:80](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/ColumnDef.ts#L80) +Defined in: [types/ColumnDef.ts:70](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/ColumnDef.ts#L70) Header text or template used to render this column's header. @@ -41,6 +41,6 @@ Header text or template used to render this column's header. id: string; ``` -Defined in: [types/ColumnDef.ts:76](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/ColumnDef.ts#L76) +Defined in: [types/ColumnDef.ts:66](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/ColumnDef.ts#L66) Explicit stable column id. diff --git a/docs/reference/index/interfaces/Plugins.md b/docs/reference/index/interfaces/Plugins.md index a923a8a653..30d76676a9 100644 --- a/docs/reference/index/interfaces/Plugins.md +++ b/docs/reference/index/interfaces/Plugins.md @@ -5,4 +5,4 @@ title: Plugins # Interface: Plugins -Defined in: [types/TableFeatures.ts:40](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableFeatures.ts#L40) +Defined in: [types/TableFeatures.ts:25](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableFeatures.ts#L25) diff --git a/docs/reference/index/interfaces/RowExpandingFeatureConstructors.md b/docs/reference/index/interfaces/RowExpandingFeatureConstructors.md deleted file mode 100644 index ca520ba3fe..0000000000 --- a/docs/reference/index/interfaces/RowExpandingFeatureConstructors.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -id: RowExpandingFeatureConstructors -title: RowExpandingFeatureConstructors ---- - -# Interface: RowExpandingFeatureConstructors\ - -Defined in: [features/row-expanding/rowExpandingFeature.ts:34](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-expanding/rowExpandingFeature.ts#L34) - -## Type Parameters - -### TFeatures - -`TFeatures` *extends* [`TableFeatures`](TableFeatures.md) - -### TData - -`TData` *extends* [`RowData`](../type-aliases/RowData.md) diff --git a/docs/reference/index/interfaces/RowModelFns_ColumnFiltering.md b/docs/reference/index/interfaces/RowModelFns_ColumnFiltering.md index e6d142dc70..ec74ec8883 100644 --- a/docs/reference/index/interfaces/RowModelFns_ColumnFiltering.md +++ b/docs/reference/index/interfaces/RowModelFns_ColumnFiltering.md @@ -22,7 +22,7 @@ Defined in: [features/column-filtering/columnFilteringFeature.types.ts:38](https ### filterFns ```ts -filterFns: Record>; +filterFns: Record>; ``` Defined in: [features/column-filtering/columnFilteringFeature.types.ts:42](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-filtering/columnFilteringFeature.types.ts#L42) diff --git a/docs/reference/index/interfaces/RowModelFns_Core.md b/docs/reference/index/interfaces/RowModelFns_Core.md index 61bf61fa25..2dbaf85cb6 100644 --- a/docs/reference/index/interfaces/RowModelFns_Core.md +++ b/docs/reference/index/interfaces/RowModelFns_Core.md @@ -5,4 +5,4 @@ title: RowModelFns_Core # Interface: RowModelFns\_Core -Defined in: [types/RowModelFns.ts:16](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/RowModelFns.ts#L16) +Defined in: [types/RowModelFns.ts:7](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/RowModelFns.ts#L7) diff --git a/docs/reference/index/interfaces/RowModelFns_FeatureMap.md b/docs/reference/index/interfaces/RowModelFns_FeatureMap.md new file mode 100644 index 0000000000..2762e3ce3b --- /dev/null +++ b/docs/reference/index/interfaces/RowModelFns_FeatureMap.md @@ -0,0 +1,48 @@ +--- +id: RowModelFns_FeatureMap +title: RowModelFns_FeatureMap +--- + +# Interface: RowModelFns\_FeatureMap\ + +Defined in: [types/RowModelFns.ts:9](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/RowModelFns.ts#L9) + +## Type Parameters + +### TFeatures + +`TFeatures` *extends* [`TableFeatures`](TableFeatures.md) + +### TData + +`TData` *extends* [`RowData`](../type-aliases/RowData.md) + +## Properties + +### columnFilteringFeature + +```ts +columnFilteringFeature: RowModelFns_ColumnFiltering; +``` + +Defined in: [types/RowModelFns.ts:13](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/RowModelFns.ts#L13) + +*** + +### columnGroupingFeature + +```ts +columnGroupingFeature: RowModelFns_ColumnGrouping; +``` + +Defined in: [types/RowModelFns.ts:14](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/RowModelFns.ts#L14) + +*** + +### rowSortingFeature + +```ts +rowSortingFeature: RowModelFns_RowSorting; +``` + +Defined in: [types/RowModelFns.ts:15](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/RowModelFns.ts#L15) diff --git a/docs/reference/index/interfaces/RowModelFns_Plugins.md b/docs/reference/index/interfaces/RowModelFns_Plugins.md deleted file mode 100644 index ea45a3438f..0000000000 --- a/docs/reference/index/interfaces/RowModelFns_Plugins.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -id: RowModelFns_Plugins -title: RowModelFns_Plugins ---- - -# Interface: RowModelFns\_Plugins\ - -Defined in: [types/RowModelFns.ts:11](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/RowModelFns.ts#L11) - -Use this interface as a target for declaration merging to add your own plugin properties. -Note: This will affect the types of all tables in your project. - -## Type Parameters - -### TFeatures - -`TFeatures` *extends* [`TableFeatures`](TableFeatures.md) - -### TData - -`TData` *extends* [`RowData`](../type-aliases/RowData.md) diff --git a/docs/reference/index/interfaces/RowPaginationFeatureConstructors.md b/docs/reference/index/interfaces/RowPaginationFeatureConstructors.md deleted file mode 100644 index d1ea260310..0000000000 --- a/docs/reference/index/interfaces/RowPaginationFeatureConstructors.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -id: RowPaginationFeatureConstructors -title: RowPaginationFeatureConstructors ---- - -# Interface: RowPaginationFeatureConstructors\ - -Defined in: [features/row-pagination/rowPaginationFeature.ts:31](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pagination/rowPaginationFeature.ts#L31) - -## Type Parameters - -### TFeatures - -`TFeatures` *extends* [`TableFeatures`](TableFeatures.md) - -### TData - -`TData` *extends* [`RowData`](../type-aliases/RowData.md) diff --git a/docs/reference/index/interfaces/RowPinningFeatureConstructors.md b/docs/reference/index/interfaces/RowPinningFeatureConstructors.md deleted file mode 100644 index ffb2b79762..0000000000 --- a/docs/reference/index/interfaces/RowPinningFeatureConstructors.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -id: RowPinningFeatureConstructors -title: RowPinningFeatureConstructors ---- - -# Interface: RowPinningFeatureConstructors\ - -Defined in: [features/row-pinning/rowPinningFeature.ts:28](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pinning/rowPinningFeature.ts#L28) - -## Type Parameters - -### TFeatures - -`TFeatures` *extends* [`TableFeatures`](TableFeatures.md) - -### TData - -`TData` *extends* [`RowData`](../type-aliases/RowData.md) diff --git a/docs/reference/index/interfaces/RowSelectionFeatureConstructors.md b/docs/reference/index/interfaces/RowSelectionFeatureConstructors.md deleted file mode 100644 index aa38498b0c..0000000000 --- a/docs/reference/index/interfaces/RowSelectionFeatureConstructors.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -id: RowSelectionFeatureConstructors -title: RowSelectionFeatureConstructors ---- - -# Interface: RowSelectionFeatureConstructors\ - -Defined in: [features/row-selection/rowSelectionFeature.ts:40](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/rowSelectionFeature.ts#L40) - -## Type Parameters - -### TFeatures - -`TFeatures` *extends* [`TableFeatures`](TableFeatures.md) - -### TData - -`TData` *extends* [`RowData`](../type-aliases/RowData.md) diff --git a/docs/reference/index/interfaces/RowSortingFeatureConstructors.md b/docs/reference/index/interfaces/RowSortingFeatureConstructors.md deleted file mode 100644 index ca4b60e2c7..0000000000 --- a/docs/reference/index/interfaces/RowSortingFeatureConstructors.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -id: RowSortingFeatureConstructors -title: RowSortingFeatureConstructors ---- - -# Interface: RowSortingFeatureConstructors\ - -Defined in: [features/row-sorting/rowSortingFeature.ts:36](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/rowSortingFeature.ts#L36) - -## Type Parameters - -### TFeatures - -`TFeatures` *extends* [`TableFeatures`](TableFeatures.md) - -### TData - -`TData` *extends* [`RowData`](../type-aliases/RowData.md) diff --git a/docs/reference/index/interfaces/Row_Core.md b/docs/reference/index/interfaces/Row_Core.md index 2881466635..45f85aa65c 100644 --- a/docs/reference/index/interfaces/Row_Core.md +++ b/docs/reference/index/interfaces/Row_Core.md @@ -5,7 +5,7 @@ title: Row_Core # Interface: Row\_Core\ -Defined in: [types/Row.ts:21](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/Row.ts#L21) +Defined in: [types/Row.ts:12](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/Row.ts#L12) ## Extends diff --git a/docs/reference/index/interfaces/Row_FeatureMap.md b/docs/reference/index/interfaces/Row_FeatureMap.md new file mode 100644 index 0000000000..46ba81add6 --- /dev/null +++ b/docs/reference/index/interfaces/Row_FeatureMap.md @@ -0,0 +1,88 @@ +--- +id: Row_FeatureMap +title: Row_FeatureMap +--- + +# Interface: Row\_FeatureMap\ + +Defined in: [types/Row.ts:17](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/Row.ts#L17) + +## Type Parameters + +### TFeatures + +`TFeatures` *extends* [`TableFeatures`](TableFeatures.md) + +### TData + +`TData` *extends* [`RowData`](../type-aliases/RowData.md) + +## Properties + +### columnFilteringFeature + +```ts +columnFilteringFeature: Row_ColumnFiltering; +``` + +Defined in: [types/Row.ts:21](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/Row.ts#L21) + +*** + +### columnGroupingFeature + +```ts +columnGroupingFeature: Row_ColumnGrouping; +``` + +Defined in: [types/Row.ts:22](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/Row.ts#L22) + +*** + +### columnPinningFeature + +```ts +columnPinningFeature: Row_ColumnPinning; +``` + +Defined in: [types/Row.ts:23](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/Row.ts#L23) + +*** + +### columnVisibilityFeature + +```ts +columnVisibilityFeature: Row_ColumnVisibility; +``` + +Defined in: [types/Row.ts:24](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/Row.ts#L24) + +*** + +### rowExpandingFeature + +```ts +rowExpandingFeature: Row_RowExpanding; +``` + +Defined in: [types/Row.ts:25](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/Row.ts#L25) + +*** + +### rowPinningFeature + +```ts +rowPinningFeature: Row_RowPinning; +``` + +Defined in: [types/Row.ts:26](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/Row.ts#L26) + +*** + +### rowSelectionFeature + +```ts +rowSelectionFeature: Row_RowSelection; +``` + +Defined in: [types/Row.ts:27](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/Row.ts#L27) diff --git a/docs/reference/index/interfaces/Row_Plugins.md b/docs/reference/index/interfaces/Row_Plugins.md deleted file mode 100644 index 2c6aa8f40b..0000000000 --- a/docs/reference/index/interfaces/Row_Plugins.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -id: Row_Plugins -title: Row_Plugins ---- - -# Interface: Row\_Plugins\ - -Defined in: [types/Row.ts:16](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/Row.ts#L16) - -Use this interface as a target for declaration merging to add your own plugin properties. -Note: This will affect the types of all tables in your project. - -## Type Parameters - -### TFeatures - -`TFeatures` *extends* [`TableFeatures`](TableFeatures.md) - -### TData - -`TData` *extends* [`RowData`](../type-aliases/RowData.md) diff --git a/docs/reference/index/interfaces/StockFeatures.md b/docs/reference/index/interfaces/StockFeatures.md index c8a8f99e48..f1ecc0d2aa 100644 --- a/docs/reference/index/interfaces/StockFeatures.md +++ b/docs/reference/index/interfaces/StockFeatures.md @@ -12,7 +12,7 @@ Defined in: [features/stockFeatures.ts:16](https://github.com/TanStack/table/blo ### columnFacetingFeature ```ts -columnFacetingFeature: TableFeature>; +columnFacetingFeature: TableFeature; ``` Defined in: [features/stockFeatures.ts:17](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/stockFeatures.ts#L17) @@ -22,7 +22,7 @@ Defined in: [features/stockFeatures.ts:17](https://github.com/TanStack/table/blo ### columnFilteringFeature ```ts -columnFilteringFeature: TableFeature>; +columnFilteringFeature: TableFeature; ``` Defined in: [features/stockFeatures.ts:18](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/stockFeatures.ts#L18) @@ -32,7 +32,7 @@ Defined in: [features/stockFeatures.ts:18](https://github.com/TanStack/table/blo ### columnGroupingFeature ```ts -columnGroupingFeature: TableFeature>; +columnGroupingFeature: TableFeature; ``` Defined in: [features/stockFeatures.ts:19](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/stockFeatures.ts#L19) @@ -42,7 +42,7 @@ Defined in: [features/stockFeatures.ts:19](https://github.com/TanStack/table/blo ### columnOrderingFeature ```ts -columnOrderingFeature: TableFeature>; +columnOrderingFeature: TableFeature; ``` Defined in: [features/stockFeatures.ts:20](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/stockFeatures.ts#L20) @@ -52,7 +52,7 @@ Defined in: [features/stockFeatures.ts:20](https://github.com/TanStack/table/blo ### columnPinningFeature ```ts -columnPinningFeature: TableFeature>; +columnPinningFeature: TableFeature; ``` Defined in: [features/stockFeatures.ts:21](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/stockFeatures.ts#L21) @@ -62,7 +62,7 @@ Defined in: [features/stockFeatures.ts:21](https://github.com/TanStack/table/blo ### columnResizingFeature ```ts -columnResizingFeature: TableFeature>; +columnResizingFeature: TableFeature; ``` Defined in: [features/stockFeatures.ts:22](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/stockFeatures.ts#L22) @@ -72,7 +72,7 @@ Defined in: [features/stockFeatures.ts:22](https://github.com/TanStack/table/blo ### columnSizingFeature ```ts -columnSizingFeature: TableFeature>; +columnSizingFeature: TableFeature; ``` Defined in: [features/stockFeatures.ts:23](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/stockFeatures.ts#L23) @@ -82,7 +82,7 @@ Defined in: [features/stockFeatures.ts:23](https://github.com/TanStack/table/blo ### columnVisibilityFeature ```ts -columnVisibilityFeature: TableFeature>; +columnVisibilityFeature: TableFeature; ``` Defined in: [features/stockFeatures.ts:24](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/stockFeatures.ts#L24) @@ -92,7 +92,7 @@ Defined in: [features/stockFeatures.ts:24](https://github.com/TanStack/table/blo ### globalFilteringFeature ```ts -globalFilteringFeature: TableFeature>; +globalFilteringFeature: TableFeature; ``` Defined in: [features/stockFeatures.ts:25](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/stockFeatures.ts#L25) @@ -102,7 +102,7 @@ Defined in: [features/stockFeatures.ts:25](https://github.com/TanStack/table/blo ### rowExpandingFeature ```ts -rowExpandingFeature: TableFeature>; +rowExpandingFeature: TableFeature; ``` Defined in: [features/stockFeatures.ts:26](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/stockFeatures.ts#L26) @@ -112,7 +112,7 @@ Defined in: [features/stockFeatures.ts:26](https://github.com/TanStack/table/blo ### rowPaginationFeature ```ts -rowPaginationFeature: TableFeature>; +rowPaginationFeature: TableFeature; ``` Defined in: [features/stockFeatures.ts:27](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/stockFeatures.ts#L27) @@ -122,7 +122,7 @@ Defined in: [features/stockFeatures.ts:27](https://github.com/TanStack/table/blo ### rowPinningFeature ```ts -rowPinningFeature: TableFeature>; +rowPinningFeature: TableFeature; ``` Defined in: [features/stockFeatures.ts:28](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/stockFeatures.ts#L28) @@ -132,7 +132,7 @@ Defined in: [features/stockFeatures.ts:28](https://github.com/TanStack/table/blo ### rowSelectionFeature ```ts -rowSelectionFeature: TableFeature>; +rowSelectionFeature: TableFeature; ``` Defined in: [features/stockFeatures.ts:29](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/stockFeatures.ts#L29) @@ -142,7 +142,7 @@ Defined in: [features/stockFeatures.ts:29](https://github.com/TanStack/table/blo ### rowSortingFeature ```ts -rowSortingFeature: TableFeature>; +rowSortingFeature: TableFeature; ``` Defined in: [features/stockFeatures.ts:30](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/stockFeatures.ts#L30) diff --git a/docs/reference/index/interfaces/StringHeaderIdentifier.md b/docs/reference/index/interfaces/StringHeaderIdentifier.md index 6e7e0a6608..5221a36207 100644 --- a/docs/reference/index/interfaces/StringHeaderIdentifier.md +++ b/docs/reference/index/interfaces/StringHeaderIdentifier.md @@ -5,7 +5,7 @@ title: StringHeaderIdentifier # Interface: StringHeaderIdentifier -Defined in: [types/ColumnDef.ts:57](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/ColumnDef.ts#L57) +Defined in: [types/ColumnDef.ts:47](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/ColumnDef.ts#L47) ## Properties @@ -15,7 +15,7 @@ Defined in: [types/ColumnDef.ts:57](https://github.com/TanStack/table/blob/main/ header: string; ``` -Defined in: [types/ColumnDef.ts:61](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/ColumnDef.ts#L61) +Defined in: [types/ColumnDef.ts:51](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/ColumnDef.ts#L51) Header text used both for rendering and as a fallback column id. @@ -27,6 +27,6 @@ Header text used both for rendering and as a fallback column id. optional id: string; ``` -Defined in: [types/ColumnDef.ts:65](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/ColumnDef.ts#L65) +Defined in: [types/ColumnDef.ts:55](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/ColumnDef.ts#L55) Optional explicit id that overrides the header-derived id. diff --git a/docs/reference/index/interfaces/TableFeature.md b/docs/reference/index/interfaces/TableFeature.md index 19f89d8a5f..f6ce8524a9 100644 --- a/docs/reference/index/interfaces/TableFeature.md +++ b/docs/reference/index/interfaces/TableFeature.md @@ -3,120 +3,298 @@ id: TableFeature title: TableFeature --- -# Interface: TableFeature\ +# Interface: TableFeature -Defined in: [types/TableFeatures.ts:116](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableFeatures.ts#L116) - -## Type Parameters - -### TConstructors - -`TConstructors` *extends* [`FeatureConstructors`](FeatureConstructors.md) +Defined in: [types/TableFeatures.ts:30](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableFeatures.ts#L30) ## Properties -### assignCellPrototype? +### assignCellPrototype()? ```ts -optional assignCellPrototype: AssignCellPrototype; +optional assignCellPrototype: (prototype, table) => void; ``` -Defined in: [types/TableFeatures.ts:121](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableFeatures.ts#L121) +Defined in: [types/TableFeatures.ts:35](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableFeatures.ts#L35) Assigns Cell APIs to the cell prototype for memory-efficient method sharing. This is called once per table to build a shared prototype for all cells. +#### Type Parameters + +##### TFeatures + +`TFeatures` *extends* [`TableFeatures`](TableFeatures.md) + +##### TData + +`TData` *extends* [`RowData`](../type-aliases/RowData.md) + +#### Parameters + +##### prototype + +`Record`\<`string`, `any`\> + +##### table + +[`Table_Internal`](../type-aliases/Table_Internal.md)\<`TFeatures`, `TData`\> + +#### Returns + +`void` + *** -### assignColumnPrototype? +### assignColumnPrototype()? ```ts -optional assignColumnPrototype: AssignColumnPrototype; +optional assignColumnPrototype: (prototype, table) => void; ``` -Defined in: [types/TableFeatures.ts:126](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableFeatures.ts#L126) +Defined in: [types/TableFeatures.ts:46](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableFeatures.ts#L46) Assigns Column APIs to the column prototype for memory-efficient method sharing. This is called once per table to build a shared prototype for all columns. +#### Type Parameters + +##### TFeatures + +`TFeatures` *extends* [`TableFeatures`](TableFeatures.md) + +##### TData + +`TData` *extends* [`RowData`](../type-aliases/RowData.md) + +#### Parameters + +##### prototype + +`Record`\<`string`, `any`\> + +##### table + +[`Table_Internal`](../type-aliases/Table_Internal.md)\<`TFeatures`, `TData`\> + +#### Returns + +`void` + *** -### assignHeaderPrototype? +### assignHeaderPrototype()? ```ts -optional assignHeaderPrototype: AssignHeaderPrototype; +optional assignHeaderPrototype: (prototype, table) => void; ``` -Defined in: [types/TableFeatures.ts:131](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableFeatures.ts#L131) +Defined in: [types/TableFeatures.ts:57](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableFeatures.ts#L57) Assigns Header APIs to the header prototype for memory-efficient method sharing. This is called once per table to build a shared prototype for all headers. +#### Type Parameters + +##### TFeatures + +`TFeatures` *extends* [`TableFeatures`](TableFeatures.md) + +##### TData + +`TData` *extends* [`RowData`](../type-aliases/RowData.md) + +#### Parameters + +##### prototype + +`Record`\<`string`, `any`\> + +##### table + +[`Table_Internal`](../type-aliases/Table_Internal.md)\<`TFeatures`, `TData`\> + +#### Returns + +`void` + *** -### assignRowPrototype? +### assignRowPrototype()? ```ts -optional assignRowPrototype: AssignRowPrototype; +optional assignRowPrototype: (prototype, table) => void; ``` -Defined in: [types/TableFeatures.ts:136](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableFeatures.ts#L136) +Defined in: [types/TableFeatures.ts:68](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableFeatures.ts#L68) Assigns Row APIs to the row prototype for memory-efficient method sharing. This is called once per table to build a shared prototype for all rows. +#### Type Parameters + +##### TFeatures + +`TFeatures` *extends* [`TableFeatures`](TableFeatures.md) + +##### TData + +`TData` *extends* [`RowData`](../type-aliases/RowData.md) + +#### Parameters + +##### prototype + +`Record`\<`string`, `any`\> + +##### table + +[`Table_Internal`](../type-aliases/Table_Internal.md)\<`TFeatures`, `TData`\> + +#### Returns + +`void` + *** -### constructTableAPIs? +### constructTableAPIs()? ```ts -optional constructTableAPIs: ConstructTableAPIs; +optional constructTableAPIs: (table) => void; ``` -Defined in: [types/TableFeatures.ts:141](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableFeatures.ts#L141) +Defined in: [types/TableFeatures.ts:76](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableFeatures.ts#L76) Assigns Table APIs to the table instance. Unlike row/cell/column/header, the table is a singleton so methods are assigned directly. +#### Type Parameters + +##### TFeatures + +`TFeatures` *extends* [`TableFeatures`](TableFeatures.md) + +##### TData + +`TData` *extends* [`RowData`](../type-aliases/RowData.md) + +#### Parameters + +##### table + +[`Table_Internal`](../type-aliases/Table_Internal.md)\<`TFeatures`, `TData`\> + +#### Returns + +`void` + *** -### getDefaultColumnDef? +### getDefaultColumnDef()? ```ts -optional getDefaultColumnDef: GetDefaultColumnDef; +optional getDefaultColumnDef: () => ColumnDefBase_All; ``` -Defined in: [types/TableFeatures.ts:142](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableFeatures.ts#L142) +Defined in: [types/TableFeatures.ts:79](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableFeatures.ts#L79) + +#### Type Parameters + +##### TFeatures + +`TFeatures` *extends* [`TableFeatures`](TableFeatures.md) + +##### TData + +`TData` *extends* [`RowData`](../type-aliases/RowData.md) + +##### TValue + +`TValue` *extends* `unknown` = `unknown` + +#### Returns + +[`ColumnDefBase_All`](../type-aliases/ColumnDefBase_All.md)\<`TFeatures`, `TData`, `TValue`\> *** -### getDefaultTableOptions? +### getDefaultTableOptions()? ```ts -optional getDefaultTableOptions: GetDefaultTableOptions; +optional getDefaultTableOptions: (table) => Partial>; ``` -Defined in: [types/TableFeatures.ts:143](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableFeatures.ts#L143) +Defined in: [types/TableFeatures.ts:84](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableFeatures.ts#L84) + +#### Type Parameters + +##### TFeatures + +`TFeatures` *extends* [`TableFeatures`](TableFeatures.md) + +##### TData + +`TData` *extends* [`RowData`](../type-aliases/RowData.md) + +#### Parameters + +##### table + +[`Table_Internal`](../type-aliases/Table_Internal.md)\<`TFeatures`, `TData`\> + +#### Returns + +`Partial`\<[`TableOptions_All`](../type-aliases/TableOptions_All.md)\<`TFeatures`, `TData`\>\> *** -### getInitialState? +### getInitialState()? ```ts -optional getInitialState: GetInitialState; +optional getInitialState: (initialState) => TableState_All; ``` -Defined in: [types/TableFeatures.ts:144](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableFeatures.ts#L144) +Defined in: [types/TableFeatures.ts:90](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableFeatures.ts#L90) + +#### Parameters + +##### initialState + +`Partial`\<[`TableState_All`](../type-aliases/TableState_All.md)\> + +#### Returns + +[`TableState_All`](../type-aliases/TableState_All.md) *** -### initRowInstanceData? +### initRowInstanceData()? ```ts -optional initRowInstanceData: InitRowInstanceData; +optional initRowInstanceData: (row) => void; ``` -Defined in: [types/TableFeatures.ts:149](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableFeatures.ts#L149) +Defined in: [types/TableFeatures.ts:95](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableFeatures.ts#L95) Initializes instance-specific data on each row (e.g., caches). Methods should be assigned via assignRowPrototype instead. + +#### Type Parameters + +##### TFeatures + +`TFeatures` *extends* [`TableFeatures`](TableFeatures.md) + +##### TData + +`TData` *extends* [`RowData`](../type-aliases/RowData.md) + +#### Parameters + +##### row + +[`Row`](../type-aliases/Row.md)\<`TFeatures`, `TData`\> + +#### Returns + +`void` diff --git a/docs/reference/index/interfaces/TableFeatures.md b/docs/reference/index/interfaces/TableFeatures.md index 6204ceb9ea..6f7fa2377e 100644 --- a/docs/reference/index/interfaces/TableFeatures.md +++ b/docs/reference/index/interfaces/TableFeatures.md @@ -5,7 +5,7 @@ title: TableFeatures # Interface: TableFeatures -Defined in: [types/TableFeatures.ts:42](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableFeatures.ts#L42) +Defined in: [types/TableFeatures.ts:27](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableFeatures.ts#L27) ## Extends @@ -16,7 +16,7 @@ Defined in: [types/TableFeatures.ts:42](https://github.com/TanStack/table/blob/m ### columnFacetingFeature? ```ts -optional columnFacetingFeature: TableFeature>; +optional columnFacetingFeature: TableFeature; ``` Defined in: [features/stockFeatures.ts:17](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/stockFeatures.ts#L17) @@ -30,7 +30,7 @@ Defined in: [features/stockFeatures.ts:17](https://github.com/TanStack/table/blo ### columnFilteringFeature? ```ts -optional columnFilteringFeature: TableFeature>; +optional columnFilteringFeature: TableFeature; ``` Defined in: [features/stockFeatures.ts:18](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/stockFeatures.ts#L18) @@ -44,7 +44,7 @@ Defined in: [features/stockFeatures.ts:18](https://github.com/TanStack/table/blo ### columnGroupingFeature? ```ts -optional columnGroupingFeature: TableFeature>; +optional columnGroupingFeature: TableFeature; ``` Defined in: [features/stockFeatures.ts:19](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/stockFeatures.ts#L19) @@ -58,7 +58,7 @@ Defined in: [features/stockFeatures.ts:19](https://github.com/TanStack/table/blo ### columnOrderingFeature? ```ts -optional columnOrderingFeature: TableFeature>; +optional columnOrderingFeature: TableFeature; ``` Defined in: [features/stockFeatures.ts:20](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/stockFeatures.ts#L20) @@ -72,7 +72,7 @@ Defined in: [features/stockFeatures.ts:20](https://github.com/TanStack/table/blo ### columnPinningFeature? ```ts -optional columnPinningFeature: TableFeature>; +optional columnPinningFeature: TableFeature; ``` Defined in: [features/stockFeatures.ts:21](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/stockFeatures.ts#L21) @@ -86,7 +86,7 @@ Defined in: [features/stockFeatures.ts:21](https://github.com/TanStack/table/blo ### columnResizingFeature? ```ts -optional columnResizingFeature: TableFeature>; +optional columnResizingFeature: TableFeature; ``` Defined in: [features/stockFeatures.ts:22](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/stockFeatures.ts#L22) @@ -100,7 +100,7 @@ Defined in: [features/stockFeatures.ts:22](https://github.com/TanStack/table/blo ### columnSizingFeature? ```ts -optional columnSizingFeature: TableFeature>; +optional columnSizingFeature: TableFeature; ``` Defined in: [features/stockFeatures.ts:23](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/stockFeatures.ts#L23) @@ -114,7 +114,7 @@ Defined in: [features/stockFeatures.ts:23](https://github.com/TanStack/table/blo ### columnVisibilityFeature? ```ts -optional columnVisibilityFeature: TableFeature>; +optional columnVisibilityFeature: TableFeature; ``` Defined in: [features/stockFeatures.ts:24](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/stockFeatures.ts#L24) @@ -128,7 +128,7 @@ Defined in: [features/stockFeatures.ts:24](https://github.com/TanStack/table/blo ### coreCellsFeature? ```ts -optional coreCellsFeature: TableFeature>; +optional coreCellsFeature: TableFeature; ``` Defined in: [core/coreFeatures.ts:11](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/coreFeatures.ts#L11) @@ -142,7 +142,7 @@ Defined in: [core/coreFeatures.ts:11](https://github.com/TanStack/table/blob/mai ### coreColumnsFeature? ```ts -optional coreColumnsFeature: TableFeature>; +optional coreColumnsFeature: TableFeature; ``` Defined in: [core/coreFeatures.ts:12](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/coreFeatures.ts#L12) @@ -156,7 +156,7 @@ Defined in: [core/coreFeatures.ts:12](https://github.com/TanStack/table/blob/mai ### coreHeadersFeature? ```ts -optional coreHeadersFeature: TableFeature>; +optional coreHeadersFeature: TableFeature; ``` Defined in: [core/coreFeatures.ts:13](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/coreFeatures.ts#L13) @@ -184,7 +184,7 @@ Defined in: [core/coreFeatures.ts:10](https://github.com/TanStack/table/blob/mai ### coreRowModelsFeature? ```ts -optional coreRowModelsFeature: TableFeature>; +optional coreRowModelsFeature: TableFeature; ``` Defined in: [core/coreFeatures.ts:14](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/coreFeatures.ts#L14) @@ -198,7 +198,7 @@ Defined in: [core/coreFeatures.ts:14](https://github.com/TanStack/table/blob/mai ### coreRowsFeature? ```ts -optional coreRowsFeature: TableFeature>; +optional coreRowsFeature: TableFeature; ``` Defined in: [core/coreFeatures.ts:15](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/coreFeatures.ts#L15) @@ -212,7 +212,7 @@ Defined in: [core/coreFeatures.ts:15](https://github.com/TanStack/table/blob/mai ### coreTablesFeature? ```ts -optional coreTablesFeature: TableFeature>; +optional coreTablesFeature: TableFeature; ``` Defined in: [core/coreFeatures.ts:16](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/coreFeatures.ts#L16) @@ -226,7 +226,7 @@ Defined in: [core/coreFeatures.ts:16](https://github.com/TanStack/table/blob/mai ### globalFilteringFeature? ```ts -optional globalFilteringFeature: TableFeature>; +optional globalFilteringFeature: TableFeature; ``` Defined in: [features/stockFeatures.ts:25](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/stockFeatures.ts#L25) @@ -240,7 +240,7 @@ Defined in: [features/stockFeatures.ts:25](https://github.com/TanStack/table/blo ### rowExpandingFeature? ```ts -optional rowExpandingFeature: TableFeature>; +optional rowExpandingFeature: TableFeature; ``` Defined in: [features/stockFeatures.ts:26](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/stockFeatures.ts#L26) @@ -254,7 +254,7 @@ Defined in: [features/stockFeatures.ts:26](https://github.com/TanStack/table/blo ### rowPaginationFeature? ```ts -optional rowPaginationFeature: TableFeature>; +optional rowPaginationFeature: TableFeature; ``` Defined in: [features/stockFeatures.ts:27](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/stockFeatures.ts#L27) @@ -268,7 +268,7 @@ Defined in: [features/stockFeatures.ts:27](https://github.com/TanStack/table/blo ### rowPinningFeature? ```ts -optional rowPinningFeature: TableFeature>; +optional rowPinningFeature: TableFeature; ``` Defined in: [features/stockFeatures.ts:28](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/stockFeatures.ts#L28) @@ -282,7 +282,7 @@ Defined in: [features/stockFeatures.ts:28](https://github.com/TanStack/table/blo ### rowSelectionFeature? ```ts -optional rowSelectionFeature: TableFeature>; +optional rowSelectionFeature: TableFeature; ``` Defined in: [features/stockFeatures.ts:29](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/stockFeatures.ts#L29) @@ -296,7 +296,7 @@ Defined in: [features/stockFeatures.ts:29](https://github.com/TanStack/table/blo ### rowSortingFeature? ```ts -optional rowSortingFeature: TableFeature>; +optional rowSortingFeature: TableFeature; ``` Defined in: [features/stockFeatures.ts:30](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/stockFeatures.ts#L30) diff --git a/docs/reference/index/interfaces/TableOptions_Core.md b/docs/reference/index/interfaces/TableOptions_Core.md index 58197da06e..fa395ac744 100644 --- a/docs/reference/index/interfaces/TableOptions_Core.md +++ b/docs/reference/index/interfaces/TableOptions_Core.md @@ -5,7 +5,7 @@ title: TableOptions_Core # Interface: TableOptions\_Core\ -Defined in: [types/TableOptions.ts:31](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableOptions.ts#L31) +Defined in: [types/TableOptions.ts:26](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableOptions.ts#L26) Core options that are always available on a table, before optional feature options are mixed in. @@ -26,46 +26,10 @@ options are mixed in. ## Properties -### \features - -```ts -readonly features: TFeatures; -``` - -Defined in: [core/table/coreTablesFeature.types.ts:74](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/table/coreTablesFeature.types.ts#L74) - -The feature modules registered on this table instance. - -Feature registration controls which state slices, options, and prototype -APIs are available. - -#### Inherited from - -[`TableOptions_Table`](TableOptions_Table.md).[`features`](TableOptions_Table.md#features) - -*** - -### \rowModels? - -```ts -readonly optional rowModels: CreateRowModels_All; -``` - -Defined in: [core/table/coreTablesFeature.types.ts:79](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/table/coreTablesFeature.types.ts#L79) - -Row model factories used by features such as filtering, grouping, sorting, -expansion, and pagination. - -#### Inherited from - -[`TableOptions_Table`](TableOptions_Table.md).[`rowModels`](TableOptions_Table.md#_rowmodels) - -*** - ### atoms? ```ts -readonly optional atoms: Partial<{ [K in string | number | symbol]: Atom[K]> }>; +readonly optional atoms: Partial<{ [K in string | number | symbol]: Atom[K]> }>; ``` Defined in: [core/table/coreTablesFeature.types.ts:87](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/table/coreTablesFeature.types.ts#L87) @@ -146,6 +110,25 @@ Default column options to use for all column defs supplied to the table. *** +### features + +```ts +readonly features: TFeatures; +``` + +Defined in: [core/table/coreTablesFeature.types.ts:74](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/table/coreTablesFeature.types.ts#L74) + +The feature modules registered on this table instance. + +Feature registration controls which state slices, options, and prototype +APIs are available. + +#### Inherited from + +[`TableOptions_Table`](TableOptions_Table.md).[`features`](TableOptions_Table.md#features) + +*** + ### getRowId()? ```ts @@ -225,7 +208,7 @@ getSubRows: row => row.subRows ### initialState? ```ts -readonly optional initialState: Partial>; +readonly optional initialState: Partial>; ``` Defined in: [core/table/coreTablesFeature.types.ts:109](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/table/coreTablesFeature.types.ts#L109) @@ -322,10 +305,27 @@ Value used when the desired value is not found in the data. *** +### rowModels? + +```ts +readonly optional rowModels: CreateRowModels_All; +``` + +Defined in: [core/table/coreTablesFeature.types.ts:79](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/table/coreTablesFeature.types.ts#L79) + +Row model factories used by features such as filtering, grouping, sorting, +expansion, and pagination. + +#### Inherited from + +[`TableOptions_Table`](TableOptions_Table.md).[`rowModels`](TableOptions_Table.md#rowmodels) + +*** + ### state? ```ts -readonly optional state: Partial>; +readonly optional state: Partial>; ``` Defined in: [core/table/coreTablesFeature.types.ts:128](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/table/coreTablesFeature.types.ts#L128) diff --git a/docs/reference/index/interfaces/TableOptions_FeatureMap.md b/docs/reference/index/interfaces/TableOptions_FeatureMap.md new file mode 100644 index 0000000000..11dd958b71 --- /dev/null +++ b/docs/reference/index/interfaces/TableOptions_FeatureMap.md @@ -0,0 +1,148 @@ +--- +id: TableOptions_FeatureMap +title: TableOptions_FeatureMap +--- + +# Interface: TableOptions\_FeatureMap\ + +Defined in: [types/TableOptions.ts:50](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableOptions.ts#L50) + +## Type Parameters + +### TFeatures + +`TFeatures` *extends* [`TableFeatures`](TableFeatures.md) + +### TData + +`TData` *extends* [`RowData`](../type-aliases/RowData.md) + +## Properties + +### columnFilteringFeature + +```ts +columnFilteringFeature: TableOptions_ColumnFiltering; +``` + +Defined in: [types/TableOptions.ts:54](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableOptions.ts#L54) + +*** + +### columnGroupingFeature + +```ts +columnGroupingFeature: TableOptions_ColumnGrouping; +``` + +Defined in: [types/TableOptions.ts:55](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableOptions.ts#L55) + +*** + +### columnOrderingFeature + +```ts +columnOrderingFeature: TableOptions_ColumnOrdering; +``` + +Defined in: [types/TableOptions.ts:56](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableOptions.ts#L56) + +*** + +### columnPinningFeature + +```ts +columnPinningFeature: TableOptions_ColumnPinning; +``` + +Defined in: [types/TableOptions.ts:57](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableOptions.ts#L57) + +*** + +### columnResizingFeature + +```ts +columnResizingFeature: TableOptions_ColumnResizing; +``` + +Defined in: [types/TableOptions.ts:58](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableOptions.ts#L58) + +*** + +### columnSizingFeature + +```ts +columnSizingFeature: TableOptions_ColumnSizing; +``` + +Defined in: [types/TableOptions.ts:59](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableOptions.ts#L59) + +*** + +### columnVisibilityFeature + +```ts +columnVisibilityFeature: TableOptions_ColumnVisibility; +``` + +Defined in: [types/TableOptions.ts:60](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableOptions.ts#L60) + +*** + +### globalFilteringFeature + +```ts +globalFilteringFeature: TableOptions_GlobalFiltering; +``` + +Defined in: [types/TableOptions.ts:61](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableOptions.ts#L61) + +*** + +### rowExpandingFeature + +```ts +rowExpandingFeature: TableOptions_RowExpanding; +``` + +Defined in: [types/TableOptions.ts:62](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableOptions.ts#L62) + +*** + +### rowPaginationFeature + +```ts +rowPaginationFeature: TableOptions_RowPagination; +``` + +Defined in: [types/TableOptions.ts:63](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableOptions.ts#L63) + +*** + +### rowPinningFeature + +```ts +rowPinningFeature: TableOptions_RowPinning; +``` + +Defined in: [types/TableOptions.ts:64](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableOptions.ts#L64) + +*** + +### rowSelectionFeature + +```ts +rowSelectionFeature: TableOptions_RowSelection; +``` + +Defined in: [types/TableOptions.ts:65](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableOptions.ts#L65) + +*** + +### rowSortingFeature + +```ts +rowSortingFeature: TableOptions_RowSorting; +``` + +Defined in: [types/TableOptions.ts:66](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableOptions.ts#L66) diff --git a/docs/reference/index/interfaces/TableOptions_Plugins.md b/docs/reference/index/interfaces/TableOptions_Plugins.md deleted file mode 100644 index a5efa5289b..0000000000 --- a/docs/reference/index/interfaces/TableOptions_Plugins.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -id: TableOptions_Plugins -title: TableOptions_Plugins ---- - -# Interface: TableOptions\_Plugins\ - -Defined in: [types/TableOptions.ts:22](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableOptions.ts#L22) - -## Type Parameters - -### TFeatures - -`TFeatures` *extends* [`TableFeatures`](TableFeatures.md) - -### TData - -`TData` *extends* [`RowData`](../type-aliases/RowData.md) diff --git a/docs/reference/index/interfaces/TableOptions_Table.md b/docs/reference/index/interfaces/TableOptions_Table.md index 22e2312645..0d93748272 100644 --- a/docs/reference/index/interfaces/TableOptions_Table.md +++ b/docs/reference/index/interfaces/TableOptions_Table.md @@ -23,38 +23,10 @@ Defined in: [core/table/coreTablesFeature.types.ts:64](https://github.com/TanSta ## Properties -### \features - -```ts -readonly features: TFeatures; -``` - -Defined in: [core/table/coreTablesFeature.types.ts:74](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/table/coreTablesFeature.types.ts#L74) - -The feature modules registered on this table instance. - -Feature registration controls which state slices, options, and prototype -APIs are available. - -*** - -### \rowModels? - -```ts -readonly optional rowModels: CreateRowModels_All; -``` - -Defined in: [core/table/coreTablesFeature.types.ts:79](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/table/coreTablesFeature.types.ts#L79) - -Row model factories used by features such as filtering, grouping, sorting, -expansion, and pagination. - -*** - ### atoms? ```ts -readonly optional atoms: Partial<{ [K in string | number | symbol]: Atom[K]> }>; +readonly optional atoms: Partial<{ [K in string | number | symbol]: Atom[K]> }>; ``` Defined in: [core/table/coreTablesFeature.types.ts:87](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/table/coreTablesFeature.types.ts#L87) @@ -91,10 +63,25 @@ The data for the table to display. When the `data` option changes reference, the *** +### features + +```ts +readonly features: TFeatures; +``` + +Defined in: [core/table/coreTablesFeature.types.ts:74](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/table/coreTablesFeature.types.ts#L74) + +The feature modules registered on this table instance. + +Feature registration controls which state slices, options, and prototype +APIs are available. + +*** + ### initialState? ```ts -readonly optional initialState: Partial>; +readonly optional initialState: Partial>; ``` Defined in: [core/table/coreTablesFeature.types.ts:109](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/table/coreTablesFeature.types.ts#L109) @@ -159,10 +146,23 @@ You can pass any object to `options.meta` and access it anywhere the `table` is *** +### rowModels? + +```ts +readonly optional rowModels: CreateRowModels_All; +``` + +Defined in: [core/table/coreTablesFeature.types.ts:79](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/table/coreTablesFeature.types.ts#L79) + +Row model factories used by features such as filtering, grouping, sorting, +expansion, and pagination. + +*** + ### state? ```ts -readonly optional state: Partial>; +readonly optional state: Partial>; ``` Defined in: [core/table/coreTablesFeature.types.ts:128](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/table/coreTablesFeature.types.ts#L128) diff --git a/docs/reference/index/interfaces/TableState_FeatureMap.md b/docs/reference/index/interfaces/TableState_FeatureMap.md new file mode 100644 index 0000000000..822e77a01b --- /dev/null +++ b/docs/reference/index/interfaces/TableState_FeatureMap.md @@ -0,0 +1,138 @@ +--- +id: TableState_FeatureMap +title: TableState_FeatureMap +--- + +# Interface: TableState\_FeatureMap + +Defined in: [types/TableState.ts:16](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableState.ts#L16) + +## Properties + +### columnFilteringFeature + +```ts +columnFilteringFeature: TableState_ColumnFiltering; +``` + +Defined in: [types/TableState.ts:17](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableState.ts#L17) + +*** + +### columnGroupingFeature + +```ts +columnGroupingFeature: TableState_ColumnGrouping; +``` + +Defined in: [types/TableState.ts:18](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableState.ts#L18) + +*** + +### columnOrderingFeature + +```ts +columnOrderingFeature: TableState_ColumnOrdering; +``` + +Defined in: [types/TableState.ts:19](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableState.ts#L19) + +*** + +### columnPinningFeature + +```ts +columnPinningFeature: TableState_ColumnPinning; +``` + +Defined in: [types/TableState.ts:20](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableState.ts#L20) + +*** + +### columnResizingFeature + +```ts +columnResizingFeature: TableState_ColumnResizing; +``` + +Defined in: [types/TableState.ts:21](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableState.ts#L21) + +*** + +### columnSizingFeature + +```ts +columnSizingFeature: TableState_ColumnSizing; +``` + +Defined in: [types/TableState.ts:22](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableState.ts#L22) + +*** + +### columnVisibilityFeature + +```ts +columnVisibilityFeature: TableState_ColumnVisibility; +``` + +Defined in: [types/TableState.ts:23](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableState.ts#L23) + +*** + +### globalFilteringFeature + +```ts +globalFilteringFeature: TableState_GlobalFiltering; +``` + +Defined in: [types/TableState.ts:24](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableState.ts#L24) + +*** + +### rowExpandingFeature + +```ts +rowExpandingFeature: TableState_RowExpanding; +``` + +Defined in: [types/TableState.ts:25](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableState.ts#L25) + +*** + +### rowPaginationFeature + +```ts +rowPaginationFeature: TableState_RowPagination; +``` + +Defined in: [types/TableState.ts:26](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableState.ts#L26) + +*** + +### rowPinningFeature + +```ts +rowPinningFeature: TableState_RowPinning; +``` + +Defined in: [types/TableState.ts:27](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableState.ts#L27) + +*** + +### rowSelectionFeature + +```ts +rowSelectionFeature: TableState_RowSelection; +``` + +Defined in: [types/TableState.ts:28](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableState.ts#L28) + +*** + +### rowSortingFeature + +```ts +rowSortingFeature: TableState_RowSorting; +``` + +Defined in: [types/TableState.ts:29](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableState.ts#L29) diff --git a/docs/reference/index/interfaces/TableState_Plugins.md b/docs/reference/index/interfaces/TableState_Plugins.md deleted file mode 100644 index ba298669ee..0000000000 --- a/docs/reference/index/interfaces/TableState_Plugins.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -id: TableState_Plugins -title: TableState_Plugins ---- - -# Interface: TableState\_Plugins\ - -Defined in: [types/TableState.ts:21](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableState.ts#L21) - -Use this interface as a target for declaration merging to add your own state properties. -Note: This will affect the types of all tables in your project. - -## Type Parameters - -### TFeatures - -`TFeatures` *extends* [`TableFeatures`](TableFeatures.md) diff --git a/docs/reference/index/interfaces/Table_CoreProperties.md b/docs/reference/index/interfaces/Table_CoreProperties.md index 8873bfa232..25b9d5e7ad 100644 --- a/docs/reference/index/interfaces/Table_CoreProperties.md +++ b/docs/reference/index/interfaces/Table_CoreProperties.md @@ -47,10 +47,10 @@ Prototype cache for Column objects - shared by all columns in this table *** -### \features +### \_features ```ts -readonly features: Partial & TFeatures; +readonly _features: Partial & TFeatures; ``` Defined in: [core/table/coreTablesFeature.types.ts:150](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/table/coreTablesFeature.types.ts#L150) @@ -95,10 +95,10 @@ The row model processing functions that are used to process the data by features *** -### \rowModels +### \_rowModels ```ts -readonly rowModels: CachedRowModels; +readonly _rowModels: CachedRowModels; ``` Defined in: [core/table/coreTablesFeature.types.ts:162](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/table/coreTablesFeature.types.ts#L162) @@ -149,7 +149,7 @@ single write surface — all state mutations from features land here. ### initialState ```ts -readonly initialState: TableState; +readonly initialState: ExtractFeatureMapTypes; ``` Defined in: [core/table/coreTablesFeature.types.ts:181](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/table/coreTablesFeature.types.ts#L181) @@ -187,7 +187,7 @@ options as plain resolved data instead of backing them with an atom. ### store ```ts -readonly store: ReadonlyStore>; +readonly store: ReadonlyStore>; ``` Defined in: [core/table/coreTablesFeature.types.ts:196](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/table/coreTablesFeature.types.ts#L196) diff --git a/docs/reference/index/interfaces/Table_FeatureMap.md b/docs/reference/index/interfaces/Table_FeatureMap.md new file mode 100644 index 0000000000..80ea413fac --- /dev/null +++ b/docs/reference/index/interfaces/Table_FeatureMap.md @@ -0,0 +1,158 @@ +--- +id: Table_FeatureMap +title: Table_FeatureMap +--- + +# Interface: Table\_FeatureMap\ + +Defined in: [types/Table.ts:46](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/Table.ts#L46) + +## Type Parameters + +### TFeatures + +`TFeatures` *extends* [`TableFeatures`](TableFeatures.md) + +### TData + +`TData` *extends* [`RowData`](../type-aliases/RowData.md) + +## Properties + +### columnFacetingFeature + +```ts +columnFacetingFeature: Table_ColumnFaceting; +``` + +Defined in: [types/Table.ts:57](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/Table.ts#L57) + +*** + +### columnFilteringFeature + +```ts +columnFilteringFeature: Table_ColumnFiltering; +``` + +Defined in: [types/Table.ts:50](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/Table.ts#L50) + +*** + +### columnGroupingFeature + +```ts +columnGroupingFeature: Table_ColumnGrouping; +``` + +Defined in: [types/Table.ts:51](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/Table.ts#L51) + +*** + +### columnOrderingFeature + +```ts +columnOrderingFeature: Table_ColumnOrdering; +``` + +Defined in: [types/Table.ts:52](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/Table.ts#L52) + +*** + +### columnPinningFeature + +```ts +columnPinningFeature: Table_ColumnPinning; +``` + +Defined in: [types/Table.ts:53](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/Table.ts#L53) + +*** + +### columnResizingFeature + +```ts +columnResizingFeature: Table_ColumnResizing; +``` + +Defined in: [types/Table.ts:54](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/Table.ts#L54) + +*** + +### columnSizingFeature + +```ts +columnSizingFeature: Table_ColumnSizing; +``` + +Defined in: [types/Table.ts:55](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/Table.ts#L55) + +*** + +### columnVisibilityFeature + +```ts +columnVisibilityFeature: Table_ColumnVisibility; +``` + +Defined in: [types/Table.ts:56](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/Table.ts#L56) + +*** + +### globalFilteringFeature + +```ts +globalFilteringFeature: Table_GlobalFiltering; +``` + +Defined in: [types/Table.ts:58](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/Table.ts#L58) + +*** + +### rowExpandingFeature + +```ts +rowExpandingFeature: Table_RowExpanding; +``` + +Defined in: [types/Table.ts:59](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/Table.ts#L59) + +*** + +### rowPaginationFeature + +```ts +rowPaginationFeature: Table_RowPagination; +``` + +Defined in: [types/Table.ts:60](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/Table.ts#L60) + +*** + +### rowPinningFeature + +```ts +rowPinningFeature: Table_RowPinning; +``` + +Defined in: [types/Table.ts:61](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/Table.ts#L61) + +*** + +### rowSelectionFeature + +```ts +rowSelectionFeature: Table_RowSelection; +``` + +Defined in: [types/Table.ts:62](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/Table.ts#L62) + +*** + +### rowSortingFeature + +```ts +rowSortingFeature: Table_RowSorting; +``` + +Defined in: [types/Table.ts:63](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/Table.ts#L63) diff --git a/docs/reference/index/interfaces/Table_Plugins.md b/docs/reference/index/interfaces/Table_Plugins.md deleted file mode 100644 index 874bd90101..0000000000 --- a/docs/reference/index/interfaces/Table_Plugins.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -id: Table_Plugins -title: Table_Plugins ---- - -# Interface: Table\_Plugins\ - -Defined in: [types/Table.ts:37](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/Table.ts#L37) - -Use this interface as a target for declaration merging to add your own plugin properties. -Note: This will affect the types of all tables in your project. - -## Type Parameters - -### TFeatures - -`TFeatures` *extends* [`TableFeatures`](TableFeatures.md) - -### TData - -`TData` *extends* [`RowData`](../type-aliases/RowData.md) diff --git a/docs/reference/index/interfaces/Table_RowModels_Core.md b/docs/reference/index/interfaces/Table_RowModels_Core.md index 0c6263a8b7..eab1d727a8 100644 --- a/docs/reference/index/interfaces/Table_RowModels_Core.md +++ b/docs/reference/index/interfaces/Table_RowModels_Core.md @@ -5,7 +5,7 @@ title: Table_RowModels_Core # Interface: Table\_RowModels\_Core\ -Defined in: [core/row-models/coreRowModelsFeature.types.ts:45](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/row-models/coreRowModelsFeature.types.ts#L45) +Defined in: [core/row-models/coreRowModelsFeature.types.ts:41](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/row-models/coreRowModelsFeature.types.ts#L41) ## Type Parameters @@ -25,7 +25,7 @@ Defined in: [core/row-models/coreRowModelsFeature.types.ts:45](https://github.co getCoreRowModel: () => RowModel; ``` -Defined in: [core/row-models/coreRowModelsFeature.types.ts:52](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/row-models/coreRowModelsFeature.types.ts#L52) +Defined in: [core/row-models/coreRowModelsFeature.types.ts:48](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/row-models/coreRowModelsFeature.types.ts#L48) Returns the core row model before any processing has been applied. @@ -41,7 +41,7 @@ Returns the core row model before any processing has been applied. getRowModel: () => RowModel; ``` -Defined in: [core/row-models/coreRowModelsFeature.types.ts:56](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/row-models/coreRowModelsFeature.types.ts#L56) +Defined in: [core/row-models/coreRowModelsFeature.types.ts:52](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/row-models/coreRowModelsFeature.types.ts#L52) Returns the final model after all processing from other used features has been applied. This is the row model that is most commonly used for rendering. diff --git a/docs/reference/index/interfaces/Table_Table.md b/docs/reference/index/interfaces/Table_Table.md index bdc24eabcb..5891a3361b 100644 --- a/docs/reference/index/interfaces/Table_Table.md +++ b/docs/reference/index/interfaces/Table_Table.md @@ -55,10 +55,10 @@ Prototype cache for Column objects - shared by all columns in this table *** -### \features +### \_features ```ts -readonly features: Partial & TFeatures; +readonly _features: Partial & TFeatures; ``` Defined in: [core/table/coreTablesFeature.types.ts:150](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/table/coreTablesFeature.types.ts#L150) @@ -67,7 +67,7 @@ The features that are enabled for the table. #### Inherited from -[`Table_CoreProperties`](Table_CoreProperties.md).[`features`](Table_CoreProperties.md#features) +[`Table_CoreProperties`](Table_CoreProperties.md).[`_features`](Table_CoreProperties.md#_features) *** @@ -119,10 +119,10 @@ The row model processing functions that are used to process the data by features *** -### \rowModels +### \_rowModels ```ts -readonly rowModels: CachedRowModels; +readonly _rowModels: CachedRowModels; ``` Defined in: [core/table/coreTablesFeature.types.ts:162](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/table/coreTablesFeature.types.ts#L162) @@ -131,7 +131,7 @@ The row models that are enabled for the table. #### Inherited from -[`Table_CoreProperties`](Table_CoreProperties.md).[`rowModels`](Table_CoreProperties.md#_rowmodels) +[`Table_CoreProperties`](Table_CoreProperties.md).[`_rowModels`](Table_CoreProperties.md#_rowmodels) *** @@ -189,7 +189,7 @@ single write surface — all state mutations from features land here. ### initialState ```ts -readonly initialState: TableState; +readonly initialState: ExtractFeatureMapTypes; ``` Defined in: [core/table/coreTablesFeature.types.ts:181](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/table/coreTablesFeature.types.ts#L181) @@ -282,7 +282,7 @@ resolved options and then merging them through `options.mergeOptions`. ### store ```ts -readonly store: ReadonlyStore>; +readonly store: ReadonlyStore>; ``` Defined in: [core/table/coreTablesFeature.types.ts:196](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/table/coreTablesFeature.types.ts#L196) diff --git a/docs/reference/index/namespaces/filterFn_arrIncludes/functions/autoRemove.md b/docs/reference/index/namespaces/filterFn_arrIncludes/functions/autoRemove.md deleted file mode 100644 index b1b4ad9db1..0000000000 --- a/docs/reference/index/namespaces/filterFn_arrIncludes/functions/autoRemove.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -id: autoRemove -title: autoRemove ---- - -# Function: autoRemove() - -```ts -function autoRemove(val): boolean; -``` - -Defined in: [fns/filterFns.ts:347](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/filterFns.ts#L347) - -## Parameters - -### val - -`any` - -## Returns - -`boolean` diff --git a/docs/reference/index/namespaces/filterFn_arrIncludes/index.md b/docs/reference/index/namespaces/filterFn_arrIncludes/index.md deleted file mode 100644 index f264a1195e..0000000000 --- a/docs/reference/index/namespaces/filterFn_arrIncludes/index.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -id: filterFn_arrIncludes -title: filterFn_arrIncludes ---- - -# filterFn\_arrIncludes - -Keeps rows whose array or string column value includes at least one filter value. - -## Functions - -- [autoRemove](functions/autoRemove.md) diff --git a/docs/reference/index/namespaces/filterFn_arrIncludesAll/functions/autoRemove.md b/docs/reference/index/namespaces/filterFn_arrIncludesAll/functions/autoRemove.md deleted file mode 100644 index 7385f140d1..0000000000 --- a/docs/reference/index/namespaces/filterFn_arrIncludesAll/functions/autoRemove.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -id: autoRemove -title: autoRemove ---- - -# Function: autoRemove() - -```ts -function autoRemove(val): boolean; -``` - -Defined in: [fns/filterFns.ts:365](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/filterFns.ts#L365) - -## Parameters - -### val - -`any` - -## Returns - -`boolean` diff --git a/docs/reference/index/namespaces/filterFn_arrIncludesAll/index.md b/docs/reference/index/namespaces/filterFn_arrIncludesAll/index.md deleted file mode 100644 index 6fdafc67f4..0000000000 --- a/docs/reference/index/namespaces/filterFn_arrIncludesAll/index.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -id: filterFn_arrIncludesAll -title: filterFn_arrIncludesAll ---- - -# filterFn\_arrIncludesAll - -Keeps rows whose array column value includes every filter value. - -## Functions - -- [autoRemove](functions/autoRemove.md) diff --git a/docs/reference/index/namespaces/filterFn_arrIncludesSome/functions/autoRemove.md b/docs/reference/index/namespaces/filterFn_arrIncludesSome/functions/autoRemove.md deleted file mode 100644 index bd268d2f60..0000000000 --- a/docs/reference/index/namespaces/filterFn_arrIncludesSome/functions/autoRemove.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -id: autoRemove -title: autoRemove ---- - -# Function: autoRemove() - -```ts -function autoRemove(val): boolean; -``` - -Defined in: [fns/filterFns.ts:384](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/filterFns.ts#L384) - -## Parameters - -### val - -`any` - -## Returns - -`boolean` diff --git a/docs/reference/index/namespaces/filterFn_arrIncludesSome/index.md b/docs/reference/index/namespaces/filterFn_arrIncludesSome/index.md deleted file mode 100644 index f618b4a6ac..0000000000 --- a/docs/reference/index/namespaces/filterFn_arrIncludesSome/index.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -id: filterFn_arrIncludesSome -title: filterFn_arrIncludesSome ---- - -# filterFn\_arrIncludesSome - -Keeps rows whose array column value includes at least one filter value. - -## Functions - -- [autoRemove](functions/autoRemove.md) diff --git a/docs/reference/index/namespaces/filterFn_equals/functions/autoRemove.md b/docs/reference/index/namespaces/filterFn_equals/functions/autoRemove.md deleted file mode 100644 index d5835237a6..0000000000 --- a/docs/reference/index/namespaces/filterFn_equals/functions/autoRemove.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -id: autoRemove -title: autoRemove ---- - -# Function: autoRemove() - -```ts -function autoRemove(val): boolean; -``` - -Defined in: [fns/filterFns.ts:24](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/filterFns.ts#L24) - -## Parameters - -### val - -`any` - -## Returns - -`boolean` diff --git a/docs/reference/index/namespaces/filterFn_equals/index.md b/docs/reference/index/namespaces/filterFn_equals/index.md deleted file mode 100644 index a3fc48e8b7..0000000000 --- a/docs/reference/index/namespaces/filterFn_equals/index.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -id: filterFn_equals -title: filterFn_equals ---- - -# filterFn\_equals - -Keeps rows whose column value is strictly equal to the filter value. - -Uses JavaScript `===` comparison and auto-removes empty filter values. - -## Functions - -- [autoRemove](functions/autoRemove.md) diff --git a/docs/reference/index/namespaces/filterFn_equalsString/functions/autoRemove.md b/docs/reference/index/namespaces/filterFn_equalsString/functions/autoRemove.md deleted file mode 100644 index d3198260a1..0000000000 --- a/docs/reference/index/namespaces/filterFn_equalsString/functions/autoRemove.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -id: autoRemove -title: autoRemove ---- - -# Function: autoRemove() - -```ts -function autoRemove(val): boolean; -``` - -Defined in: [fns/filterFns.ts:112](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/filterFns.ts#L112) - -## Parameters - -### val - -`any` - -## Returns - -`boolean` diff --git a/docs/reference/index/namespaces/filterFn_equalsString/index.md b/docs/reference/index/namespaces/filterFn_equalsString/index.md deleted file mode 100644 index 3390f1eb16..0000000000 --- a/docs/reference/index/namespaces/filterFn_equalsString/index.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -id: filterFn_equalsString -title: filterFn_equalsString ---- - -# filterFn\_equalsString - -Keeps rows whose stringified column value equals the filter text. - -Both values are lowercased before comparison, and empty filter values are -auto-removed. - -## Functions - -- [autoRemove](functions/autoRemove.md) diff --git a/docs/reference/index/namespaces/filterFn_equalsStringSensitive/functions/autoRemove.md b/docs/reference/index/namespaces/filterFn_equalsStringSensitive/functions/autoRemove.md deleted file mode 100644 index 3cea653817..0000000000 --- a/docs/reference/index/namespaces/filterFn_equalsStringSensitive/functions/autoRemove.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -id: autoRemove -title: autoRemove ---- - -# Function: autoRemove() - -```ts -function autoRemove(val): boolean; -``` - -Defined in: [fns/filterFns.ts:130](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/filterFns.ts#L130) - -## Parameters - -### val - -`any` - -## Returns - -`boolean` diff --git a/docs/reference/index/namespaces/filterFn_equalsStringSensitive/index.md b/docs/reference/index/namespaces/filterFn_equalsStringSensitive/index.md deleted file mode 100644 index de98608f7e..0000000000 --- a/docs/reference/index/namespaces/filterFn_equalsStringSensitive/index.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -id: filterFn_equalsStringSensitive -title: filterFn_equalsStringSensitive ---- - -# filterFn\_equalsStringSensitive - -Keeps rows whose stringified column value exactly equals the filter text. - -Matching is case-sensitive and empty filter values are auto-removed. - -## Functions - -- [autoRemove](functions/autoRemove.md) diff --git a/docs/reference/index/namespaces/filterFn_greaterThan/functions/resolveFilterValue.md b/docs/reference/index/namespaces/filterFn_greaterThan/functions/resolveFilterValue.md deleted file mode 100644 index 20f8485a8a..0000000000 --- a/docs/reference/index/namespaces/filterFn_greaterThan/functions/resolveFilterValue.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -id: resolveFilterValue -title: resolveFilterValue ---- - -# Function: resolveFilterValue() - -```ts -function resolveFilterValue(val): boolean; -``` - -Defined in: [fns/filterFns.ts:162](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/filterFns.ts#L162) - -## Parameters - -### val - -`any` - -## Returns - -`boolean` diff --git a/docs/reference/index/namespaces/filterFn_greaterThan/index.md b/docs/reference/index/namespaces/filterFn_greaterThan/index.md deleted file mode 100644 index 27952693aa..0000000000 --- a/docs/reference/index/namespaces/filterFn_greaterThan/index.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -id: filterFn_greaterThan -title: filterFn_greaterThan ---- - -# filterFn\_greaterThan - -Keeps rows whose value is greater than the filter value. - -Numeric values are compared numerically when both sides can be coerced to -numbers; otherwise normalized strings are compared. - -## Functions - -- [resolveFilterValue](functions/resolveFilterValue.md) diff --git a/docs/reference/index/namespaces/filterFn_greaterThanOrEqualTo/functions/resolveFilterValue.md b/docs/reference/index/namespaces/filterFn_greaterThanOrEqualTo/functions/resolveFilterValue.md deleted file mode 100644 index 663dc242be..0000000000 --- a/docs/reference/index/namespaces/filterFn_greaterThanOrEqualTo/functions/resolveFilterValue.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -id: resolveFilterValue -title: resolveFilterValue ---- - -# Function: resolveFilterValue() - -```ts -function resolveFilterValue(val): boolean; -``` - -Defined in: [fns/filterFns.ts:183](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/filterFns.ts#L183) - -## Parameters - -### val - -`any` - -## Returns - -`boolean` diff --git a/docs/reference/index/namespaces/filterFn_greaterThanOrEqualTo/index.md b/docs/reference/index/namespaces/filterFn_greaterThanOrEqualTo/index.md deleted file mode 100644 index baedbe45d3..0000000000 --- a/docs/reference/index/namespaces/filterFn_greaterThanOrEqualTo/index.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -id: filterFn_greaterThanOrEqualTo -title: filterFn_greaterThanOrEqualTo ---- - -# filterFn\_greaterThanOrEqualTo - -Keeps rows whose value is greater than or equal to the filter value. - -Delegates to the built-in greater-than and equality comparisons. - -## Functions - -- [resolveFilterValue](functions/resolveFilterValue.md) diff --git a/docs/reference/index/namespaces/filterFn_inNumberRange/functions/autoRemove.md b/docs/reference/index/namespaces/filterFn_inNumberRange/functions/autoRemove.md deleted file mode 100644 index 6f417972d4..0000000000 --- a/docs/reference/index/namespaces/filterFn_inNumberRange/functions/autoRemove.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -id: autoRemove -title: autoRemove ---- - -# Function: autoRemove() - -```ts -function autoRemove(val): boolean; -``` - -Defined in: [fns/filterFns.ts:310](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/filterFns.ts#L310) - -## Parameters - -### val - -`any` - -## Returns - -`boolean` diff --git a/docs/reference/index/namespaces/filterFn_inNumberRange/functions/resolveFilterValue.md b/docs/reference/index/namespaces/filterFn_inNumberRange/functions/resolveFilterValue.md deleted file mode 100644 index eec1ce38a9..0000000000 --- a/docs/reference/index/namespaces/filterFn_inNumberRange/functions/resolveFilterValue.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -id: resolveFilterValue -title: resolveFilterValue ---- - -# Function: resolveFilterValue() - -```ts -function resolveFilterValue(val): readonly [number, number]; -``` - -Defined in: [fns/filterFns.ts:289](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/filterFns.ts#L289) - -## Parameters - -### val - -\[`any`, `any`\] - -## Returns - -readonly \[`number`, `number`\] diff --git a/docs/reference/index/namespaces/filterFn_inNumberRange/index.md b/docs/reference/index/namespaces/filterFn_inNumberRange/index.md deleted file mode 100644 index e9931477b3..0000000000 --- a/docs/reference/index/namespaces/filterFn_inNumberRange/index.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -id: filterFn_inNumberRange -title: filterFn_inNumberRange ---- - -# filterFn\_inNumberRange - -Keeps rows whose numeric value is inside an inclusive `[min, max]` range. - -Filter values are normalized so blank endpoints become open-ended and -reversed endpoints are swapped. - -## Functions - -- [autoRemove](functions/autoRemove.md) -- [resolveFilterValue](functions/resolveFilterValue.md) diff --git a/docs/reference/index/namespaces/filterFn_includesString/functions/autoRemove.md b/docs/reference/index/namespaces/filterFn_includesString/functions/autoRemove.md deleted file mode 100644 index f33b2beab3..0000000000 --- a/docs/reference/index/namespaces/filterFn_includesString/functions/autoRemove.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -id: autoRemove -title: autoRemove ---- - -# Function: autoRemove() - -```ts -function autoRemove(val): boolean; -``` - -Defined in: [fns/filterFns.ts:90](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/filterFns.ts#L90) - -## Parameters - -### val - -`any` - -## Returns - -`boolean` diff --git a/docs/reference/index/namespaces/filterFn_includesString/index.md b/docs/reference/index/namespaces/filterFn_includesString/index.md deleted file mode 100644 index dc0a6524a9..0000000000 --- a/docs/reference/index/namespaces/filterFn_includesString/index.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -id: filterFn_includesString -title: filterFn_includesString ---- - -# filterFn\_includesString - -Keeps rows whose stringified column value includes the filter text. - -Both values are lowercased before comparison, and empty filter values are -auto-removed. - -## Functions - -- [autoRemove](functions/autoRemove.md) diff --git a/docs/reference/index/namespaces/filterFn_includesStringSensitive/functions/autoRemove.md b/docs/reference/index/namespaces/filterFn_includesStringSensitive/functions/autoRemove.md deleted file mode 100644 index 4928fe0fec..0000000000 --- a/docs/reference/index/namespaces/filterFn_includesStringSensitive/functions/autoRemove.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -id: autoRemove -title: autoRemove ---- - -# Function: autoRemove() - -```ts -function autoRemove(val): boolean; -``` - -Defined in: [fns/filterFns.ts:65](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/filterFns.ts#L65) - -## Parameters - -### val - -`any` - -## Returns - -`boolean` diff --git a/docs/reference/index/namespaces/filterFn_includesStringSensitive/index.md b/docs/reference/index/namespaces/filterFn_includesStringSensitive/index.md deleted file mode 100644 index faf0b836a1..0000000000 --- a/docs/reference/index/namespaces/filterFn_includesStringSensitive/index.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -id: filterFn_includesStringSensitive -title: filterFn_includesStringSensitive ---- - -# filterFn\_includesStringSensitive - -Keeps rows whose stringified column value includes the filter text. - -Matching is case-sensitive and empty filter values are auto-removed. - -## Functions - -- [autoRemove](functions/autoRemove.md) diff --git a/docs/reference/index/namespaces/filterFn_lessThan/functions/resolveFilterValue.md b/docs/reference/index/namespaces/filterFn_lessThan/functions/resolveFilterValue.md deleted file mode 100644 index 322022a5c6..0000000000 --- a/docs/reference/index/namespaces/filterFn_lessThan/functions/resolveFilterValue.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -id: resolveFilterValue -title: resolveFilterValue ---- - -# Function: resolveFilterValue() - -```ts -function resolveFilterValue(val): boolean; -``` - -Defined in: [fns/filterFns.ts:201](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/filterFns.ts#L201) - -## Parameters - -### val - -`any` - -## Returns - -`boolean` diff --git a/docs/reference/index/namespaces/filterFn_lessThan/index.md b/docs/reference/index/namespaces/filterFn_lessThan/index.md deleted file mode 100644 index 5e97188523..0000000000 --- a/docs/reference/index/namespaces/filterFn_lessThan/index.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -id: filterFn_lessThan -title: filterFn_lessThan ---- - -# filterFn\_lessThan - -Keeps rows whose value is less than the filter value. - -This is implemented as the inverse of greater-than-or-equal comparison. - -## Functions - -- [resolveFilterValue](functions/resolveFilterValue.md) diff --git a/docs/reference/index/namespaces/filterFn_lessThanOrEqualTo/functions/resolveFilterValue.md b/docs/reference/index/namespaces/filterFn_lessThanOrEqualTo/functions/resolveFilterValue.md deleted file mode 100644 index 0d19286d21..0000000000 --- a/docs/reference/index/namespaces/filterFn_lessThanOrEqualTo/functions/resolveFilterValue.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -id: resolveFilterValue -title: resolveFilterValue ---- - -# Function: resolveFilterValue() - -```ts -function resolveFilterValue(val): boolean; -``` - -Defined in: [fns/filterFns.ts:219](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/filterFns.ts#L219) - -## Parameters - -### val - -`any` - -## Returns - -`boolean` diff --git a/docs/reference/index/namespaces/filterFn_lessThanOrEqualTo/index.md b/docs/reference/index/namespaces/filterFn_lessThanOrEqualTo/index.md deleted file mode 100644 index 136109cf18..0000000000 --- a/docs/reference/index/namespaces/filterFn_lessThanOrEqualTo/index.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -id: filterFn_lessThanOrEqualTo -title: filterFn_lessThanOrEqualTo ---- - -# filterFn\_lessThanOrEqualTo - -Keeps rows whose value is less than or equal to the filter value. - -This is implemented as the inverse of greater-than comparison. - -## Functions - -- [resolveFilterValue](functions/resolveFilterValue.md) diff --git a/docs/reference/index/namespaces/filterFn_weakEquals/functions/autoRemove.md b/docs/reference/index/namespaces/filterFn_weakEquals/functions/autoRemove.md deleted file mode 100644 index 699748221e..0000000000 --- a/docs/reference/index/namespaces/filterFn_weakEquals/functions/autoRemove.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -id: autoRemove -title: autoRemove ---- - -# Function: autoRemove() - -```ts -function autoRemove(val): boolean; -``` - -Defined in: [fns/filterFns.ts:43](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/filterFns.ts#L43) - -## Parameters - -### val - -`any` - -## Returns - -`boolean` diff --git a/docs/reference/index/namespaces/filterFn_weakEquals/index.md b/docs/reference/index/namespaces/filterFn_weakEquals/index.md deleted file mode 100644 index 2c31596217..0000000000 --- a/docs/reference/index/namespaces/filterFn_weakEquals/index.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -id: filterFn_weakEquals -title: filterFn_weakEquals ---- - -# filterFn\_weakEquals - -Keeps rows whose column value is loosely equal to the filter value. - -Uses JavaScript `==` comparison and auto-removes empty filter values. This is -useful for matching string input against numeric row values. - -## Functions - -- [autoRemove](functions/autoRemove.md) diff --git a/docs/reference/index/type-aliases/AccessorColumnDef.md b/docs/reference/index/type-aliases/AccessorColumnDef.md index cc929db29b..e6d65c2759 100644 --- a/docs/reference/index/type-aliases/AccessorColumnDef.md +++ b/docs/reference/index/type-aliases/AccessorColumnDef.md @@ -11,7 +11,7 @@ type AccessorColumnDef = | AccessorFnColumnDef; ``` -Defined in: [types/ColumnDef.ts:232](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/ColumnDef.ts#L232) +Defined in: [types/ColumnDef.ts:205](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/ColumnDef.ts#L205) ## Type Parameters diff --git a/docs/reference/index/type-aliases/AccessorFn.md b/docs/reference/index/type-aliases/AccessorFn.md index 0999bace05..17453c7dae 100644 --- a/docs/reference/index/type-aliases/AccessorFn.md +++ b/docs/reference/index/type-aliases/AccessorFn.md @@ -9,7 +9,7 @@ title: AccessorFn type AccessorFn = (originalRow, index) => TValue; ``` -Defined in: [types/ColumnDef.ts:36](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/ColumnDef.ts#L36) +Defined in: [types/ColumnDef.ts:26](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/ColumnDef.ts#L26) Reads a cell value from an original row object. diff --git a/docs/reference/index/type-aliases/AccessorFnColumnDef.md b/docs/reference/index/type-aliases/AccessorFnColumnDef.md index a709444c94..dcaa254950 100644 --- a/docs/reference/index/type-aliases/AccessorFnColumnDef.md +++ b/docs/reference/index/type-aliases/AccessorFnColumnDef.md @@ -9,7 +9,7 @@ title: AccessorFnColumnDef type AccessorFnColumnDef = AccessorFnColumnDefBase & ColumnIdentifiers; ``` -Defined in: [types/ColumnDef.ts:209](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/ColumnDef.ts#L209) +Defined in: [types/ColumnDef.ts:182](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/ColumnDef.ts#L182) ## Type Parameters diff --git a/docs/reference/index/type-aliases/AccessorFnColumnDefBase.md b/docs/reference/index/type-aliases/AccessorFnColumnDefBase.md index 8d33754ce5..9ad4974391 100644 --- a/docs/reference/index/type-aliases/AccessorFnColumnDefBase.md +++ b/docs/reference/index/type-aliases/AccessorFnColumnDefBase.md @@ -9,7 +9,7 @@ title: AccessorFnColumnDefBase type AccessorFnColumnDefBase = ColumnDefBase & object; ``` -Defined in: [types/ColumnDef.ts:201](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/ColumnDef.ts#L201) +Defined in: [types/ColumnDef.ts:174](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/ColumnDef.ts#L174) ## Type Declaration diff --git a/docs/reference/index/type-aliases/AccessorKeyColumnDef.md b/docs/reference/index/type-aliases/AccessorKeyColumnDef.md index 09ecca041d..6f9aa8962c 100644 --- a/docs/reference/index/type-aliases/AccessorKeyColumnDef.md +++ b/docs/reference/index/type-aliases/AccessorKeyColumnDef.md @@ -9,7 +9,7 @@ title: AccessorKeyColumnDef type AccessorKeyColumnDef = AccessorKeyColumnDefBase & Partial>; ``` -Defined in: [types/ColumnDef.ts:225](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/ColumnDef.ts#L225) +Defined in: [types/ColumnDef.ts:198](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/ColumnDef.ts#L198) ## Type Parameters diff --git a/docs/reference/index/type-aliases/AccessorKeyColumnDefBase.md b/docs/reference/index/type-aliases/AccessorKeyColumnDefBase.md index 753ebe482a..6549325df6 100644 --- a/docs/reference/index/type-aliases/AccessorKeyColumnDefBase.md +++ b/docs/reference/index/type-aliases/AccessorKeyColumnDefBase.md @@ -9,7 +9,7 @@ title: AccessorKeyColumnDefBase type AccessorKeyColumnDefBase = ColumnDefBase & object; ``` -Defined in: [types/ColumnDef.ts:216](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/ColumnDef.ts#L216) +Defined in: [types/ColumnDef.ts:189](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/ColumnDef.ts#L189) ## Type Declaration diff --git a/docs/reference/index/type-aliases/AssignCellPrototype.md b/docs/reference/index/type-aliases/AssignCellPrototype.md deleted file mode 100644 index 181f147bee..0000000000 --- a/docs/reference/index/type-aliases/AssignCellPrototype.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: AssignCellPrototype -title: AssignCellPrototype ---- - -# Type Alias: AssignCellPrototype()\ - -```ts -type AssignCellPrototype = (prototype, table) => void; -``` - -Defined in: [types/TableFeatures.ts:77](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableFeatures.ts#L77) - -## Type Parameters - -### TConstructors - -`TConstructors` *extends* [`FeatureConstructors`](../interfaces/FeatureConstructors.md) - -## Type Parameters - -### TFeatures - -`TFeatures` *extends* [`TableFeatures`](../interfaces/TableFeatures.md) - -### TData - -`TData` *extends* [`RowData`](RowData.md) - -## Parameters - -### prototype - -`Record`\<`string`, `any`\> - -### table - -[`Table_Internal`](Table_Internal.md)\<`TFeatures`, `TData`\> - -## Returns - -`void` diff --git a/docs/reference/index/type-aliases/AssignColumnPrototype.md b/docs/reference/index/type-aliases/AssignColumnPrototype.md deleted file mode 100644 index 2e53e30e2b..0000000000 --- a/docs/reference/index/type-aliases/AssignColumnPrototype.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: AssignColumnPrototype -title: AssignColumnPrototype ---- - -# Type Alias: AssignColumnPrototype()\ - -```ts -type AssignColumnPrototype = (prototype, table) => void; -``` - -Defined in: [types/TableFeatures.ts:85](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableFeatures.ts#L85) - -## Type Parameters - -### TConstructors - -`TConstructors` *extends* [`FeatureConstructors`](../interfaces/FeatureConstructors.md) - -## Type Parameters - -### TFeatures - -`TFeatures` *extends* [`TableFeatures`](../interfaces/TableFeatures.md) - -### TData - -`TData` *extends* [`RowData`](RowData.md) - -## Parameters - -### prototype - -`Record`\<`string`, `any`\> - -### table - -[`Table_Internal`](Table_Internal.md)\<`TFeatures`, `TData`\> - -## Returns - -`void` diff --git a/docs/reference/index/type-aliases/AssignHeaderPrototype.md b/docs/reference/index/type-aliases/AssignHeaderPrototype.md deleted file mode 100644 index df90118eaa..0000000000 --- a/docs/reference/index/type-aliases/AssignHeaderPrototype.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: AssignHeaderPrototype -title: AssignHeaderPrototype ---- - -# Type Alias: AssignHeaderPrototype()\ - -```ts -type AssignHeaderPrototype = (prototype, table) => void; -``` - -Defined in: [types/TableFeatures.ts:93](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableFeatures.ts#L93) - -## Type Parameters - -### TConstructors - -`TConstructors` *extends* [`FeatureConstructors`](../interfaces/FeatureConstructors.md) - -## Type Parameters - -### TFeatures - -`TFeatures` *extends* [`TableFeatures`](../interfaces/TableFeatures.md) - -### TData - -`TData` *extends* [`RowData`](RowData.md) - -## Parameters - -### prototype - -`Record`\<`string`, `any`\> - -### table - -[`Table_Internal`](Table_Internal.md)\<`TFeatures`, `TData`\> - -## Returns - -`void` diff --git a/docs/reference/index/type-aliases/AssignRowPrototype.md b/docs/reference/index/type-aliases/AssignRowPrototype.md deleted file mode 100644 index 59035b7770..0000000000 --- a/docs/reference/index/type-aliases/AssignRowPrototype.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: AssignRowPrototype -title: AssignRowPrototype ---- - -# Type Alias: AssignRowPrototype()\ - -```ts -type AssignRowPrototype = (prototype, table) => void; -``` - -Defined in: [types/TableFeatures.ts:101](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableFeatures.ts#L101) - -## Type Parameters - -### TConstructors - -`TConstructors` *extends* [`FeatureConstructors`](../interfaces/FeatureConstructors.md) - -## Type Parameters - -### TFeatures - -`TFeatures` *extends* [`TableFeatures`](../interfaces/TableFeatures.md) - -### TData - -`TData` *extends* [`RowData`](RowData.md) - -## Parameters - -### prototype - -`Record`\<`string`, `any`\> - -### table - -[`Table_Internal`](Table_Internal.md)\<`TFeatures`, `TData`\> - -## Returns - -`void` diff --git a/docs/reference/index/type-aliases/BuiltInAggregationFn.md b/docs/reference/index/type-aliases/BuiltInAggregationFn.md index 9cac40ea13..478e4eccf3 100644 --- a/docs/reference/index/type-aliases/BuiltInAggregationFn.md +++ b/docs/reference/index/type-aliases/BuiltInAggregationFn.md @@ -9,4 +9,4 @@ title: BuiltInAggregationFn type BuiltInAggregationFn = keyof typeof aggregationFns; ``` -Defined in: [fns/aggregationFns.ts:261](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/aggregationFns.ts#L261) +Defined in: [fns/aggregationFns.ts:245](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/aggregationFns.ts#L245) diff --git a/docs/reference/index/type-aliases/BuiltInFilterFn.md b/docs/reference/index/type-aliases/BuiltInFilterFn.md index 6bc6ab09e5..ff6138ddb8 100644 --- a/docs/reference/index/type-aliases/BuiltInFilterFn.md +++ b/docs/reference/index/type-aliases/BuiltInFilterFn.md @@ -9,4 +9,4 @@ title: BuiltInFilterFn type BuiltInFilterFn = keyof typeof filterFns; ``` -Defined in: [fns/filterFns.ts:409](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/filterFns.ts#L409) +Defined in: [fns/filterFns.ts:376](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/filterFns.ts#L376) diff --git a/docs/reference/index/type-aliases/BuiltInSortFn.md b/docs/reference/index/type-aliases/BuiltInSortFn.md index e606d1d592..0417486e88 100644 --- a/docs/reference/index/type-aliases/BuiltInSortFn.md +++ b/docs/reference/index/type-aliases/BuiltInSortFn.md @@ -9,4 +9,4 @@ title: BuiltInSortFn type BuiltInSortFn = keyof typeof sortFns; ``` -Defined in: [fns/sortFns.ts:218](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/sortFns.ts#L218) +Defined in: [fns/sortFns.ts:217](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/sortFns.ts#L217) diff --git a/docs/reference/index/type-aliases/CachedRowModel_All.md b/docs/reference/index/type-aliases/CachedRowModel_All.md index 7c88b96722..3f903f83c1 100644 --- a/docs/reference/index/type-aliases/CachedRowModel_All.md +++ b/docs/reference/index/type-aliases/CachedRowModel_All.md @@ -9,7 +9,7 @@ title: CachedRowModel_All type CachedRowModel_All = Partial & CachedRowModel_Expanded & CachedRowModel_Faceted & CachedRowModel_Filtered & CachedRowModel_Grouped & CachedRowModel_Paginated & CachedRowModel_Sorted>; ``` -Defined in: [types/RowModel.ts:126](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/RowModel.ts#L126) +Defined in: [types/RowModel.ts:87](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/RowModel.ts#L87) ## Type Parameters diff --git a/docs/reference/index/type-aliases/CachedRowModels.md b/docs/reference/index/type-aliases/CachedRowModels.md index 346ef4da2f..1463563638 100644 --- a/docs/reference/index/type-aliases/CachedRowModels.md +++ b/docs/reference/index/type-aliases/CachedRowModels.md @@ -6,16 +6,10 @@ title: CachedRowModels # Type Alias: CachedRowModels\ ```ts -type CachedRowModels = object & UnionToIntersection< - | "columnFacetingFeature" extends keyof TFeatures ? CachedRowModel_Faceted : never - | "columnFilteringFeature" extends keyof TFeatures ? CachedRowModel_Filtered : never - | "rowExpandingFeature" extends keyof TFeatures ? CachedRowModel_Expanded : never - | "columnGroupingFeature" extends keyof TFeatures ? CachedRowModel_Grouped : never - | "rowPaginationFeature" extends keyof TFeatures ? CachedRowModel_Paginated : never -| "rowSortingFeature" extends keyof TFeatures ? CachedRowModel_Sorted : never> & ExtractFeatureTypes<"CachedRowModel", TFeatures> & CachedRowModels_Plugins; +type CachedRowModels = object & ExtractFeatureMapTypes>; ``` -Defined in: [types/RowModel.ts:92](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/RowModel.ts#L92) +Defined in: [types/RowModel.ts:77](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/RowModel.ts#L77) ## Type Declaration diff --git a/docs/reference/index/type-aliases/Cell.md b/docs/reference/index/type-aliases/Cell.md index d502b45063..52168082f7 100644 --- a/docs/reference/index/type-aliases/Cell.md +++ b/docs/reference/index/type-aliases/Cell.md @@ -6,10 +6,10 @@ title: Cell # Type Alias: Cell\ ```ts -type Cell = Cell_Cell & UnionToIntersection<"columnGroupingFeature" extends keyof TFeatures ? Cell_ColumnGrouping : never> & ExtractFeatureTypes<"Cell", TFeatures> & Cell_Plugins; +type Cell = Cell_Core & ExtractFeatureMapTypes; ``` -Defined in: [types/Cell.ts:22](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/Cell.ts#L22) +Defined in: [types/Cell.ts:16](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/Cell.ts#L16) ## Type Parameters diff --git a/docs/reference/index/type-aliases/Column.md b/docs/reference/index/type-aliases/Column.md index 37c74859af..b99de62662 100644 --- a/docs/reference/index/type-aliases/Column.md +++ b/docs/reference/index/type-aliases/Column.md @@ -6,20 +6,10 @@ title: Column # Type Alias: Column\ ```ts -type Column = Column_Core & UnionToIntersection< - | "columnFacetingFeature" extends keyof TFeatures ? Column_ColumnFaceting : never - | "columnFilteringFeature" extends keyof TFeatures ? Column_ColumnFiltering : never - | "columnGroupingFeature" extends keyof TFeatures ? Column_ColumnGrouping : never - | "columnOrderingFeature" extends keyof TFeatures ? Column_ColumnOrdering : never - | "columnPinningFeature" extends keyof TFeatures ? Column_ColumnPinning : never - | "columnResizingFeature" extends keyof TFeatures ? Column_ColumnResizing : never - | "columnSizingFeature" extends keyof TFeatures ? Column_ColumnSizing : never - | "columnVisibilityFeature" extends keyof TFeatures ? Column_ColumnVisibility : never - | "globalFilteringFeature" extends keyof TFeatures ? Column_GlobalFiltering : never -| "rowSortingFeature" extends keyof TFeatures ? Column_RowSorting : never> & ExtractFeatureTypes<"Column", TFeatures> & Column_Plugins; +type Column = Column_Core & ExtractFeatureMapTypes>; ``` -Defined in: [types/Column.ts:32](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/Column.ts#L32) +Defined in: [types/Column.ts:38](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/Column.ts#L38) ## Type Parameters diff --git a/docs/reference/index/type-aliases/ColumnDef.md b/docs/reference/index/type-aliases/ColumnDef.md index af7d86dfdb..e73f673b95 100644 --- a/docs/reference/index/type-aliases/ColumnDef.md +++ b/docs/reference/index/type-aliases/ColumnDef.md @@ -12,7 +12,7 @@ type ColumnDef = | AccessorColumnDef; ``` -Defined in: [types/ColumnDef.ts:240](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/ColumnDef.ts#L240) +Defined in: [types/ColumnDef.ts:213](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/ColumnDef.ts#L213) ## Type Parameters diff --git a/docs/reference/index/type-aliases/ColumnDefBase.md b/docs/reference/index/type-aliases/ColumnDefBase.md index 4e51bfd1ff..e8a1ff22cc 100644 --- a/docs/reference/index/type-aliases/ColumnDefBase.md +++ b/docs/reference/index/type-aliases/ColumnDefBase.md @@ -6,18 +6,10 @@ title: ColumnDefBase # Type Alias: ColumnDefBase\ ```ts -type ColumnDefBase = ColumnDefBase_Core & UnionToIntersection< - | "columnVisibilityFeature" extends keyof TFeatures ? ColumnDef_ColumnVisibility : never - | "columnPinningFeature" extends keyof TFeatures ? ColumnDef_ColumnPinning : never - | "columnFilteringFeature" extends keyof TFeatures ? ColumnDef_ColumnFiltering : never - | "globalFilteringFeature" extends keyof TFeatures ? ColumnDef_GlobalFiltering : never - | "rowSortingFeature" extends keyof TFeatures ? ColumnDef_RowSorting : never - | "columnGroupingFeature" extends keyof TFeatures ? ColumnDef_ColumnGrouping : never - | "columnSizingFeature" extends keyof TFeatures ? ColumnDef_ColumnSizing : never -| "columnResizingFeature" extends keyof TFeatures ? ColumnDef_ColumnResizing : never> & ExtractFeatureTypes<"ColumnDef", TFeatures> & ColumnDef_Plugins; +type ColumnDefBase = ColumnDefBase_Core & ExtractFeatureMapTypes>; ``` -Defined in: [types/ColumnDef.ts:113](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/ColumnDef.ts#L113) +Defined in: [types/ColumnDef.ts:118](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/ColumnDef.ts#L118) ## Type Parameters diff --git a/docs/reference/index/type-aliases/ColumnDefBase_All.md b/docs/reference/index/type-aliases/ColumnDefBase_All.md index 13a372b379..348f2511cf 100644 --- a/docs/reference/index/type-aliases/ColumnDefBase_All.md +++ b/docs/reference/index/type-aliases/ColumnDefBase_All.md @@ -9,7 +9,7 @@ title: ColumnDefBase_All type ColumnDefBase_All = ColumnDefBase_Core & Partial & ColumnDef_GlobalFiltering & ColumnDef_RowSorting & ColumnDef_ColumnGrouping & ColumnDef_ColumnSizing & ColumnDef_ColumnResizing>; ``` -Defined in: [types/ColumnDef.ts:155](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/ColumnDef.ts#L155) +Defined in: [types/ColumnDef.ts:128](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/ColumnDef.ts#L128) ## Type Parameters diff --git a/docs/reference/index/type-aliases/ColumnDefResolved.md b/docs/reference/index/type-aliases/ColumnDefResolved.md index caf4cff9e6..2c33b9cf50 100644 --- a/docs/reference/index/type-aliases/ColumnDefResolved.md +++ b/docs/reference/index/type-aliases/ColumnDefResolved.md @@ -9,7 +9,7 @@ title: ColumnDefResolved type ColumnDefResolved = Partial>> & object; ``` -Defined in: [types/ColumnDef.ts:249](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/ColumnDef.ts#L249) +Defined in: [types/ColumnDef.ts:222](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/ColumnDef.ts#L222) ## Type Declaration diff --git a/docs/reference/index/type-aliases/ColumnDefTemplate.md b/docs/reference/index/type-aliases/ColumnDefTemplate.md index edb25fee23..472d9c13a8 100644 --- a/docs/reference/index/type-aliases/ColumnDefTemplate.md +++ b/docs/reference/index/type-aliases/ColumnDefTemplate.md @@ -9,7 +9,7 @@ title: ColumnDefTemplate type ColumnDefTemplate = string | (props) => any; ``` -Defined in: [types/ColumnDef.ts:47](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/ColumnDef.ts#L47) +Defined in: [types/ColumnDef.ts:37](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/ColumnDef.ts#L37) A renderable column template value. diff --git a/docs/reference/index/type-aliases/Column_Internal.md b/docs/reference/index/type-aliases/Column_Internal.md index 84c8bab815..5e5bb79687 100644 --- a/docs/reference/index/type-aliases/Column_Internal.md +++ b/docs/reference/index/type-aliases/Column_Internal.md @@ -9,7 +9,7 @@ title: Column_Internal type Column_Internal = Column & object; ``` -Defined in: [types/Column.ts:80](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/Column.ts#L80) +Defined in: [types/Column.ts:45](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/Column.ts#L45) ## Type Declaration diff --git a/docs/reference/index/type-aliases/ConstructTableAPIs.md b/docs/reference/index/type-aliases/ConstructTableAPIs.md deleted file mode 100644 index 1f9225eb7e..0000000000 --- a/docs/reference/index/type-aliases/ConstructTableAPIs.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: ConstructTableAPIs -title: ConstructTableAPIs ---- - -# Type Alias: ConstructTableAPIs()\ - -```ts -type ConstructTableAPIs = (table) => void; -``` - -Defined in: [types/TableFeatures.ts:45](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableFeatures.ts#L45) - -## Type Parameters - -### TConstructors - -`TConstructors` *extends* [`FeatureConstructors`](../interfaces/FeatureConstructors.md) - -## Type Parameters - -### TFeatures - -`TFeatures` *extends* [`TableFeatures`](../interfaces/TableFeatures.md) - -### TData - -`TData` *extends* [`RowData`](RowData.md) - -## Parameters - -### table - -[`Table_Internal`](Table_Internal.md)\<`TFeatures`, `TData`\> & `Partial`\<`TConstructors`\[`"Table"`\]\> & `object` - -## Returns - -`void` diff --git a/docs/reference/index/type-aliases/CreateRowModels.md b/docs/reference/index/type-aliases/CreateRowModels.md index d2bcc1f32f..7b8174193f 100644 --- a/docs/reference/index/type-aliases/CreateRowModels.md +++ b/docs/reference/index/type-aliases/CreateRowModels.md @@ -6,16 +6,10 @@ title: CreateRowModels # Type Alias: CreateRowModels\ ```ts -type CreateRowModels = CreateRowModel_Core & UnionToIntersection< - | "columnFacetingFeature" extends keyof TFeatures ? CreateRowModel_Faceted : never - | "columnFilteringFeature" extends keyof TFeatures ? CreateRowModel_Filtered : never - | "rowExpandingFeature" extends keyof TFeatures ? CreateRowModel_Expanded : never - | "columnGroupingFeature" extends keyof TFeatures ? CreateRowModel_Grouped : never - | "rowPaginationFeature" extends keyof TFeatures ? CreateRowModel_Paginated : never -| "rowSortingFeature" extends keyof TFeatures ? CreateRowModel_Sorted : never> & ExtractFeatureTypes<"CreateRowModels", TFeatures> & CreateRowModels_Plugins; +type CreateRowModels = CreateRowModel_Core & ExtractFeatureMapTypes>; ``` -Defined in: [types/RowModel.ts:42](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/RowModel.ts#L42) +Defined in: [types/RowModel.ts:45](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/RowModel.ts#L45) ## Type Parameters diff --git a/docs/reference/index/type-aliases/CreateRowModels_All.md b/docs/reference/index/type-aliases/CreateRowModels_All.md index 8ae438283e..b6a07be6d4 100644 --- a/docs/reference/index/type-aliases/CreateRowModels_All.md +++ b/docs/reference/index/type-aliases/CreateRowModels_All.md @@ -9,7 +9,7 @@ title: CreateRowModels_All type CreateRowModels_All = CreateRowModel_Core & CreateRowModel_Expanded & CreateRowModel_Faceted & CreateRowModel_Filtered & CreateRowModel_Grouped & CreateRowModel_Paginated & CreateRowModel_Sorted; ``` -Defined in: [types/RowModel.ts:76](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/RowModel.ts#L76) +Defined in: [types/RowModel.ts:54](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/RowModel.ts#L54) ## Type Parameters diff --git a/docs/reference/index/type-aliases/CustomFilterFns.md b/docs/reference/index/type-aliases/CustomFilterFns.md index e6d01a4713..388e6390c1 100644 --- a/docs/reference/index/type-aliases/CustomFilterFns.md +++ b/docs/reference/index/type-aliases/CustomFilterFns.md @@ -6,7 +6,7 @@ title: CustomFilterFns # Type Alias: CustomFilterFns\ ```ts -type CustomFilterFns = Record>; +type CustomFilterFns = Record>; ``` Defined in: [features/column-filtering/columnFilteringFeature.types.ts:71](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-filtering/columnFilteringFeature.types.ts#L71) diff --git a/docs/reference/index/type-aliases/DebugOptions.md b/docs/reference/index/type-aliases/DebugOptions.md index a19f5e85c5..3bb62f7d6c 100644 --- a/docs/reference/index/type-aliases/DebugOptions.md +++ b/docs/reference/index/type-aliases/DebugOptions.md @@ -9,7 +9,7 @@ title: DebugOptions type DebugOptions = object & DebugKeysFor; ``` -Defined in: [types/TableOptions.ts:45](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableOptions.ts#L45) +Defined in: [types/TableOptions.ts:40](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableOptions.ts#L40) ## Type Declaration diff --git a/docs/reference/index/type-aliases/DisplayColumnDef.md b/docs/reference/index/type-aliases/DisplayColumnDef.md index 304f696e82..4f26de2190 100644 --- a/docs/reference/index/type-aliases/DisplayColumnDef.md +++ b/docs/reference/index/type-aliases/DisplayColumnDef.md @@ -9,7 +9,7 @@ title: DisplayColumnDef type DisplayColumnDef = ColumnDefBase & ColumnIdentifiers; ``` -Defined in: [types/ColumnDef.ts:180](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/ColumnDef.ts#L180) +Defined in: [types/ColumnDef.ts:153](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/ColumnDef.ts#L153) ## Type Parameters diff --git a/docs/reference/index/type-aliases/ExtractFeatureMapTypes.md b/docs/reference/index/type-aliases/ExtractFeatureMapTypes.md new file mode 100644 index 0000000000..0a29a0b39a --- /dev/null +++ b/docs/reference/index/type-aliases/ExtractFeatureMapTypes.md @@ -0,0 +1,22 @@ +--- +id: ExtractFeatureMapTypes +title: ExtractFeatureMapTypes +--- + +# Type Alias: ExtractFeatureMapTypes\ + +```ts +type ExtractFeatureMapTypes = IsAny extends true ? UnionToIntersection : UnionToIntersectionOrEmpty]>; +``` + +Defined in: [types/TableFeatures.ts:15](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableFeatures.ts#L15) + +## Type Parameters + +### TFeatures + +`TFeatures` *extends* [`TableFeatures`](../interfaces/TableFeatures.md) + +### TFeatureMap + +`TFeatureMap` *extends* `object` diff --git a/docs/reference/index/type-aliases/ExtractFeatureTypes.md b/docs/reference/index/type-aliases/ExtractFeatureTypes.md deleted file mode 100644 index 47dc2e13ae..0000000000 --- a/docs/reference/index/type-aliases/ExtractFeatureTypes.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -id: ExtractFeatureTypes -title: ExtractFeatureTypes ---- - -# Type Alias: ExtractFeatureTypes\ - -```ts -type ExtractFeatureTypes = UnionToIntersection<{ [K in keyof TFeatures]: K extends "coreReativityFeature" ? never : TFeatures[K] extends TableFeature ? TKey extends keyof FeatureConstructorOptions ? FeatureConstructorOptions[TKey] : never : any }[keyof TFeatures]>; -``` - -Defined in: [types/TableFeatures.ts:10](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableFeatures.ts#L10) - -## Type Parameters - -### TKey - -`TKey` *extends* keyof [`FeatureConstructors`](../interfaces/FeatureConstructors.md) - -### TFeatures - -`TFeatures` *extends* [`TableFeatures`](../interfaces/TableFeatures.md) diff --git a/docs/reference/index/type-aliases/FilterFnOption.md b/docs/reference/index/type-aliases/FilterFnOption.md index 3cb48c19c4..f277176ced 100644 --- a/docs/reference/index/type-aliases/FilterFnOption.md +++ b/docs/reference/index/type-aliases/FilterFnOption.md @@ -10,7 +10,7 @@ type FilterFnOption = | "auto" | BuiltInFilterFn | keyof FilterFns -| FilterFn; +| FilterFn; ``` Defined in: [features/column-filtering/columnFilteringFeature.types.ts:76](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-filtering/columnFilteringFeature.types.ts#L76) diff --git a/docs/reference/index/type-aliases/GetDefaultColumnDef.md b/docs/reference/index/type-aliases/GetDefaultColumnDef.md deleted file mode 100644 index 270ff5abd0..0000000000 --- a/docs/reference/index/type-aliases/GetDefaultColumnDef.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -id: GetDefaultColumnDef -title: GetDefaultColumnDef ---- - -# Type Alias: GetDefaultColumnDef()\ - -```ts -type GetDefaultColumnDef = () => ColumnDefBase_All & Partial; -``` - -Defined in: [types/TableFeatures.ts:55](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableFeatures.ts#L55) - -## Type Parameters - -### TConstructors - -`TConstructors` *extends* [`FeatureConstructors`](../interfaces/FeatureConstructors.md) - -## Type Parameters - -### TFeatures - -`TFeatures` *extends* [`TableFeatures`](../interfaces/TableFeatures.md) - -### TData - -`TData` *extends* [`RowData`](RowData.md) - -### TValue - -`TValue` *extends* [`CellData`](CellData.md) = [`CellData`](CellData.md) - -## Returns - -[`ColumnDefBase_All`](ColumnDefBase_All.md)\<`TFeatures`, `TData`, `TValue`\> & `Partial`\<`TConstructors`\[`"ColumnDef"`\]\> diff --git a/docs/reference/index/type-aliases/GetDefaultStateSelector.md b/docs/reference/index/type-aliases/GetDefaultStateSelector.md deleted file mode 100644 index 321bba0ed7..0000000000 --- a/docs/reference/index/type-aliases/GetDefaultStateSelector.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -id: GetDefaultStateSelector -title: GetDefaultStateSelector ---- - -# Type Alias: GetDefaultStateSelector()\ - -```ts -type GetDefaultStateSelector = (state) => Partial & Partial; -``` - -Defined in: [types/TableFeatures.ts:72](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableFeatures.ts#L72) - -## Type Parameters - -### TConstructors - -`TConstructors` *extends* [`FeatureConstructors`](../interfaces/FeatureConstructors.md) - -## Parameters - -### state - -[`TableState_All`](TableState_All.md) - -## Returns - -`Partial`\<[`TableState_All`](TableState_All.md)\> & `Partial`\<`TConstructors`\[`"TableState"`\]\> diff --git a/docs/reference/index/type-aliases/GetDefaultTableOptions.md b/docs/reference/index/type-aliases/GetDefaultTableOptions.md deleted file mode 100644 index 14e838d76a..0000000000 --- a/docs/reference/index/type-aliases/GetDefaultTableOptions.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: GetDefaultTableOptions -title: GetDefaultTableOptions ---- - -# Type Alias: GetDefaultTableOptions()\ - -```ts -type GetDefaultTableOptions = (table) => Partial> & Partial; -``` - -Defined in: [types/TableFeatures.ts:62](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableFeatures.ts#L62) - -## Type Parameters - -### TConstructors - -`TConstructors` *extends* [`FeatureConstructors`](../interfaces/FeatureConstructors.md) - -## Type Parameters - -### TFeatures - -`TFeatures` *extends* [`TableFeatures`](../interfaces/TableFeatures.md) - -### TData - -`TData` *extends* [`RowData`](RowData.md) - -## Parameters - -### table - -[`Table_Internal`](Table_Internal.md)\<`TFeatures`, `TData`\> & `Partial`\<`TConstructors`\[`"Table"`\]\> - -## Returns - -`Partial`\<[`TableOptions_All`](TableOptions_All.md)\<`TFeatures`, `TData`\>\> & `Partial`\<`TConstructors`\[`"TableOptions"`\]\> diff --git a/docs/reference/index/type-aliases/GetInitialState.md b/docs/reference/index/type-aliases/GetInitialState.md deleted file mode 100644 index f8d29d1c9f..0000000000 --- a/docs/reference/index/type-aliases/GetInitialState.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -id: GetInitialState -title: GetInitialState ---- - -# Type Alias: GetInitialState()\ - -```ts -type GetInitialState = (initialState) => TableState_All & Partial; -``` - -Defined in: [types/TableFeatures.ts:68](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableFeatures.ts#L68) - -## Type Parameters - -### TConstructors - -`TConstructors` *extends* [`FeatureConstructors`](../interfaces/FeatureConstructors.md) - -## Parameters - -### initialState - -`Partial`\<[`TableState_All`](TableState_All.md)\> & `Partial`\<`TConstructors`\[`"TableState"`\]\> - -## Returns - -[`TableState_All`](TableState_All.md) & `Partial`\<`TConstructors`\[`"TableState"`\]\> diff --git a/docs/reference/index/type-aliases/GroupColumnDef.md b/docs/reference/index/type-aliases/GroupColumnDef.md index 8965e42e06..1970f57fc5 100644 --- a/docs/reference/index/type-aliases/GroupColumnDef.md +++ b/docs/reference/index/type-aliases/GroupColumnDef.md @@ -9,7 +9,7 @@ title: GroupColumnDef type GroupColumnDef = GroupColumnDefBase & ColumnIdentifiers; ``` -Defined in: [types/ColumnDef.ts:194](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/ColumnDef.ts#L194) +Defined in: [types/ColumnDef.ts:167](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/ColumnDef.ts#L167) ## Type Parameters diff --git a/docs/reference/index/type-aliases/Header.md b/docs/reference/index/type-aliases/Header.md index 0a7f21d453..157a1f4459 100644 --- a/docs/reference/index/type-aliases/Header.md +++ b/docs/reference/index/type-aliases/Header.md @@ -6,12 +6,10 @@ title: Header # Type Alias: Header\ ```ts -type Header = Header_Core & UnionToIntersection< - | "columnSizingFeature" extends keyof TFeatures ? Header_ColumnSizing : never -| "columnResizingFeature" extends keyof TFeatures ? Header_ColumnResizing : never> & ExtractFeatureTypes<"Header", TFeatures> & Header_Plugins; +type Header = Header_Core & ExtractFeatureMapTypes; ``` -Defined in: [types/Header.ts:23](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/Header.ts#L23) +Defined in: [types/Header.ts:18](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/Header.ts#L18) ## Type Parameters diff --git a/docs/reference/index/type-aliases/HeaderGroup.md b/docs/reference/index/type-aliases/HeaderGroup.md index 10918eec2b..d34d69783a 100644 --- a/docs/reference/index/type-aliases/HeaderGroup.md +++ b/docs/reference/index/type-aliases/HeaderGroup.md @@ -6,10 +6,10 @@ title: HeaderGroup # Type Alias: HeaderGroup\ ```ts -type HeaderGroup = HeaderGroup_Core & ExtractFeatureTypes<"HeaderGroup", TFeatures> & HeaderGroup_Plugins; +type HeaderGroup = HeaderGroup_Core; ``` -Defined in: [types/HeaderGroup.ts:19](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/HeaderGroup.ts#L19) +Defined in: [types/HeaderGroup.ts:10](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/HeaderGroup.ts#L10) ## Type Parameters diff --git a/docs/reference/index/type-aliases/IdentifiedColumnDef.md b/docs/reference/index/type-aliases/IdentifiedColumnDef.md index 107856038c..6dcfd0c5f8 100644 --- a/docs/reference/index/type-aliases/IdentifiedColumnDef.md +++ b/docs/reference/index/type-aliases/IdentifiedColumnDef.md @@ -9,7 +9,7 @@ title: IdentifiedColumnDef type IdentifiedColumnDef = ColumnDefBase & object; ``` -Defined in: [types/ColumnDef.ts:171](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/ColumnDef.ts#L171) +Defined in: [types/ColumnDef.ts:144](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/ColumnDef.ts#L144) ## Type Declaration diff --git a/docs/reference/index/type-aliases/InitRowInstanceData.md b/docs/reference/index/type-aliases/InitRowInstanceData.md deleted file mode 100644 index a34eb37343..0000000000 --- a/docs/reference/index/type-aliases/InitRowInstanceData.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: InitRowInstanceData -title: InitRowInstanceData ---- - -# Type Alias: InitRowInstanceData()\ - -```ts -type InitRowInstanceData = (row) => void; -``` - -Defined in: [types/TableFeatures.ts:109](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableFeatures.ts#L109) - -## Type Parameters - -### TConstructors - -`TConstructors` *extends* [`FeatureConstructors`](../interfaces/FeatureConstructors.md) - -## Type Parameters - -### TFeatures - -`TFeatures` *extends* [`TableFeatures`](../interfaces/TableFeatures.md) - -### TData - -`TData` *extends* [`RowData`](RowData.md) - -## Parameters - -### row - -[`Row`](Row.md)\<`TFeatures`, `TData`\> & `Partial`\<`TConstructors`\[`"Row"`\]\> - -## Returns - -`void` diff --git a/docs/reference/index/type-aliases/Row.md b/docs/reference/index/type-aliases/Row.md index 3952ae74ba..30c2955951 100644 --- a/docs/reference/index/type-aliases/Row.md +++ b/docs/reference/index/type-aliases/Row.md @@ -6,17 +6,10 @@ title: Row # Type Alias: Row\ ```ts -type Row = Row_Core & UnionToIntersection< - | "columnFilteringFeature" extends keyof TFeatures ? Row_ColumnFiltering : never - | "columnGroupingFeature" extends keyof TFeatures ? Row_ColumnGrouping : never - | "columnPinningFeature" extends keyof TFeatures ? Row_ColumnPinning : never - | "columnVisibilityFeature" extends keyof TFeatures ? Row_ColumnVisibility : never - | "rowExpandingFeature" extends keyof TFeatures ? Row_RowExpanding : never - | "rowPinningFeature" extends keyof TFeatures ? Row_RowPinning : never -| "rowSelectionFeature" extends keyof TFeatures ? Row_RowSelection : never> & ExtractFeatureTypes<"Row", TFeatures> & Row_Plugins; +type Row = Row_Core & ExtractFeatureMapTypes>; ``` -Defined in: [types/Row.ts:26](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/Row.ts#L26) +Defined in: [types/Row.ts:30](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/Row.ts#L30) ## Type Parameters diff --git a/docs/reference/index/type-aliases/RowModelFns.md b/docs/reference/index/type-aliases/RowModelFns.md index 35fb67dbbc..1afc7e7b0b 100644 --- a/docs/reference/index/type-aliases/RowModelFns.md +++ b/docs/reference/index/type-aliases/RowModelFns.md @@ -6,10 +6,7 @@ title: RowModelFns # Type Alias: RowModelFns\ ```ts -type RowModelFns = Partial : never - | "columnGroupingFeature" extends keyof TFeatures ? RowModelFns_ColumnGrouping : never -| "rowSortingFeature" extends keyof TFeatures ? RowModelFns_RowSorting : never> & ExtractFeatureTypes<"RowModelFns", TFeatures> & RowModelFns_Plugins>; +type RowModelFns = Partial>>; ``` Defined in: [types/RowModelFns.ts:18](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/RowModelFns.ts#L18) diff --git a/docs/reference/index/type-aliases/RowModelFns_All.md b/docs/reference/index/type-aliases/RowModelFns_All.md index fcef1570c3..1ff3fdc144 100644 --- a/docs/reference/index/type-aliases/RowModelFns_All.md +++ b/docs/reference/index/type-aliases/RowModelFns_All.md @@ -9,7 +9,7 @@ title: RowModelFns_All type RowModelFns_All = Partial & RowModelFns_ColumnGrouping & RowModelFns_RowSorting>; ``` -Defined in: [types/RowModelFns.ts:44](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/RowModelFns.ts#L44) +Defined in: [types/RowModelFns.ts:25](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/RowModelFns.ts#L25) ## Type Parameters diff --git a/docs/reference/index/type-aliases/StringOrTemplateHeader.md b/docs/reference/index/type-aliases/StringOrTemplateHeader.md index 3015ddf88b..4499b2c1ec 100644 --- a/docs/reference/index/type-aliases/StringOrTemplateHeader.md +++ b/docs/reference/index/type-aliases/StringOrTemplateHeader.md @@ -11,7 +11,7 @@ type StringOrTemplateHeader = | ColumnDefTemplate>; ``` -Defined in: [types/ColumnDef.ts:51](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/ColumnDef.ts#L51) +Defined in: [types/ColumnDef.ts:41](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/ColumnDef.ts#L41) ## Type Parameters diff --git a/docs/reference/index/type-aliases/Table.md b/docs/reference/index/type-aliases/Table.md index 405ffd6b4d..b0cfee3aac 100644 --- a/docs/reference/index/type-aliases/Table.md +++ b/docs/reference/index/type-aliases/Table.md @@ -6,24 +6,10 @@ title: Table # Type Alias: Table\ ```ts -type Table = Table_Core & UnionToIntersection< - | "columnFilteringFeature" extends keyof TFeatures ? Table_ColumnFiltering : never - | "columnGroupingFeature" extends keyof TFeatures ? Table_ColumnGrouping : never - | "columnOrderingFeature" extends keyof TFeatures ? Table_ColumnOrdering : never - | "columnPinningFeature" extends keyof TFeatures ? Table_ColumnPinning : never - | "columnResizingFeature" extends keyof TFeatures ? Table_ColumnResizing : never - | "columnSizingFeature" extends keyof TFeatures ? Table_ColumnSizing : never - | "columnVisibilityFeature" extends keyof TFeatures ? Table_ColumnVisibility : never - | "columnFacetingFeature" extends keyof TFeatures ? Table_ColumnFaceting : never - | "globalFilteringFeature" extends keyof TFeatures ? Table_GlobalFiltering : never - | "rowExpandingFeature" extends keyof TFeatures ? Table_RowExpanding : never - | "rowPaginationFeature" extends keyof TFeatures ? Table_RowPagination : never - | "rowPinningFeature" extends keyof TFeatures ? Table_RowPinning : never - | "rowSelectionFeature" extends keyof TFeatures ? Table_RowSelection : never -| "rowSortingFeature" extends keyof TFeatures ? Table_RowSorting : never> & ExtractFeatureTypes<"Table", TFeatures> & Table_Plugins; +type Table = Table_Core & ExtractFeatureMapTypes>; ``` -Defined in: [types/Table.ts:58](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/Table.ts#L58) +Defined in: [types/Table.ts:69](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/Table.ts#L69) The table object that includes both the core table functionality and the features that are enabled via the `features` table option. diff --git a/docs/reference/index/type-aliases/TableOptions.md b/docs/reference/index/type-aliases/TableOptions.md index df0458dbbe..ac0f2b613c 100644 --- a/docs/reference/index/type-aliases/TableOptions.md +++ b/docs/reference/index/type-aliases/TableOptions.md @@ -6,23 +6,10 @@ title: TableOptions # Type Alias: TableOptions\ ```ts -type TableOptions = TableOptions_Core & UnionToIntersection< - | "columnFilteringFeature" extends keyof TFeatures ? TableOptions_ColumnFiltering : never - | "columnGroupingFeature" extends keyof TFeatures ? TableOptions_ColumnGrouping : never - | "columnOrderingFeature" extends keyof TFeatures ? TableOptions_ColumnOrdering : never - | "columnPinningFeature" extends keyof TFeatures ? TableOptions_ColumnPinning : never - | "columnResizingFeature" extends keyof TFeatures ? TableOptions_ColumnResizing : never - | "columnSizingFeature" extends keyof TFeatures ? TableOptions_ColumnSizing : never - | "columnVisibilityFeature" extends keyof TFeatures ? TableOptions_ColumnVisibility : never - | "globalFilteringFeature" extends keyof TFeatures ? TableOptions_GlobalFiltering : never - | "rowExpandingFeature" extends keyof TFeatures ? TableOptions_RowExpanding : never - | "rowPaginationFeature" extends keyof TFeatures ? TableOptions_RowPagination : never - | "rowPinningFeature" extends keyof TFeatures ? TableOptions_RowPinning : never - | "rowSelectionFeature" extends keyof TFeatures ? TableOptions_RowSelection : never -| "rowSortingFeature" extends keyof TFeatures ? TableOptions_RowSorting : never> & ExtractFeatureTypes<"TableOptions", TFeatures> & TableOptions_Plugins & DebugOptions; +type TableOptions = TableOptions_Core & ExtractFeatureMapTypes> & DebugOptions; ``` -Defined in: [types/TableOptions.ts:62](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableOptions.ts#L62) +Defined in: [types/TableOptions.ts:86](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableOptions.ts#L86) Complete table options for a specific feature set. diff --git a/docs/reference/index/type-aliases/TableOptions_All.md b/docs/reference/index/type-aliases/TableOptions_All.md index 6e1122f183..fe741a0396 100644 --- a/docs/reference/index/type-aliases/TableOptions_All.md +++ b/docs/reference/index/type-aliases/TableOptions_All.md @@ -6,10 +6,10 @@ title: TableOptions_All # Type Alias: TableOptions\_All\ ```ts -type TableOptions_All = TableOptions_Core & Partial & TableOptions_ColumnGrouping & TableOptions_ColumnOrdering & TableOptions_ColumnPinning & TableOptions_ColumnResizing & TableOptions_ColumnSizing & TableOptions_ColumnVisibility & TableOptions_GlobalFiltering & TableOptions_RowExpanding & TableOptions_RowPagination & TableOptions_RowPinning & TableOptions_RowSelection & TableOptions_RowSorting>; +type TableOptions_All = TableOptions_Core & Partial>; ``` -Defined in: [types/TableOptions.ts:122](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableOptions.ts#L122) +Defined in: [types/TableOptions.ts:97](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableOptions.ts#L97) 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. diff --git a/docs/reference/index/type-aliases/TableOptions_FeatureMap_All.md b/docs/reference/index/type-aliases/TableOptions_FeatureMap_All.md new file mode 100644 index 0000000000..97d4e7ea03 --- /dev/null +++ b/docs/reference/index/type-aliases/TableOptions_FeatureMap_All.md @@ -0,0 +1,22 @@ +--- +id: TableOptions_FeatureMap_All +title: TableOptions_FeatureMap_All +--- + +# Type Alias: TableOptions\_FeatureMap\_All\ + +```ts +type TableOptions_FeatureMap_All = UnionToIntersection[keyof TableOptions_FeatureMap]>; +``` + +Defined in: [types/TableOptions.ts:69](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableOptions.ts#L69) + +## Type Parameters + +### TFeatures + +`TFeatures` *extends* [`TableFeatures`](../interfaces/TableFeatures.md) + +### TData + +`TData` *extends* [`RowData`](RowData.md) diff --git a/docs/reference/index/type-aliases/TableState.md b/docs/reference/index/type-aliases/TableState.md index 947278193d..90b749abf3 100644 --- a/docs/reference/index/type-aliases/TableState.md +++ b/docs/reference/index/type-aliases/TableState.md @@ -6,23 +6,10 @@ title: TableState # Type Alias: TableState\ ```ts -type TableState = UnionToIntersection< - | "columnFilteringFeature" extends keyof TFeatures ? TableState_ColumnFiltering : never - | "columnGroupingFeature" extends keyof TFeatures ? TableState_ColumnGrouping : never - | "columnOrderingFeature" extends keyof TFeatures ? TableState_ColumnOrdering : never - | "columnPinningFeature" extends keyof TFeatures ? TableState_ColumnPinning : never - | "columnResizingFeature" extends keyof TFeatures ? TableState_ColumnResizing : never - | "columnSizingFeature" extends keyof TFeatures ? TableState_ColumnSizing : never - | "columnVisibilityFeature" extends keyof TFeatures ? TableState_ColumnVisibility : never - | "globalFilteringFeature" extends keyof TFeatures ? TableState_GlobalFiltering : never - | "rowExpandingFeature" extends keyof TFeatures ? TableState_RowExpanding : never - | "rowPaginationFeature" extends keyof TFeatures ? TableState_RowPagination : never - | "rowPinningFeature" extends keyof TFeatures ? TableState_RowPinning : never - | "rowSelectionFeature" extends keyof TFeatures ? TableState_RowSelection : never -| "rowSortingFeature" extends keyof TFeatures ? TableState_RowSorting : never> & ExtractFeatureTypes<"TableState", TFeatures> & TableState_Plugins; +type TableState = ExtractFeatureMapTypes; ``` -Defined in: [types/TableState.ts:29](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableState.ts#L29) +Defined in: [types/TableState.ts:38](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableState.ts#L38) Complete table state for a specific feature set. diff --git a/docs/reference/index/type-aliases/TableState_All.md b/docs/reference/index/type-aliases/TableState_All.md index 9a377b1c95..af240c5b12 100644 --- a/docs/reference/index/type-aliases/TableState_All.md +++ b/docs/reference/index/type-aliases/TableState_All.md @@ -6,12 +6,12 @@ title: TableState_All # Type Alias: TableState\_All ```ts -type TableState_All = Partial; +type TableState_All = Partial>; ``` -Defined in: [types/TableState.ts:86](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableState.ts#L86) +Defined in: [types/TableState.ts:47](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableState.ts#L47) -Internal broad state shape containing every stock feature state slice. +Internal broad state shape containing every registered feature state slice. Feature internals use this when they may need to inspect optional slices owned by other features. diff --git a/docs/reference/index/type-aliases/Table_Core.md b/docs/reference/index/type-aliases/Table_Core.md index d427a93c7d..589250f249 100644 --- a/docs/reference/index/type-aliases/Table_Core.md +++ b/docs/reference/index/type-aliases/Table_Core.md @@ -9,7 +9,7 @@ title: Table_Core type Table_Core = Table_Table & Table_Columns & Table_Rows & Table_RowModels & Table_Headers; ``` -Defined in: [types/Table.ts:46](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/Table.ts#L46) +Defined in: [types/Table.ts:37](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/Table.ts#L37) The core table object that only includes the core table functionality such as column, header, row, and table APIS. No features are included. diff --git a/docs/reference/index/type-aliases/Table_Internal.md b/docs/reference/index/type-aliases/Table_Internal.md index 7b5392580f..da80b30c9f 100644 --- a/docs/reference/index/type-aliases/Table_Internal.md +++ b/docs/reference/index/type-aliases/Table_Internal.md @@ -9,7 +9,7 @@ title: Table_Internal type Table_Internal = Table & object; ``` -Defined in: [types/Table.ts:116](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/Table.ts#L116) +Defined in: [types/Table.ts:75](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/Table.ts#L75) ## Type Declaration @@ -19,10 +19,10 @@ Defined in: [types/Table.ts:116](https://github.com/TanStack/table/blob/main/pac _rowModelFns: RowModelFns_All; ``` -### \rowModels +### \_rowModels ```ts -rowModels: CachedRowModel_All; +_rowModels: CachedRowModel_All; ``` ### atoms @@ -51,12 +51,6 @@ options: TableOptions_All & object; #### Type Declaration -##### \rowModels? - -```ts -optional rowModels: CreateRowModels_All; -``` - ##### atoms? ```ts @@ -69,6 +63,12 @@ optional atoms: ExternalAtoms_All; optional initialState: TableState_All; ``` +##### rowModels? + +```ts +optional rowModels: CreateRowModels_All; +``` + ##### state? ```ts diff --git a/docs/reference/index/type-aliases/Table_RowModels.md b/docs/reference/index/type-aliases/Table_RowModels.md index 8fade8a58d..aa09b036a7 100644 --- a/docs/reference/index/type-aliases/Table_RowModels.md +++ b/docs/reference/index/type-aliases/Table_RowModels.md @@ -9,7 +9,7 @@ title: Table_RowModels type Table_RowModels = Table_RowModels_Core & Table_RowModels_Faceted & Table_RowModels_Filtered & Table_RowModels_Grouped & Table_RowModels_Expanded & Table_RowModels_Paginated & Table_RowModels_Sorted; ``` -Defined in: [core/row-models/coreRowModelsFeature.types.ts:59](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/row-models/coreRowModelsFeature.types.ts#L59) +Defined in: [core/row-models/coreRowModelsFeature.types.ts:55](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/row-models/coreRowModelsFeature.types.ts#L55) ## Type Parameters diff --git a/docs/reference/index/variables/aggregationFn_count.md b/docs/reference/index/variables/aggregationFn_count.md deleted file mode 100644 index ed7857f832..0000000000 --- a/docs/reference/index/variables/aggregationFn_count.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -id: aggregationFn_count -title: aggregationFn_count ---- - -# Variable: aggregationFn\_count - -```ts -const aggregationFn_count: AggregationFn; -``` - -Defined in: [fns/aggregationFns.ts:234](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/aggregationFns.ts#L234) - -Counts the number of leaf rows in the group. - -The column id is ignored because the result is based only on group size. diff --git a/docs/reference/index/variables/aggregationFn_extent.md b/docs/reference/index/variables/aggregationFn_extent.md deleted file mode 100644 index 38716cf2e4..0000000000 --- a/docs/reference/index/variables/aggregationFn_extent.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -id: aggregationFn_extent -title: aggregationFn_extent ---- - -# Variable: aggregationFn\_extent - -```ts -const aggregationFn_extent: AggregationFn; -``` - -Defined in: [fns/aggregationFns.ts:95](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/aggregationFns.ts#L95) - -Finds the numeric extent for a grouped column. - -Returns `[min, max]`, where each entry is `undefined` when no numeric value is -present. diff --git a/docs/reference/index/variables/aggregationFn_max.md b/docs/reference/index/variables/aggregationFn_max.md deleted file mode 100644 index 32e7c834fd..0000000000 --- a/docs/reference/index/variables/aggregationFn_max.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -id: aggregationFn_max -title: aggregationFn_max ---- - -# Variable: aggregationFn\_max - -```ts -const aggregationFn_max: AggregationFn; -``` - -Defined in: [fns/aggregationFns.ts:65](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/aggregationFns.ts#L65) - -Finds the maximum numeric child-row value for a grouped column. - -Nullish and non-number values are ignored. Returns `undefined` when no -numeric value is found. diff --git a/docs/reference/index/variables/aggregationFn_mean.md b/docs/reference/index/variables/aggregationFn_mean.md deleted file mode 100644 index 23616f322e..0000000000 --- a/docs/reference/index/variables/aggregationFn_mean.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -id: aggregationFn_mean -title: aggregationFn_mean ---- - -# Variable: aggregationFn\_mean - -```ts -const aggregationFn_mean: AggregationFn; -``` - -Defined in: [fns/aggregationFns.ts:127](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/aggregationFns.ts#L127) - -Averages numeric leaf-row values for a grouped column. - -Number-like values are coerced with unary `+`; nullish and non-numeric values -are ignored. diff --git a/docs/reference/index/variables/aggregationFn_median.md b/docs/reference/index/variables/aggregationFn_median.md deleted file mode 100644 index 296257d20a..0000000000 --- a/docs/reference/index/variables/aggregationFn_median.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -id: aggregationFn_median -title: aggregationFn_median ---- - -# Variable: aggregationFn\_median - -```ts -const aggregationFn_median: AggregationFn; -``` - -Defined in: [fns/aggregationFns.ts:162](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/aggregationFns.ts#L162) - -Computes the median of numeric leaf-row values for a grouped column. - -All values must be numbers. If any value is non-numeric, or no leaf rows are -present, the result is `undefined`. diff --git a/docs/reference/index/variables/aggregationFn_min.md b/docs/reference/index/variables/aggregationFn_min.md deleted file mode 100644 index f05fb32e71..0000000000 --- a/docs/reference/index/variables/aggregationFn_min.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -id: aggregationFn_min -title: aggregationFn_min ---- - -# Variable: aggregationFn\_min - -```ts -const aggregationFn_min: AggregationFn; -``` - -Defined in: [fns/aggregationFns.ts:34](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/aggregationFns.ts#L34) - -Finds the minimum numeric child-row value for a grouped column. - -Nullish and non-number values are ignored. Returns `undefined` when no -numeric value is found. diff --git a/docs/reference/index/variables/aggregationFn_sum.md b/docs/reference/index/variables/aggregationFn_sum.md deleted file mode 100644 index bc3128e723..0000000000 --- a/docs/reference/index/variables/aggregationFn_sum.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -id: aggregationFn_sum -title: aggregationFn_sum ---- - -# Variable: aggregationFn\_sum - -```ts -const aggregationFn_sum: AggregationFn; -``` - -Defined in: [fns/aggregationFns.ts:12](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/aggregationFns.ts#L12) - -Sums numeric child-row values for a grouped column. - -Non-number values contribute `0`. Child rows are used so nested group totals -can reuse already aggregated values. diff --git a/docs/reference/index/variables/aggregationFn_unique.md b/docs/reference/index/variables/aggregationFn_unique.md deleted file mode 100644 index d1442e30be..0000000000 --- a/docs/reference/index/variables/aggregationFn_unique.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -id: aggregationFn_unique -title: aggregationFn_unique ---- - -# Variable: aggregationFn\_unique - -```ts -const aggregationFn_unique: AggregationFn; -``` - -Defined in: [fns/aggregationFns.ts:196](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/aggregationFns.ts#L196) - -Collects unique leaf-row values for a grouped column. - -Values are compared with JavaScript `Set` semantics. diff --git a/docs/reference/index/variables/aggregationFn_uniqueCount.md b/docs/reference/index/variables/aggregationFn_uniqueCount.md deleted file mode 100644 index f76a0d4d1f..0000000000 --- a/docs/reference/index/variables/aggregationFn_uniqueCount.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -id: aggregationFn_uniqueCount -title: aggregationFn_uniqueCount ---- - -# Variable: aggregationFn\_uniqueCount - -```ts -const aggregationFn_uniqueCount: AggregationFn; -``` - -Defined in: [fns/aggregationFns.ts:215](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/aggregationFns.ts#L215) - -Counts unique leaf-row values for a grouped column. - -Values are compared with JavaScript `Set` semantics. diff --git a/docs/reference/index/variables/aggregationFns.md b/docs/reference/index/variables/aggregationFns.md index 00692ebc2a..b2af0fe775 100644 --- a/docs/reference/index/variables/aggregationFns.md +++ b/docs/reference/index/variables/aggregationFns.md @@ -9,7 +9,7 @@ title: aggregationFns const aggregationFns: object; ``` -Defined in: [fns/aggregationFns.ts:249](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/aggregationFns.ts#L249) +Defined in: [fns/aggregationFns.ts:233](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/aggregationFns.ts#L233) The built-in aggregation function registry. @@ -17,56 +17,330 @@ Pass this object to grouped row model creation or extend it with custom aggregat ## Type Declaration -### count +### count() ```ts -count: AggregationFn = aggregationFn_count; +count: (_columnId, leafRows) => number = aggregationFn_count; ``` -### extent +Counts the number of leaf rows in the group. + +The column id is ignored because the result is based only on group size. + +#### Type Parameters + +##### TFeatures + +`TFeatures` *extends* [`TableFeatures`](../interfaces/TableFeatures.md) + +##### TData + +`TData` *extends* [`RowData`](../type-aliases/RowData.md) + +#### Parameters + +##### \_columnId + +`string` + +##### leafRows + +[`Row`](../type-aliases/Row.md)\<`TFeatures`, `TData`\>[] + +#### Returns + +`number` + +### extent() ```ts -extent: AggregationFn = aggregationFn_extent; +extent: (columnId, _leafRows, childRows) => (number | undefined)[] = aggregationFn_extent; ``` -### max +Finds the numeric extent for a grouped column. + +Returns `[min, max]`, where each entry is `undefined` when no numeric value is +present. + +#### Type Parameters + +##### TFeatures + +`TFeatures` *extends* [`TableFeatures`](../interfaces/TableFeatures.md) + +##### TData + +`TData` *extends* [`RowData`](../type-aliases/RowData.md) + +#### Parameters + +##### columnId + +`string` + +##### \_leafRows + +[`Row`](../type-aliases/Row.md)\<`TFeatures`, `TData`\>[] + +##### childRows + +[`Row`](../type-aliases/Row.md)\<`TFeatures`, `TData`\>[] + +#### Returns + +(`number` \| `undefined`)[] + +### max() ```ts -max: AggregationFn = aggregationFn_max; +max: (columnId, _leafRows, childRows) => number | undefined = aggregationFn_max; ``` -### mean +Finds the maximum numeric child-row value for a grouped column. + +Nullish and non-number values are ignored. Returns `undefined` when no +numeric value is found. + +#### Type Parameters + +##### TFeatures + +`TFeatures` *extends* [`TableFeatures`](../interfaces/TableFeatures.md) + +##### TData + +`TData` *extends* [`RowData`](../type-aliases/RowData.md) + +#### Parameters + +##### columnId + +`string` + +##### \_leafRows + +[`Row`](../type-aliases/Row.md)\<`TFeatures`, `TData`\>[] + +##### childRows + +[`Row`](../type-aliases/Row.md)\<`TFeatures`, `TData`\>[] + +#### Returns + +`number` \| `undefined` + +### mean() ```ts -mean: AggregationFn = aggregationFn_mean; +mean: (columnId, leafRows) => number | undefined = aggregationFn_mean; ``` -### median +Averages numeric leaf-row values for a grouped column. + +Number-like values are coerced with unary `+`; nullish and non-numeric values +are ignored. + +#### Type Parameters + +##### TFeatures + +`TFeatures` *extends* [`TableFeatures`](../interfaces/TableFeatures.md) + +##### TData + +`TData` *extends* [`RowData`](../type-aliases/RowData.md) + +#### Parameters + +##### columnId + +`string` + +##### leafRows + +[`Row`](../type-aliases/Row.md)\<`TFeatures`, `TData`\>[] + +#### Returns + +`number` \| `undefined` + +### median() ```ts -median: AggregationFn = aggregationFn_median; +median: (columnId, leafRows) => number | undefined = aggregationFn_median; ``` -### min +Computes the median of numeric leaf-row values for a grouped column. + +All values must be numbers. If any value is non-numeric, or no leaf rows are +present, the result is `undefined`. + +#### Type Parameters + +##### TFeatures + +`TFeatures` *extends* [`TableFeatures`](../interfaces/TableFeatures.md) + +##### TData + +`TData` *extends* [`RowData`](../type-aliases/RowData.md) + +#### Parameters + +##### columnId + +`string` + +##### leafRows + +[`Row`](../type-aliases/Row.md)\<`TFeatures`, `TData`\>[] + +#### Returns + +`number` \| `undefined` + +### min() ```ts -min: AggregationFn = aggregationFn_min; +min: (columnId, _leafRows, childRows) => number | undefined = aggregationFn_min; ``` -### sum +Finds the minimum numeric child-row value for a grouped column. + +Nullish and non-number values are ignored. Returns `undefined` when no +numeric value is found. + +#### Type Parameters + +##### TFeatures + +`TFeatures` *extends* [`TableFeatures`](../interfaces/TableFeatures.md) + +##### TData + +`TData` *extends* [`RowData`](../type-aliases/RowData.md) + +#### Parameters + +##### columnId + +`string` + +##### \_leafRows + +[`Row`](../type-aliases/Row.md)\<`TFeatures`, `TData`\>[] + +##### childRows + +[`Row`](../type-aliases/Row.md)\<`TFeatures`, `TData`\>[] + +#### Returns + +`number` \| `undefined` + +### sum() ```ts -sum: AggregationFn = aggregationFn_sum; +sum: (columnId, _leafRows, childRows) => number = aggregationFn_sum; ``` -### unique +Sums numeric child-row values for a grouped column. + +Non-number values contribute `0`. Child rows are used so nested group totals +can reuse already aggregated values. + +#### Type Parameters + +##### TFeatures + +`TFeatures` *extends* [`TableFeatures`](../interfaces/TableFeatures.md) + +##### TData + +`TData` *extends* [`RowData`](../type-aliases/RowData.md) + +#### Parameters + +##### columnId + +`string` + +##### \_leafRows + +[`Row`](../type-aliases/Row.md)\<`TFeatures`, `TData`\>[] + +##### childRows + +[`Row`](../type-aliases/Row.md)\<`TFeatures`, `TData`\>[] + +#### Returns + +`number` + +### unique() ```ts -unique: AggregationFn = aggregationFn_unique; +unique: (columnId, leafRows) => unknown[] = aggregationFn_unique; ``` -### uniqueCount +Collects unique leaf-row values for a grouped column. + +Values are compared with JavaScript `Set` semantics. + +#### Type Parameters + +##### TFeatures + +`TFeatures` *extends* [`TableFeatures`](../interfaces/TableFeatures.md) + +##### TData + +`TData` *extends* [`RowData`](../type-aliases/RowData.md) + +#### Parameters + +##### columnId + +`string` + +##### leafRows + +[`Row`](../type-aliases/Row.md)\<`TFeatures`, `TData`\>[] + +#### Returns + +`unknown`[] + +### uniqueCount() ```ts -uniqueCount: AggregationFn = aggregationFn_uniqueCount; +uniqueCount: (columnId, leafRows) => number = aggregationFn_uniqueCount; ``` + +Counts unique leaf-row values for a grouped column. + +Values are compared with JavaScript `Set` semantics. + +#### Type Parameters + +##### TFeatures + +`TFeatures` *extends* [`TableFeatures`](../interfaces/TableFeatures.md) + +##### TData + +`TData` *extends* [`RowData`](../type-aliases/RowData.md) + +#### Parameters + +##### columnId + +`string` + +##### leafRows + +[`Row`](../type-aliases/Row.md)\<`TFeatures`, `TData`\>[] + +#### Returns + +`number` diff --git a/docs/reference/index/variables/columnFacetingFeature.md b/docs/reference/index/variables/columnFacetingFeature.md index e3f159a93c..b36a4cd1aa 100644 --- a/docs/reference/index/variables/columnFacetingFeature.md +++ b/docs/reference/index/variables/columnFacetingFeature.md @@ -6,12 +6,9 @@ title: columnFacetingFeature # Variable: columnFacetingFeature ```ts -const columnFacetingFeature: TableFeature>; +const columnFacetingFeature: TableFeature; ``` -Defined in: [features/column-faceting/columnFacetingFeature.ts:120](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-faceting/columnFacetingFeature.ts#L120) +Defined in: [features/column-faceting/columnFacetingFeature.ts:19](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-faceting/columnFacetingFeature.ts#L19) -The stock column faceting feature. - -Register this feature to add faceted row model, unique value, and min/max -helpers for column and global filter UIs. +Feature that derives faceted row models, unique values, and min/max values for filters. diff --git a/docs/reference/index/variables/columnFilteringFeature.md b/docs/reference/index/variables/columnFilteringFeature.md index 71cd1558b4..7559b84742 100644 --- a/docs/reference/index/variables/columnFilteringFeature.md +++ b/docs/reference/index/variables/columnFilteringFeature.md @@ -6,13 +6,9 @@ title: columnFilteringFeature # Variable: columnFilteringFeature ```ts -const columnFilteringFeature: TableFeature>; +const columnFilteringFeature: TableFeature; ``` -Defined in: [features/column-filtering/columnFilteringFeature.ts:129](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-filtering/columnFilteringFeature.ts#L129) +Defined in: [features/column-filtering/columnFilteringFeature.ts:23](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-filtering/columnFilteringFeature.ts#L23) -The stock column filtering feature. - -Register this feature to add column filter state, filter defaults, and -table/row/column APIs for client-side or manual column filtering. Global -filtering is provided by `globalFilteringFeature`. +Feature that adds per-column filtering state, options, and column/table filter APIs. diff --git a/docs/reference/index/variables/columnGroupingFeature.md b/docs/reference/index/variables/columnGroupingFeature.md index 0f11105206..2e347677e9 100644 --- a/docs/reference/index/variables/columnGroupingFeature.md +++ b/docs/reference/index/variables/columnGroupingFeature.md @@ -6,12 +6,9 @@ title: columnGroupingFeature # Variable: columnGroupingFeature ```ts -const columnGroupingFeature: TableFeature>; +const columnGroupingFeature: TableFeature; ``` -Defined in: [features/column-grouping/columnGroupingFeature.ts:159](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/columnGroupingFeature.ts#L159) +Defined in: [features/column-grouping/columnGroupingFeature.ts:28](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/columnGroupingFeature.ts#L28) -The stock column grouping feature. - -Register this feature to add grouping state, aggregation defaults, grouped -row-model support, and table/row/column/cell grouping APIs. +Feature that adds column grouping state, aggregation defaults, and grouped row APIs. diff --git a/docs/reference/index/variables/columnOrderingFeature.md b/docs/reference/index/variables/columnOrderingFeature.md index 28b0e4712f..aad4dbacc6 100644 --- a/docs/reference/index/variables/columnOrderingFeature.md +++ b/docs/reference/index/variables/columnOrderingFeature.md @@ -6,12 +6,9 @@ title: columnOrderingFeature # Variable: columnOrderingFeature ```ts -const columnOrderingFeature: TableFeature>; +const columnOrderingFeature: TableFeature; ``` -Defined in: [features/column-ordering/columnOrderingFeature.ts:105](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-ordering/columnOrderingFeature.ts#L105) +Defined in: [features/column-ordering/columnOrderingFeature.ts:20](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-ordering/columnOrderingFeature.ts#L20) -The stock column ordering feature. - -Register this feature to add column order state and APIs for deriving the -ordered leaf column list alongside grouping and pinning. +Feature that adds column ordering state and APIs for ordering leaf columns. diff --git a/docs/reference/index/variables/columnPinningFeature.md b/docs/reference/index/variables/columnPinningFeature.md index f5950fe46e..8227d95035 100644 --- a/docs/reference/index/variables/columnPinningFeature.md +++ b/docs/reference/index/variables/columnPinningFeature.md @@ -6,12 +6,9 @@ title: columnPinningFeature # Variable: columnPinningFeature ```ts -const columnPinningFeature: TableFeature>; +const columnPinningFeature: TableFeature; ``` -Defined in: [features/column-pinning/columnPinningFeature.ts:346](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-pinning/columnPinningFeature.ts#L346) +Defined in: [features/column-pinning/columnPinningFeature.ts:46](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-pinning/columnPinningFeature.ts#L46) -The stock column pinning feature. - -Register this feature to add column pinning state plus table, row, and column -APIs for splitting columns into left, center, and right regions. +Feature that adds column pinning state and APIs for left, center, and right regions. diff --git a/docs/reference/index/variables/columnResizingFeature.md b/docs/reference/index/variables/columnResizingFeature.md index a649154d58..6589dbb3a4 100644 --- a/docs/reference/index/variables/columnResizingFeature.md +++ b/docs/reference/index/variables/columnResizingFeature.md @@ -6,12 +6,9 @@ title: columnResizingFeature # Variable: columnResizingFeature ```ts -const columnResizingFeature: TableFeature>; +const columnResizingFeature: TableFeature; ``` -Defined in: [features/column-resizing/columnResizingFeature.ts:99](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-resizing/columnResizingFeature.ts#L99) +Defined in: [features/column-resizing/columnResizingFeature.ts:19](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-resizing/columnResizingFeature.ts#L19) -The stock column resizing feature. - -Register this feature with `columnSizingFeature` to add resize interaction -state and APIs for drag-based column resizing. +Feature that adds column resizing state, options, and resize handlers. diff --git a/docs/reference/index/variables/columnSizingFeature.md b/docs/reference/index/variables/columnSizingFeature.md index 8c43c053cb..36b0aa2cae 100644 --- a/docs/reference/index/variables/columnSizingFeature.md +++ b/docs/reference/index/variables/columnSizingFeature.md @@ -6,13 +6,9 @@ title: columnSizingFeature # Variable: columnSizingFeature ```ts -const columnSizingFeature: TableFeature>; +const columnSizingFeature: TableFeature; ``` -Defined in: [features/column-sizing/columnSizingFeature.ts:182](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-sizing/columnSizingFeature.ts#L182) +Defined in: [features/column-sizing/columnSizingFeature.ts:27](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-sizing/columnSizingFeature.ts#L27) -The stock column sizing feature. - -Register this feature to add column width state and table, header, and column -APIs for reading and resetting sizes. Column drag resizing lives in -`columnResizingFeature`. +Feature that adds column sizing state, defaults, and size measurement APIs. diff --git a/docs/reference/index/variables/columnVisibilityFeature.md b/docs/reference/index/variables/columnVisibilityFeature.md index 42e323c8ad..847749bcd1 100644 --- a/docs/reference/index/variables/columnVisibilityFeature.md +++ b/docs/reference/index/variables/columnVisibilityFeature.md @@ -6,12 +6,9 @@ title: columnVisibilityFeature # Variable: columnVisibilityFeature ```ts -const columnVisibilityFeature: TableFeature>; +const columnVisibilityFeature: TableFeature; ``` -Defined in: [features/column-visibility/columnVisibilityFeature.ts:159](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/columnVisibilityFeature.ts#L159) +Defined in: [features/column-visibility/columnVisibilityFeature.ts:28](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/columnVisibilityFeature.ts#L28) -The stock column visibility feature. - -Register this feature to add column visibility state and APIs for deriving -visible columns and visible row cells. +Feature that adds column visibility state and APIs for hiding and showing columns. diff --git a/docs/reference/index/variables/coreCellsFeature.md b/docs/reference/index/variables/coreCellsFeature.md index 67a9033121..f85b2c179d 100644 --- a/docs/reference/index/variables/coreCellsFeature.md +++ b/docs/reference/index/variables/coreCellsFeature.md @@ -6,9 +6,9 @@ title: coreCellsFeature # Variable: coreCellsFeature ```ts -const coreCellsFeature: TableFeature>; +const coreCellsFeature: TableFeature; ``` -Defined in: [core/cells/coreCellsFeature.ts:49](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/cells/coreCellsFeature.ts#L49) +Defined in: [core/cells/coreCellsFeature.ts:12](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/cells/coreCellsFeature.ts#L12) -The Core Cells feature provides the core cell functionality. +Core feature that adds cell value, render, and context APIs. diff --git a/docs/reference/index/variables/coreColumnsFeature.md b/docs/reference/index/variables/coreColumnsFeature.md index cd007627dd..cf277056fa 100644 --- a/docs/reference/index/variables/coreColumnsFeature.md +++ b/docs/reference/index/variables/coreColumnsFeature.md @@ -6,9 +6,9 @@ title: coreColumnsFeature # Variable: coreColumnsFeature ```ts -const coreColumnsFeature: TableFeature>; +const coreColumnsFeature: TableFeature; ``` -Defined in: [core/columns/coreColumnsFeature.ts:100](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/columns/coreColumnsFeature.ts#L100) +Defined in: [core/columns/coreColumnsFeature.ts:18](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/columns/coreColumnsFeature.ts#L18) -The Core Columns feature provides the core column functionality. +Core feature that builds the column tree and exposes table/column column APIs. diff --git a/docs/reference/index/variables/coreHeadersFeature.md b/docs/reference/index/variables/coreHeadersFeature.md index 0b8a000117..33f3b81135 100644 --- a/docs/reference/index/variables/coreHeadersFeature.md +++ b/docs/reference/index/variables/coreHeadersFeature.md @@ -6,9 +6,9 @@ title: coreHeadersFeature # Variable: coreHeadersFeature ```ts -const coreHeadersFeature: TableFeature>; +const coreHeadersFeature: TableFeature; ``` -Defined in: [core/headers/coreHeadersFeature.ts:78](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/headers/coreHeadersFeature.ts#L78) +Defined in: [core/headers/coreHeadersFeature.ts:15](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/headers/coreHeadersFeature.ts#L15) -The Core Headers feature provides the core header functionality. +Core feature that builds header groups and exposes header context APIs. diff --git a/docs/reference/index/variables/coreRowModelsFeature.md b/docs/reference/index/variables/coreRowModelsFeature.md index 9eee100686..1374457ec5 100644 --- a/docs/reference/index/variables/coreRowModelsFeature.md +++ b/docs/reference/index/variables/coreRowModelsFeature.md @@ -6,9 +6,9 @@ title: coreRowModelsFeature # Variable: coreRowModelsFeature ```ts -const coreRowModelsFeature: TableFeature>; +const coreRowModelsFeature: TableFeature; ``` -Defined in: [core/row-models/coreRowModelsFeature.ts:83](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/row-models/coreRowModelsFeature.ts#L83) +Defined in: [core/row-models/coreRowModelsFeature.ts:21](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/row-models/coreRowModelsFeature.ts#L21) -The Core Row Models feature provides the core row model functionality. +Core feature that wires table row-model accessors and row-model caches. diff --git a/docs/reference/index/variables/coreRowsFeature.md b/docs/reference/index/variables/coreRowsFeature.md index 2573b20c99..938ead6d9f 100644 --- a/docs/reference/index/variables/coreRowsFeature.md +++ b/docs/reference/index/variables/coreRowsFeature.md @@ -6,9 +6,9 @@ title: coreRowsFeature # Variable: coreRowsFeature ```ts -const coreRowsFeature: TableFeature>; +const coreRowsFeature: TableFeature; ``` -Defined in: [core/rows/coreRowsFeature.ts:89](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/coreRowsFeature.ts#L89) +Defined in: [core/rows/coreRowsFeature.ts:19](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/coreRowsFeature.ts#L19) -The Core Rows feature provides the core row functionality. +Core feature that creates row APIs for values, cells, and tree traversal. diff --git a/docs/reference/index/variables/coreTablesFeature.md b/docs/reference/index/variables/coreTablesFeature.md index d67579c562..5a3c854691 100644 --- a/docs/reference/index/variables/coreTablesFeature.md +++ b/docs/reference/index/variables/coreTablesFeature.md @@ -6,9 +6,9 @@ title: coreTablesFeature # Variable: coreTablesFeature ```ts -const coreTablesFeature: TableFeature>; +const coreTablesFeature: TableFeature; ``` -Defined in: [core/table/coreTablesFeature.ts:41](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/table/coreTablesFeature.ts#L41) +Defined in: [core/table/coreTablesFeature.ts:8](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/table/coreTablesFeature.ts#L8) -The Core Tables feature provides the core table functionality for handling state and options. +Core feature that adds base table instance APIs such as reset and setOptions. diff --git a/docs/reference/index/variables/filterFn_arrHas.md b/docs/reference/index/variables/filterFn_arrHas.md deleted file mode 100644 index 5d0e408baf..0000000000 --- a/docs/reference/index/variables/filterFn_arrHas.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -id: filterFn_arrHas -title: filterFn_arrHas ---- - -# Variable: filterFn\_arrHas - -```ts -const filterFn_arrHas: FilterFn; -``` - -Defined in: [fns/filterFns.ts:318](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/filterFns.ts#L318) - -Keeps rows whose scalar column value equals at least one filter value. diff --git a/docs/reference/index/variables/filterFn_arrIncludes.md b/docs/reference/index/variables/filterFn_arrIncludes.md index 7354efcbba..3a4e68b541 100644 --- a/docs/reference/index/variables/filterFn_arrIncludes.md +++ b/docs/reference/index/variables/filterFn_arrIncludes.md @@ -6,9 +6,27 @@ title: filterFn_arrIncludes # Variable: filterFn\_arrIncludes ```ts -const filterFn_arrIncludes: FilterFn; +const filterFn_arrIncludes: (row, columnId, filterValue) => boolean & object; ``` -Defined in: [fns/filterFns.ts:332](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/filterFns.ts#L332) +Defined in: [fns/filterFns.ts:307](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/filterFns.ts#L307) Keeps rows whose array or string column value includes at least one filter value. + +## Type Declaration + +### autoRemove() + +```ts +autoRemove: (val) => boolean; +``` + +#### Parameters + +##### val + +`any` + +#### Returns + +`boolean` diff --git a/docs/reference/index/variables/filterFn_arrIncludesAll.md b/docs/reference/index/variables/filterFn_arrIncludesAll.md index ebddd5884d..b252c11148 100644 --- a/docs/reference/index/variables/filterFn_arrIncludesAll.md +++ b/docs/reference/index/variables/filterFn_arrIncludesAll.md @@ -6,9 +6,27 @@ title: filterFn_arrIncludesAll # Variable: filterFn\_arrIncludesAll ```ts -const filterFn_arrIncludesAll: FilterFn; +const filterFn_arrIncludesAll: (row, columnId, filterValue) => boolean & object; ``` -Defined in: [fns/filterFns.ts:352](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/filterFns.ts#L352) +Defined in: [fns/filterFns.ts:325](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/filterFns.ts#L325) Keeps rows whose array column value includes every filter value. + +## Type Declaration + +### autoRemove() + +```ts +autoRemove: (val) => boolean; +``` + +#### Parameters + +##### val + +`any` + +#### Returns + +`boolean` diff --git a/docs/reference/index/variables/filterFn_arrIncludesSome.md b/docs/reference/index/variables/filterFn_arrIncludesSome.md index 07ffa2fefc..73c898606c 100644 --- a/docs/reference/index/variables/filterFn_arrIncludesSome.md +++ b/docs/reference/index/variables/filterFn_arrIncludesSome.md @@ -6,9 +6,27 @@ title: filterFn_arrIncludesSome # Variable: filterFn\_arrIncludesSome ```ts -const filterFn_arrIncludesSome: FilterFn; +const filterFn_arrIncludesSome: (row, columnId, filterValue) => boolean & object; ``` -Defined in: [fns/filterFns.ts:371](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/filterFns.ts#L371) +Defined in: [fns/filterFns.ts:341](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/filterFns.ts#L341) Keeps rows whose array column value includes at least one filter value. + +## Type Declaration + +### autoRemove() + +```ts +autoRemove: (val) => boolean; +``` + +#### Parameters + +##### val + +`any` + +#### Returns + +`boolean` diff --git a/docs/reference/index/variables/filterFn_equals.md b/docs/reference/index/variables/filterFn_equals.md index 640b1e0e8e..f97a170a3a 100644 --- a/docs/reference/index/variables/filterFn_equals.md +++ b/docs/reference/index/variables/filterFn_equals.md @@ -6,11 +6,29 @@ title: filterFn_equals # Variable: filterFn\_equals ```ts -const filterFn_equals: FilterFn; +const filterFn_equals: (row, columnId, filterValue) => boolean & object; ``` -Defined in: [fns/filterFns.ts:13](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/filterFns.ts#L13) +Defined in: [fns/filterFns.ts:12](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/filterFns.ts#L12) Keeps rows whose column value is strictly equal to the filter value. Uses JavaScript `===` comparison and auto-removes empty filter values. + +## Type Declaration + +### autoRemove() + +```ts +autoRemove: (val) => boolean; +``` + +#### Parameters + +##### val + +`any` + +#### Returns + +`boolean` diff --git a/docs/reference/index/variables/filterFn_equalsString.md b/docs/reference/index/variables/filterFn_equalsString.md index 298c800c01..cd9068daab 100644 --- a/docs/reference/index/variables/filterFn_equalsString.md +++ b/docs/reference/index/variables/filterFn_equalsString.md @@ -6,12 +6,30 @@ title: filterFn_equalsString # Variable: filterFn\_equalsString ```ts -const filterFn_equalsString: FilterFn; +const filterFn_equalsString: (row, columnId, filterValue) => boolean & object; ``` -Defined in: [fns/filterFns.ts:98](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/filterFns.ts#L98) +Defined in: [fns/filterFns.ts:89](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/filterFns.ts#L89) Keeps rows whose stringified column value equals the filter text. Both values are lowercased before comparison, and empty filter values are auto-removed. + +## Type Declaration + +### autoRemove() + +```ts +autoRemove: (val) => boolean; +``` + +#### Parameters + +##### val + +`any` + +#### Returns + +`boolean` diff --git a/docs/reference/index/variables/filterFn_equalsStringSensitive.md b/docs/reference/index/variables/filterFn_equalsStringSensitive.md index 11d07923e2..02a5d5c5ba 100644 --- a/docs/reference/index/variables/filterFn_equalsStringSensitive.md +++ b/docs/reference/index/variables/filterFn_equalsStringSensitive.md @@ -6,11 +6,29 @@ title: filterFn_equalsStringSensitive # Variable: filterFn\_equalsStringSensitive ```ts -const filterFn_equalsStringSensitive: FilterFn; +const filterFn_equalsStringSensitive: (row, columnId, filterValue) => boolean & object; ``` -Defined in: [fns/filterFns.ts:119](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/filterFns.ts#L119) +Defined in: [fns/filterFns.ts:108](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/filterFns.ts#L108) Keeps rows whose stringified column value exactly equals the filter text. Matching is case-sensitive and empty filter values are auto-removed. + +## Type Declaration + +### autoRemove() + +```ts +autoRemove: (val) => boolean; +``` + +#### Parameters + +##### val + +`any` + +#### Returns + +`boolean` diff --git a/docs/reference/index/variables/filterFn_greaterThan.md b/docs/reference/index/variables/filterFn_greaterThan.md index 06708c6dd0..57abd46193 100644 --- a/docs/reference/index/variables/filterFn_greaterThan.md +++ b/docs/reference/index/variables/filterFn_greaterThan.md @@ -6,12 +6,30 @@ title: filterFn_greaterThan # Variable: filterFn\_greaterThan ```ts -const filterFn_greaterThan: FilterFn; +const filterFn_greaterThan: (row, columnId, filterValue) => boolean & object; ``` -Defined in: [fns/filterFns.ts:140](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/filterFns.ts#L140) +Defined in: [fns/filterFns.ts:127](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/filterFns.ts#L127) Keeps rows whose value is greater than the filter value. Numeric values are compared numerically when both sides can be coerced to numbers; otherwise normalized strings are compared. + +## Type Declaration + +### resolveFilterValue() + +```ts +resolveFilterValue: (val) => boolean; +``` + +#### Parameters + +##### val + +`any` + +#### Returns + +`boolean` diff --git a/docs/reference/index/variables/filterFn_greaterThanOrEqualTo.md b/docs/reference/index/variables/filterFn_greaterThanOrEqualTo.md index 9e76c5b705..d0a279e388 100644 --- a/docs/reference/index/variables/filterFn_greaterThanOrEqualTo.md +++ b/docs/reference/index/variables/filterFn_greaterThanOrEqualTo.md @@ -6,11 +6,29 @@ title: filterFn_greaterThanOrEqualTo # Variable: filterFn\_greaterThanOrEqualTo ```ts -const filterFn_greaterThanOrEqualTo: FilterFn; +const filterFn_greaterThanOrEqualTo: (row, columnId, filterValue) => boolean & object; ``` -Defined in: [fns/filterFns.ts:169](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/filterFns.ts#L169) +Defined in: [fns/filterFns.ts:154](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/filterFns.ts#L154) Keeps rows whose value is greater than or equal to the filter value. Delegates to the built-in greater-than and equality comparisons. + +## Type Declaration + +### resolveFilterValue() + +```ts +resolveFilterValue: (val) => boolean; +``` + +#### Parameters + +##### val + +`any` + +#### Returns + +`boolean` diff --git a/docs/reference/index/variables/filterFn_inNumberRange.md b/docs/reference/index/variables/filterFn_inNumberRange.md index b51457a9c3..d3b19b5f57 100644 --- a/docs/reference/index/variables/filterFn_inNumberRange.md +++ b/docs/reference/index/variables/filterFn_inNumberRange.md @@ -6,12 +6,46 @@ title: filterFn_inNumberRange # Variable: filterFn\_inNumberRange ```ts -const filterFn_inNumberRange: FilterFn; +const filterFn_inNumberRange: (row, columnId, filterValue) => boolean & object; ``` -Defined in: [fns/filterFns.ts:275](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/filterFns.ts#L275) +Defined in: [fns/filterFns.ts:250](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/filterFns.ts#L250) Keeps rows whose numeric value is inside an inclusive `[min, max]` range. Filter values are normalized so blank endpoints become open-ended and reversed endpoints are swapped. + +## Type Declaration + +### autoRemove() + +```ts +autoRemove: (val) => boolean; +``` + +#### Parameters + +##### val + +`any` + +#### Returns + +`boolean` + +### resolveFilterValue() + +```ts +resolveFilterValue: (val) => readonly [number, number]; +``` + +#### Parameters + +##### val + +\[`any`, `any`\] + +#### Returns + +readonly \[`number`, `number`\] diff --git a/docs/reference/index/variables/filterFn_includesString.md b/docs/reference/index/variables/filterFn_includesString.md index 9594ea3f47..e9aacd943c 100644 --- a/docs/reference/index/variables/filterFn_includesString.md +++ b/docs/reference/index/variables/filterFn_includesString.md @@ -6,12 +6,30 @@ title: filterFn_includesString # Variable: filterFn\_includesString ```ts -const filterFn_includesString: FilterFn; +const filterFn_includesString: (row, columnId, filterValue) => boolean & object; ``` -Defined in: [fns/filterFns.ts:73](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/filterFns.ts#L73) +Defined in: [fns/filterFns.ts:66](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/filterFns.ts#L66) Keeps rows whose stringified column value includes the filter text. Both values are lowercased before comparison, and empty filter values are auto-removed. + +## Type Declaration + +### autoRemove() + +```ts +autoRemove: (val) => boolean; +``` + +#### Parameters + +##### val + +`any` + +#### Returns + +`boolean` diff --git a/docs/reference/index/variables/filterFn_includesStringSensitive.md b/docs/reference/index/variables/filterFn_includesStringSensitive.md index 0e879ad883..9a07dc66df 100644 --- a/docs/reference/index/variables/filterFn_includesStringSensitive.md +++ b/docs/reference/index/variables/filterFn_includesStringSensitive.md @@ -6,11 +6,29 @@ title: filterFn_includesStringSensitive # Variable: filterFn\_includesStringSensitive ```ts -const filterFn_includesStringSensitive: FilterFn; +const filterFn_includesStringSensitive: (row, columnId, filterValue) => boolean & object; ``` -Defined in: [fns/filterFns.ts:52](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/filterFns.ts#L52) +Defined in: [fns/filterFns.ts:47](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/filterFns.ts#L47) Keeps rows whose stringified column value includes the filter text. Matching is case-sensitive and empty filter values are auto-removed. + +## Type Declaration + +### autoRemove() + +```ts +autoRemove: (val) => boolean; +``` + +#### Parameters + +##### val + +`any` + +#### Returns + +`boolean` diff --git a/docs/reference/index/variables/filterFn_lessThan.md b/docs/reference/index/variables/filterFn_lessThan.md index 0c76920d1e..9f4aa0dbb8 100644 --- a/docs/reference/index/variables/filterFn_lessThan.md +++ b/docs/reference/index/variables/filterFn_lessThan.md @@ -6,11 +6,29 @@ title: filterFn_lessThan # Variable: filterFn\_lessThan ```ts -const filterFn_lessThan: FilterFn; +const filterFn_lessThan: (row, columnId, filterValue) => boolean & object; ``` -Defined in: [fns/filterFns.ts:190](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/filterFns.ts#L190) +Defined in: [fns/filterFns.ts:173](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/filterFns.ts#L173) Keeps rows whose value is less than the filter value. This is implemented as the inverse of greater-than-or-equal comparison. + +## Type Declaration + +### resolveFilterValue() + +```ts +resolveFilterValue: (val) => boolean; +``` + +#### Parameters + +##### val + +`any` + +#### Returns + +`boolean` diff --git a/docs/reference/index/variables/filterFn_lessThanOrEqualTo.md b/docs/reference/index/variables/filterFn_lessThanOrEqualTo.md index 8e9da30ebc..88c9783573 100644 --- a/docs/reference/index/variables/filterFn_lessThanOrEqualTo.md +++ b/docs/reference/index/variables/filterFn_lessThanOrEqualTo.md @@ -6,11 +6,29 @@ title: filterFn_lessThanOrEqualTo # Variable: filterFn\_lessThanOrEqualTo ```ts -const filterFn_lessThanOrEqualTo: FilterFn; +const filterFn_lessThanOrEqualTo: (row, columnId, filterValue) => boolean & object; ``` -Defined in: [fns/filterFns.ts:208](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/filterFns.ts#L208) +Defined in: [fns/filterFns.ts:189](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/filterFns.ts#L189) Keeps rows whose value is less than or equal to the filter value. This is implemented as the inverse of greater-than comparison. + +## Type Declaration + +### resolveFilterValue() + +```ts +resolveFilterValue: (val) => boolean; +``` + +#### Parameters + +##### val + +`any` + +#### Returns + +`boolean` diff --git a/docs/reference/index/variables/filterFn_weakEquals.md b/docs/reference/index/variables/filterFn_weakEquals.md index 6afed75e18..111ff4599a 100644 --- a/docs/reference/index/variables/filterFn_weakEquals.md +++ b/docs/reference/index/variables/filterFn_weakEquals.md @@ -6,12 +6,30 @@ title: filterFn_weakEquals # Variable: filterFn\_weakEquals ```ts -const filterFn_weakEquals: FilterFn; +const filterFn_weakEquals: (row, columnId, filterValue) => boolean & object; ``` -Defined in: [fns/filterFns.ts:32](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/filterFns.ts#L32) +Defined in: [fns/filterFns.ts:29](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/filterFns.ts#L29) Keeps rows whose column value is loosely equal to the filter value. Uses JavaScript `==` comparison and auto-removes empty filter values. This is useful for matching string input against numeric row values. + +## Type Declaration + +### autoRemove() + +```ts +autoRemove: (val) => boolean; +``` + +#### Parameters + +##### val + +`any` + +#### Returns + +`boolean` diff --git a/docs/reference/index/variables/filterFns.md b/docs/reference/index/variables/filterFns.md index ee4df3bf38..3bf052f242 100644 --- a/docs/reference/index/variables/filterFns.md +++ b/docs/reference/index/variables/filterFns.md @@ -9,7 +9,7 @@ title: filterFns const filterFns: object; ``` -Defined in: [fns/filterFns.ts:394](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/filterFns.ts#L394) +Defined in: [fns/filterFns.ts:361](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/filterFns.ts#L361) The built-in filter function registry. @@ -17,74 +17,318 @@ Pass this object to filtered row model creation or extend it with custom filter ## Type Declaration -### arrHas +### arrHas() ```ts -arrHas: FilterFn = filterFn_arrHas; +arrHas: (row, columnId, filterValue) => boolean = filterFn_arrHas; ``` +Keeps rows whose scalar column value equals at least one filter value. + +#### Type Parameters + +##### TFeatures + +`TFeatures` *extends* [`TableFeatures`](../interfaces/TableFeatures.md) + +##### TData + +`TData` *extends* [`RowData`](../type-aliases/RowData.md) + +#### Parameters + +##### row + +[`Row`](../type-aliases/Row.md)\<`TFeatures`, `TData`\> + +##### columnId + +`string` + +##### filterValue + +`unknown`[] + +#### Returns + +`boolean` + ### arrIncludes ```ts -arrIncludes: FilterFn = filterFn_arrIncludes; +arrIncludes: (row, columnId, filterValue) => boolean & object = filterFn_arrIncludes; +``` + +#### Type Declaration + +##### autoRemove() + +```ts +autoRemove: (val) => boolean; ``` +###### Parameters + +###### val + +`any` + +###### Returns + +`boolean` + ### arrIncludesAll ```ts -arrIncludesAll: FilterFn = filterFn_arrIncludesAll; +arrIncludesAll: (row, columnId, filterValue) => boolean & object = filterFn_arrIncludesAll; ``` +#### Type Declaration + +##### autoRemove() + +```ts +autoRemove: (val) => boolean; +``` + +###### Parameters + +###### val + +`any` + +###### Returns + +`boolean` + ### arrIncludesSome ```ts -arrIncludesSome: FilterFn = filterFn_arrIncludesSome; +arrIncludesSome: (row, columnId, filterValue) => boolean & object = filterFn_arrIncludesSome; ``` +#### Type Declaration + +##### autoRemove() + +```ts +autoRemove: (val) => boolean; +``` + +###### Parameters + +###### val + +`any` + +###### Returns + +`boolean` + ### between ```ts -between: FilterFn = filterFn_between; +between: (row, columnId, filterValues) => boolean & object = filterFn_between; +``` + +#### Type Declaration + +##### autoRemove() + +```ts +autoRemove: (val) => boolean; ``` +###### Parameters + +###### val + +`any` + +###### Returns + +`boolean` + ### betweenInclusive ```ts -betweenInclusive: FilterFn = filterFn_betweenInclusive; +betweenInclusive: (row, columnId, filterValues) => boolean & object = filterFn_betweenInclusive; +``` + +#### Type Declaration + +##### autoRemove() + +```ts +autoRemove: (val) => boolean; ``` +###### Parameters + +###### val + +`any` + +###### Returns + +`boolean` + ### equals ```ts -equals: FilterFn = filterFn_equals; +equals: (row, columnId, filterValue) => boolean & object = filterFn_equals; +``` + +#### Type Declaration + +##### autoRemove() + +```ts +autoRemove: (val) => boolean; ``` +###### Parameters + +###### val + +`any` + +###### Returns + +`boolean` + ### equalsString ```ts -equalsString: FilterFn = filterFn_equalsString; +equalsString: (row, columnId, filterValue) => boolean & object = filterFn_equalsString; ``` +#### Type Declaration + +##### autoRemove() + +```ts +autoRemove: (val) => boolean; +``` + +###### Parameters + +###### val + +`any` + +###### Returns + +`boolean` + ### includesString ```ts -includesString: FilterFn = filterFn_includesString; +includesString: (row, columnId, filterValue) => boolean & object = filterFn_includesString; ``` +#### Type Declaration + +##### autoRemove() + +```ts +autoRemove: (val) => boolean; +``` + +###### Parameters + +###### val + +`any` + +###### Returns + +`boolean` + ### includesStringSensitive ```ts -includesStringSensitive: FilterFn = filterFn_includesStringSensitive; +includesStringSensitive: (row, columnId, filterValue) => boolean & object = filterFn_includesStringSensitive; +``` + +#### Type Declaration + +##### autoRemove() + +```ts +autoRemove: (val) => boolean; ``` +###### Parameters + +###### val + +`any` + +###### Returns + +`boolean` + ### inNumberRange ```ts -inNumberRange: FilterFn = filterFn_inNumberRange; +inNumberRange: (row, columnId, filterValue) => boolean & object = filterFn_inNumberRange; +``` + +#### Type Declaration + +##### autoRemove() + +```ts +autoRemove: (val) => boolean; ``` +###### Parameters + +###### val + +`any` + +###### Returns + +`boolean` + +##### resolveFilterValue() + +```ts +resolveFilterValue: (val) => readonly [number, number]; +``` + +###### Parameters + +###### val + +\[`any`, `any`\] + +###### Returns + +readonly \[`number`, `number`\] + ### weakEquals ```ts -weakEquals: FilterFn = filterFn_weakEquals; +weakEquals: (row, columnId, filterValue) => boolean & object = filterFn_weakEquals; +``` + +#### Type Declaration + +##### autoRemove() + +```ts +autoRemove: (val) => boolean; ``` + +###### Parameters + +###### val + +`any` + +###### Returns + +`boolean` diff --git a/docs/reference/index/variables/globalFilteringFeature.md b/docs/reference/index/variables/globalFilteringFeature.md index 6209716142..28db17619e 100644 --- a/docs/reference/index/variables/globalFilteringFeature.md +++ b/docs/reference/index/variables/globalFilteringFeature.md @@ -6,12 +6,9 @@ title: globalFilteringFeature # Variable: globalFilteringFeature ```ts -const globalFilteringFeature: TableFeature>; +const globalFilteringFeature: TableFeature; ``` -Defined in: [features/global-filtering/globalFilteringFeature.ts:99](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/global-filtering/globalFilteringFeature.ts#L99) +Defined in: [features/global-filtering/globalFilteringFeature.ts:18](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/global-filtering/globalFilteringFeature.ts#L18) -The stock global filtering feature. - -Register this feature with column filtering support to add global filter -state, global filter function resolution, and column eligibility APIs. +Feature that adds global filtering state, defaults, and global filter APIs. diff --git a/docs/reference/index/variables/reSplitAlphaNumeric.md b/docs/reference/index/variables/reSplitAlphaNumeric.md index 56f11267f8..abf627c26b 100644 --- a/docs/reference/index/variables/reSplitAlphaNumeric.md +++ b/docs/reference/index/variables/reSplitAlphaNumeric.md @@ -9,7 +9,7 @@ title: reSplitAlphaNumeric const reSplitAlphaNumeric: RegExp; ``` -Defined in: [fns/sortFns.ts:12](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/sortFns.ts#L12) +Defined in: [fns/sortFns.ts:11](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/sortFns.ts#L11) Regular expression used to split mixed text and numeric chunks. diff --git a/docs/reference/index/variables/rowExpandingFeature.md b/docs/reference/index/variables/rowExpandingFeature.md index e401f36004..d3fb99a591 100644 --- a/docs/reference/index/variables/rowExpandingFeature.md +++ b/docs/reference/index/variables/rowExpandingFeature.md @@ -6,12 +6,9 @@ title: rowExpandingFeature # Variable: rowExpandingFeature ```ts -const rowExpandingFeature: TableFeature>; +const rowExpandingFeature: TableFeature; ``` -Defined in: [features/row-expanding/rowExpandingFeature.ts:130](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-expanding/rowExpandingFeature.ts#L130) +Defined in: [features/row-expanding/rowExpandingFeature.ts:28](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-expanding/rowExpandingFeature.ts#L28) -The stock row expanding feature. - -Register this feature to add expanded row state, row expansion APIs, and -helpers for deriving expanded row models and expansion depth. +Feature that adds row expansion state and APIs for expandable row trees. diff --git a/docs/reference/index/variables/rowPaginationFeature.md b/docs/reference/index/variables/rowPaginationFeature.md index ac4d4e8cab..ba6fced5ba 100644 --- a/docs/reference/index/variables/rowPaginationFeature.md +++ b/docs/reference/index/variables/rowPaginationFeature.md @@ -6,12 +6,9 @@ title: rowPaginationFeature # Variable: rowPaginationFeature ```ts -const rowPaginationFeature: TableFeature>; +const rowPaginationFeature: TableFeature; ``` -Defined in: [features/row-pagination/rowPaginationFeature.ts:129](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pagination/rowPaginationFeature.ts#L129) +Defined in: [features/row-pagination/rowPaginationFeature.ts:26](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pagination/rowPaginationFeature.ts#L26) -The stock row pagination feature. - -Register this feature to add pagination state, page navigation APIs, and -pagination-aware row model helpers to a table. +Feature that adds pagination state and table APIs for page navigation. diff --git a/docs/reference/index/variables/rowPinningFeature.md b/docs/reference/index/variables/rowPinningFeature.md index 309fdab8ae..08769c84b0 100644 --- a/docs/reference/index/variables/rowPinningFeature.md +++ b/docs/reference/index/variables/rowPinningFeature.md @@ -6,12 +6,9 @@ title: rowPinningFeature # Variable: rowPinningFeature ```ts -const rowPinningFeature: TableFeature>; +const rowPinningFeature: TableFeature; ``` -Defined in: [features/row-pinning/rowPinningFeature.ts:129](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pinning/rowPinningFeature.ts#L129) +Defined in: [features/row-pinning/rowPinningFeature.ts:24](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pinning/rowPinningFeature.ts#L24) -The stock row pinning feature. - -Register this feature to add row pinning state and APIs for deriving top, -center, and bottom row regions. +Feature that adds row pinning state and APIs for top, center, and bottom rows. diff --git a/docs/reference/index/variables/rowSelectionFeature.md b/docs/reference/index/variables/rowSelectionFeature.md index 87e8e539ae..2386fd47e4 100644 --- a/docs/reference/index/variables/rowSelectionFeature.md +++ b/docs/reference/index/variables/rowSelectionFeature.md @@ -6,12 +6,9 @@ title: rowSelectionFeature # Variable: rowSelectionFeature ```ts -const rowSelectionFeature: TableFeature>; +const rowSelectionFeature: TableFeature; ``` -Defined in: [features/row-selection/rowSelectionFeature.ts:172](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/rowSelectionFeature.ts#L172) +Defined in: [features/row-selection/rowSelectionFeature.ts:36](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/rowSelectionFeature.ts#L36) -The stock row selection feature. - -Register this feature to add row selection state, selected row-model helpers, -and table/row APIs for checkbox and bulk-selection UI. +Feature that adds row selection state and APIs for row and page selection. diff --git a/docs/reference/index/variables/rowSortingFeature.md b/docs/reference/index/variables/rowSortingFeature.md index 9f43b6948d..ff6217c153 100644 --- a/docs/reference/index/variables/rowSortingFeature.md +++ b/docs/reference/index/variables/rowSortingFeature.md @@ -6,12 +6,9 @@ title: rowSortingFeature # Variable: rowSortingFeature ```ts -const rowSortingFeature: TableFeature>; +const rowSortingFeature: TableFeature; ``` -Defined in: [features/row-sorting/rowSortingFeature.ts:144](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/rowSortingFeature.ts#L144) +Defined in: [features/row-sorting/rowSortingFeature.ts:28](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/rowSortingFeature.ts#L28) -The stock row sorting feature. - -Register this feature to add sorting state, column sorting APIs, and sorted -row-model support for client-side or manual sorting. +Feature that adds row sorting state, defaults, and column/table sorting APIs. diff --git a/docs/reference/index/variables/sortFn_alphanumeric.md b/docs/reference/index/variables/sortFn_alphanumeric.md deleted file mode 100644 index d2d3852901..0000000000 --- a/docs/reference/index/variables/sortFn_alphanumeric.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -id: sortFn_alphanumeric -title: sortFn_alphanumeric ---- - -# Variable: sortFn\_alphanumeric - -```ts -const sortFn_alphanumeric: SortFn; -``` - -Defined in: [fns/sortFns.ts:19](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/sortFns.ts#L19) - -Sorts rows with the built-in alphanumeric strategy. - -This comparator returns ascending-order results; descending order is applied by the sorting row model. diff --git a/docs/reference/index/variables/sortFn_alphanumericCaseSensitive.md b/docs/reference/index/variables/sortFn_alphanumericCaseSensitive.md deleted file mode 100644 index bd96055c78..0000000000 --- a/docs/reference/index/variables/sortFn_alphanumericCaseSensitive.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -id: sortFn_alphanumericCaseSensitive -title: sortFn_alphanumericCaseSensitive ---- - -# Variable: sortFn\_alphanumericCaseSensitive - -```ts -const sortFn_alphanumericCaseSensitive: SortFn; -``` - -Defined in: [fns/sortFns.ts:38](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/sortFns.ts#L38) - -Sorts rows with the built-in alphanumeric case sensitive strategy. - -This comparator returns ascending-order results; descending order is applied by the sorting row model. diff --git a/docs/reference/index/variables/sortFn_basic.md b/docs/reference/index/variables/sortFn_basic.md deleted file mode 100644 index 14348318bb..0000000000 --- a/docs/reference/index/variables/sortFn_basic.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -id: sortFn_basic -title: sortFn_basic ---- - -# Variable: sortFn\_basic - -```ts -const sortFn_basic: SortFn; -``` - -Defined in: [fns/sortFns.ts:121](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/sortFns.ts#L121) - -Sorts rows with the built-in basic strategy. - -This comparator returns ascending-order results; descending order is applied by the sorting row model. diff --git a/docs/reference/index/variables/sortFn_datetime.md b/docs/reference/index/variables/sortFn_datetime.md deleted file mode 100644 index 604db2b469..0000000000 --- a/docs/reference/index/variables/sortFn_datetime.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -id: sortFn_datetime -title: sortFn_datetime ---- - -# Variable: sortFn\_datetime - -```ts -const sortFn_datetime: SortFn; -``` - -Defined in: [fns/sortFns.ts:99](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/sortFns.ts#L99) - -Sorts rows with the built-in datetime strategy. - -This comparator returns ascending-order results; descending order is applied by the sorting row model. diff --git a/docs/reference/index/variables/sortFn_text.md b/docs/reference/index/variables/sortFn_text.md deleted file mode 100644 index 53ed9f46ba..0000000000 --- a/docs/reference/index/variables/sortFn_text.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -id: sortFn_text -title: sortFn_text ---- - -# Variable: sortFn\_text - -```ts -const sortFn_text: SortFn; -``` - -Defined in: [fns/sortFns.ts:59](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/sortFns.ts#L59) - -Sorts rows with the built-in text strategy. - -This comparator returns ascending-order results; descending order is applied by the sorting row model. diff --git a/docs/reference/index/variables/sortFn_textCaseSensitive.md b/docs/reference/index/variables/sortFn_textCaseSensitive.md deleted file mode 100644 index 513234dccb..0000000000 --- a/docs/reference/index/variables/sortFn_textCaseSensitive.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -id: sortFn_textCaseSensitive -title: sortFn_textCaseSensitive ---- - -# Variable: sortFn\_textCaseSensitive - -```ts -const sortFn_textCaseSensitive: SortFn; -``` - -Defined in: [fns/sortFns.ts:80](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/sortFns.ts#L80) - -Sorts rows with the built-in text case sensitive strategy. - -This comparator returns ascending-order results; descending order is applied by the sorting row model. diff --git a/docs/reference/index/variables/sortFns.md b/docs/reference/index/variables/sortFns.md index 9abec29ddc..9b65993c85 100644 --- a/docs/reference/index/variables/sortFns.md +++ b/docs/reference/index/variables/sortFns.md @@ -9,7 +9,7 @@ title: sortFns const sortFns: object; ``` -Defined in: [fns/sortFns.ts:209](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/sortFns.ts#L209) +Defined in: [fns/sortFns.ts:208](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/sortFns.ts#L208) The built-in sorting function registry. @@ -17,38 +17,230 @@ Pass this object to sorted row model creation or extend it with custom sorting f ## Type Declaration -### alphanumeric +### alphanumeric() ```ts -alphanumeric: SortFn = sortFn_alphanumeric; +alphanumeric: (rowA, rowB, columnId) => number = sortFn_alphanumeric; ``` -### alphanumericCaseSensitive +Sorts rows with the built-in alphanumeric strategy. + +This comparator returns ascending-order results; descending order is applied by the sorting row model. + +#### Type Parameters + +##### TFeatures + +`TFeatures` *extends* [`TableFeatures`](../interfaces/TableFeatures.md) + +##### TData + +`TData` *extends* [`RowData`](../type-aliases/RowData.md) + +#### Parameters + +##### rowA + +[`Row`](../type-aliases/Row.md)\<`TFeatures`, `TData`\> + +##### rowB + +[`Row`](../type-aliases/Row.md)\<`TFeatures`, `TData`\> + +##### columnId + +`string` + +#### Returns + +`number` + +### alphanumericCaseSensitive() ```ts -alphanumericCaseSensitive: SortFn = sortFn_alphanumericCaseSensitive; +alphanumericCaseSensitive: (rowA, rowB, columnId) => number = sortFn_alphanumericCaseSensitive; ``` -### basic +Sorts rows with the built-in alphanumeric case sensitive strategy. + +This comparator returns ascending-order results; descending order is applied by the sorting row model. + +#### Type Parameters + +##### TFeatures + +`TFeatures` *extends* [`TableFeatures`](../interfaces/TableFeatures.md) + +##### TData + +`TData` *extends* [`RowData`](../type-aliases/RowData.md) + +#### Parameters + +##### rowA + +[`Row`](../type-aliases/Row.md)\<`TFeatures`, `TData`\> + +##### rowB + +[`Row`](../type-aliases/Row.md)\<`TFeatures`, `TData`\> + +##### columnId + +`string` + +#### Returns + +`number` + +### basic() ```ts -basic: SortFn = sortFn_basic; +basic: (rowA, rowB, columnId) => -1 | 0 | 1 = sortFn_basic; ``` -### datetime +Sorts rows with the built-in basic strategy. + +This comparator returns ascending-order results; descending order is applied by the sorting row model. + +#### Type Parameters + +##### TFeatures + +`TFeatures` *extends* [`TableFeatures`](../interfaces/TableFeatures.md) + +##### TData + +`TData` *extends* [`RowData`](../type-aliases/RowData.md) + +#### Parameters + +##### rowA + +[`Row`](../type-aliases/Row.md)\<`TFeatures`, `TData`\> + +##### rowB + +[`Row`](../type-aliases/Row.md)\<`TFeatures`, `TData`\> + +##### columnId + +`string` + +#### Returns + +`-1` \| `0` \| `1` + +### datetime() ```ts -datetime: SortFn = sortFn_datetime; +datetime: (rowA, rowB, columnId) => -1 | 0 | 1 = sortFn_datetime; ``` -### text +Sorts rows with the built-in datetime strategy. + +This comparator returns ascending-order results; descending order is applied by the sorting row model. + +#### Type Parameters + +##### TFeatures + +`TFeatures` *extends* [`TableFeatures`](../interfaces/TableFeatures.md) + +##### TData + +`TData` *extends* [`RowData`](../type-aliases/RowData.md) + +#### Parameters + +##### rowA + +[`Row`](../type-aliases/Row.md)\<`TFeatures`, `TData`\> + +##### rowB + +[`Row`](../type-aliases/Row.md)\<`TFeatures`, `TData`\> + +##### columnId + +`string` + +#### Returns + +`-1` \| `0` \| `1` + +### text() ```ts -text: SortFn = sortFn_text; +text: (rowA, rowB, columnId) => -1 | 0 | 1 = sortFn_text; ``` -### textCaseSensitive +Sorts rows with the built-in text strategy. + +This comparator returns ascending-order results; descending order is applied by the sorting row model. + +#### Type Parameters + +##### TFeatures + +`TFeatures` *extends* [`TableFeatures`](../interfaces/TableFeatures.md) + +##### TData + +`TData` *extends* [`RowData`](../type-aliases/RowData.md) + +#### Parameters + +##### rowA + +[`Row`](../type-aliases/Row.md)\<`TFeatures`, `TData`\> + +##### rowB + +[`Row`](../type-aliases/Row.md)\<`TFeatures`, `TData`\> + +##### columnId + +`string` + +#### Returns + +`-1` \| `0` \| `1` + +### textCaseSensitive() ```ts -textCaseSensitive: SortFn = sortFn_textCaseSensitive; +textCaseSensitive: (rowA, rowB, columnId) => -1 | 0 | 1 = sortFn_textCaseSensitive; ``` + +Sorts rows with the built-in text case sensitive strategy. + +This comparator returns ascending-order results; descending order is applied by the sorting row model. + +#### Type Parameters + +##### TFeatures + +`TFeatures` *extends* [`TableFeatures`](../interfaces/TableFeatures.md) + +##### TData + +`TData` *extends* [`RowData`](../type-aliases/RowData.md) + +#### Parameters + +##### rowA + +[`Row`](../type-aliases/Row.md)\<`TFeatures`, `TData`\> + +##### rowB + +[`Row`](../type-aliases/Row.md)\<`TFeatures`, `TData`\> + +##### columnId + +`string` + +#### Returns + +`-1` \| `0` \| `1` diff --git a/docs/reference/static-functions/functions/cell_getIsAggregated.md b/docs/reference/static-functions/functions/cell_getIsAggregated.md index 95d2ff0707..8d1e5624e7 100644 --- a/docs/reference/static-functions/functions/cell_getIsAggregated.md +++ b/docs/reference/static-functions/functions/cell_getIsAggregated.md @@ -9,7 +9,7 @@ title: cell_getIsAggregated function cell_getIsAggregated(cell): boolean; ``` -Defined in: [features/column-grouping/columnGroupingFeature.utils.ts:345](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/columnGroupingFeature.utils.ts#L345) +Defined in: [features/column-grouping/columnGroupingFeature.utils.ts:344](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/columnGroupingFeature.utils.ts#L344) Checks whether this cell should render an aggregated value. diff --git a/docs/reference/static-functions/functions/cell_getIsGrouped.md b/docs/reference/static-functions/functions/cell_getIsGrouped.md index 2ff3c55ff6..bc77ffb31f 100644 --- a/docs/reference/static-functions/functions/cell_getIsGrouped.md +++ b/docs/reference/static-functions/functions/cell_getIsGrouped.md @@ -9,7 +9,7 @@ title: cell_getIsGrouped function cell_getIsGrouped(cell): boolean; ``` -Defined in: [features/column-grouping/columnGroupingFeature.utils.ts:304](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/columnGroupingFeature.utils.ts#L304) +Defined in: [features/column-grouping/columnGroupingFeature.utils.ts:303](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/columnGroupingFeature.utils.ts#L303) Checks whether this cell represents the grouped column for a grouped row. diff --git a/docs/reference/static-functions/functions/cell_getIsPlaceholder.md b/docs/reference/static-functions/functions/cell_getIsPlaceholder.md index 1289b970a0..e586385e39 100644 --- a/docs/reference/static-functions/functions/cell_getIsPlaceholder.md +++ b/docs/reference/static-functions/functions/cell_getIsPlaceholder.md @@ -9,7 +9,7 @@ title: cell_getIsPlaceholder function cell_getIsPlaceholder(cell): boolean; ``` -Defined in: [features/column-grouping/columnGroupingFeature.utils.ts:326](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/columnGroupingFeature.utils.ts#L326) +Defined in: [features/column-grouping/columnGroupingFeature.utils.ts:325](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/columnGroupingFeature.utils.ts#L325) Checks whether this cell is a placeholder hidden by grouping. diff --git a/docs/reference/static-functions/functions/column_getAggregationFn.md b/docs/reference/static-functions/functions/column_getAggregationFn.md index 46d369df88..0017aa2a1b 100644 --- a/docs/reference/static-functions/functions/column_getAggregationFn.md +++ b/docs/reference/static-functions/functions/column_getAggregationFn.md @@ -11,7 +11,7 @@ function column_getAggregationFn(column): | undefined; ``` -Defined in: [features/column-grouping/columnGroupingFeature.utils.ts:184](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/columnGroupingFeature.utils.ts#L184) +Defined in: [features/column-grouping/columnGroupingFeature.utils.ts:183](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/columnGroupingFeature.utils.ts#L183) Resolves the aggregation function configured for a column. diff --git a/docs/reference/static-functions/functions/column_getAutoAggregationFn.md b/docs/reference/static-functions/functions/column_getAutoAggregationFn.md index 915896d878..adeebe2cd9 100644 --- a/docs/reference/static-functions/functions/column_getAutoAggregationFn.md +++ b/docs/reference/static-functions/functions/column_getAutoAggregationFn.md @@ -11,7 +11,7 @@ function column_getAutoAggregationFn(column): | undefined; ``` -Defined in: [features/column-grouping/columnGroupingFeature.utils.ts:150](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/columnGroupingFeature.utils.ts#L150) +Defined in: [features/column-grouping/columnGroupingFeature.utils.ts:149](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/columnGroupingFeature.utils.ts#L149) Chooses a built-in aggregation function from the first core row value. diff --git a/docs/reference/static-functions/functions/column_getAutoFilterFn.md b/docs/reference/static-functions/functions/column_getAutoFilterFn.md index 5578e118ea..b51af175a7 100644 --- a/docs/reference/static-functions/functions/column_getAutoFilterFn.md +++ b/docs/reference/static-functions/functions/column_getAutoFilterFn.md @@ -7,7 +7,7 @@ title: column_getAutoFilterFn ```ts function column_getAutoFilterFn(column): - | FilterFn + | FilterFn | undefined; ``` @@ -41,7 +41,7 @@ to `weakEquals`. ## Returns - \| [`FilterFn`](../../index/interfaces/FilterFn.md)\<`TFeatures`, `TData`\> + \| [`FilterFn`](../../index/interfaces/FilterFn.md)\<`TFeatures`, [`RowData`](../../index/type-aliases/RowData.md)\> \| `undefined` ## Example diff --git a/docs/reference/static-functions/functions/column_getCanGroup.md b/docs/reference/static-functions/functions/column_getCanGroup.md index 37713c248e..5d7b49694d 100644 --- a/docs/reference/static-functions/functions/column_getCanGroup.md +++ b/docs/reference/static-functions/functions/column_getCanGroup.md @@ -9,7 +9,7 @@ title: column_getCanGroup function column_getCanGroup(column): boolean; ``` -Defined in: [features/column-grouping/columnGroupingFeature.utils.ts:67](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/columnGroupingFeature.utils.ts#L67) +Defined in: [features/column-grouping/columnGroupingFeature.utils.ts:66](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/columnGroupingFeature.utils.ts#L66) Checks whether this column can be used for grouping. diff --git a/docs/reference/static-functions/functions/column_getCanResize.md b/docs/reference/static-functions/functions/column_getCanResize.md index 381f3626fe..59a9de4e40 100644 --- a/docs/reference/static-functions/functions/column_getCanResize.md +++ b/docs/reference/static-functions/functions/column_getCanResize.md @@ -9,7 +9,7 @@ title: column_getCanResize function column_getCanResize(column): boolean; ``` -Defined in: [features/column-resizing/columnResizingFeature.utils.ts:49](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-resizing/columnResizingFeature.utils.ts#L49) +Defined in: [features/column-resizing/columnResizingFeature.utils.ts:48](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-resizing/columnResizingFeature.utils.ts#L48) Checks whether this column can start a resize interaction. diff --git a/docs/reference/static-functions/functions/column_getGroupedIndex.md b/docs/reference/static-functions/functions/column_getGroupedIndex.md index cd7e92eec4..5cdec984ee 100644 --- a/docs/reference/static-functions/functions/column_getGroupedIndex.md +++ b/docs/reference/static-functions/functions/column_getGroupedIndex.md @@ -9,7 +9,7 @@ title: column_getGroupedIndex function column_getGroupedIndex(column): number; ``` -Defined in: [features/column-grouping/columnGroupingFeature.utils.ts:108](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/columnGroupingFeature.utils.ts#L108) +Defined in: [features/column-grouping/columnGroupingFeature.utils.ts:107](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/columnGroupingFeature.utils.ts#L107) Finds this column's position in the ordered grouping state. diff --git a/docs/reference/static-functions/functions/column_getIsGrouped.md b/docs/reference/static-functions/functions/column_getIsGrouped.md index 7d8ebf4a56..2d22012aac 100644 --- a/docs/reference/static-functions/functions/column_getIsGrouped.md +++ b/docs/reference/static-functions/functions/column_getIsGrouped.md @@ -9,7 +9,7 @@ title: column_getIsGrouped function column_getIsGrouped(column): boolean; ``` -Defined in: [features/column-grouping/columnGroupingFeature.utils.ts:90](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/columnGroupingFeature.utils.ts#L90) +Defined in: [features/column-grouping/columnGroupingFeature.utils.ts:89](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/columnGroupingFeature.utils.ts#L89) Checks whether this column id is present in `state.grouping`. diff --git a/docs/reference/static-functions/functions/column_getIsResizing.md b/docs/reference/static-functions/functions/column_getIsResizing.md index d81389bfa3..85bec7b824 100644 --- a/docs/reference/static-functions/functions/column_getIsResizing.md +++ b/docs/reference/static-functions/functions/column_getIsResizing.md @@ -9,7 +9,7 @@ title: column_getIsResizing function column_getIsResizing(column): boolean; ``` -Defined in: [features/column-resizing/columnResizingFeature.utils.ts:70](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-resizing/columnResizingFeature.utils.ts#L70) +Defined in: [features/column-resizing/columnResizingFeature.utils.ts:69](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-resizing/columnResizingFeature.utils.ts#L69) Checks whether this column is the active column resize target. diff --git a/docs/reference/static-functions/functions/column_getToggleGroupingHandler.md b/docs/reference/static-functions/functions/column_getToggleGroupingHandler.md index 80f29a6aac..d913c12b1b 100644 --- a/docs/reference/static-functions/functions/column_getToggleGroupingHandler.md +++ b/docs/reference/static-functions/functions/column_getToggleGroupingHandler.md @@ -9,7 +9,7 @@ title: column_getToggleGroupingHandler function column_getToggleGroupingHandler(column): () => void; ``` -Defined in: [features/column-grouping/columnGroupingFeature.utils.ts:126](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/columnGroupingFeature.utils.ts#L126) +Defined in: [features/column-grouping/columnGroupingFeature.utils.ts:125](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/columnGroupingFeature.utils.ts#L125) Creates a header/control handler that toggles grouping for this column. diff --git a/docs/reference/static-functions/functions/column_toggleGrouping.md b/docs/reference/static-functions/functions/column_toggleGrouping.md index 40f0070799..2b07cf525f 100644 --- a/docs/reference/static-functions/functions/column_toggleGrouping.md +++ b/docs/reference/static-functions/functions/column_toggleGrouping.md @@ -9,7 +9,7 @@ title: column_toggleGrouping function column_toggleGrouping(column): void; ``` -Defined in: [features/column-grouping/columnGroupingFeature.utils.ts:41](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/columnGroupingFeature.utils.ts#L41) +Defined in: [features/column-grouping/columnGroupingFeature.utils.ts:40](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/columnGroupingFeature.utils.ts#L40) Adds or removes this column id from the grouping state. diff --git a/docs/reference/static-functions/functions/getDefaultColumnResizingState.md b/docs/reference/static-functions/functions/getDefaultColumnResizingState.md index d4ad695e73..5e8ef49f07 100644 --- a/docs/reference/static-functions/functions/getDefaultColumnResizingState.md +++ b/docs/reference/static-functions/functions/getDefaultColumnResizingState.md @@ -9,7 +9,7 @@ title: getDefaultColumnResizingState function getDefaultColumnResizingState(): columnResizingState; ``` -Defined in: [features/column-resizing/columnResizingFeature.utils.ts:27](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-resizing/columnResizingFeature.utils.ts#L27) +Defined in: [features/column-resizing/columnResizingFeature.utils.ts:26](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-resizing/columnResizingFeature.utils.ts#L26) Creates the default transient column resizing state. diff --git a/docs/reference/static-functions/functions/getDefaultGroupingState.md b/docs/reference/static-functions/functions/getDefaultGroupingState.md index cade3316fa..e318b9a7be 100644 --- a/docs/reference/static-functions/functions/getDefaultGroupingState.md +++ b/docs/reference/static-functions/functions/getDefaultGroupingState.md @@ -9,7 +9,7 @@ title: getDefaultGroupingState function getDefaultGroupingState(): GroupingState; ``` -Defined in: [features/column-grouping/columnGroupingFeature.utils.ts:26](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/columnGroupingFeature.utils.ts#L26) +Defined in: [features/column-grouping/columnGroupingFeature.utils.ts:25](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/columnGroupingFeature.utils.ts#L25) Creates the default grouping state. diff --git a/docs/reference/static-functions/functions/header_getResizeHandler.md b/docs/reference/static-functions/functions/header_getResizeHandler.md index c1e8bcec03..6d0db30b78 100644 --- a/docs/reference/static-functions/functions/header_getResizeHandler.md +++ b/docs/reference/static-functions/functions/header_getResizeHandler.md @@ -9,7 +9,7 @@ title: header_getResizeHandler function header_getResizeHandler(header, _contextDocument?): (event) => void; ``` -Defined in: [features/column-resizing/columnResizingFeature.utils.ts:92](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-resizing/columnResizingFeature.utils.ts#L92) +Defined in: [features/column-resizing/columnResizingFeature.utils.ts:91](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-resizing/columnResizingFeature.utils.ts#L91) Creates the pointer/touch start handler for resizing a header. diff --git a/docs/reference/static-functions/functions/isTouchStartEvent.md b/docs/reference/static-functions/functions/isTouchStartEvent.md index d9fb25aa75..f09abbe15a 100644 --- a/docs/reference/static-functions/functions/isTouchStartEvent.md +++ b/docs/reference/static-functions/functions/isTouchStartEvent.md @@ -9,7 +9,7 @@ title: isTouchStartEvent function isTouchStartEvent(e): e is TouchEvent; ``` -Defined in: [features/column-resizing/columnResizingFeature.utils.ts:363](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-resizing/columnResizingFeature.utils.ts#L363) +Defined in: [features/column-resizing/columnResizingFeature.utils.ts:362](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-resizing/columnResizingFeature.utils.ts#L362) Narrows an unknown event to a `touchstart` event. diff --git a/docs/reference/static-functions/functions/passiveEventSupported.md b/docs/reference/static-functions/functions/passiveEventSupported.md index 29ad84055f..c7962b9975 100644 --- a/docs/reference/static-functions/functions/passiveEventSupported.md +++ b/docs/reference/static-functions/functions/passiveEventSupported.md @@ -9,7 +9,7 @@ title: passiveEventSupported function passiveEventSupported(): boolean; ``` -Defined in: [features/column-resizing/columnResizingFeature.utils.ts:329](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-resizing/columnResizingFeature.utils.ts#L329) +Defined in: [features/column-resizing/columnResizingFeature.utils.ts:328](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-resizing/columnResizingFeature.utils.ts#L328) Detects whether the current environment supports passive event listeners. diff --git a/docs/reference/static-functions/functions/row_getCenterVisibleCells.md b/docs/reference/static-functions/functions/row_getCenterVisibleCells.md index 09eaaf979f..6e4bc6ca91 100644 --- a/docs/reference/static-functions/functions/row_getCenterVisibleCells.md +++ b/docs/reference/static-functions/functions/row_getCenterVisibleCells.md @@ -6,7 +6,7 @@ title: row_getCenterVisibleCells # Function: row\_getCenterVisibleCells() ```ts -function row_getCenterVisibleCells(row): any[]; +function row_getCenterVisibleCells(row): Cell[]; ``` Defined in: [features/column-pinning/columnPinningFeature.utils.ts:189](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-pinning/columnPinningFeature.utils.ts#L189) @@ -33,7 +33,7 @@ The result preserves the row's visible-cell order for center columns. ## Returns -`any`[] +[`Cell`](../../index/type-aliases/Cell.md)\<`TFeatures`, `TData`, `unknown`\>[] ## Example diff --git a/docs/reference/static-functions/functions/row_getGroupingValue.md b/docs/reference/static-functions/functions/row_getGroupingValue.md index 019c8ecbee..812858e6f1 100644 --- a/docs/reference/static-functions/functions/row_getGroupingValue.md +++ b/docs/reference/static-functions/functions/row_getGroupingValue.md @@ -9,7 +9,7 @@ title: row_getGroupingValue function row_getGroupingValue(row, columnId): any; ``` -Defined in: [features/column-grouping/columnGroupingFeature.utils.ts:268](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/columnGroupingFeature.utils.ts#L268) +Defined in: [features/column-grouping/columnGroupingFeature.utils.ts:267](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/columnGroupingFeature.utils.ts#L267) Reads and caches this row's grouping value for a column. @@ -30,14 +30,7 @@ accessor value is used. ### row -[`Row_Core`](../../index/interfaces/Row_Core.md)\<`TFeatures`, `TData`\> & [`UnionToIntersection`](../../index/type-aliases/UnionToIntersection.md)\< - \| `"columnFilteringFeature"` *extends* keyof `TFeatures` ? [`Row_ColumnFiltering`](../../index/interfaces/Row_ColumnFiltering.md)\<`TFeatures`, `TData`\> : `never` - \| `"columnGroupingFeature"` *extends* keyof `TFeatures` ? [`Row_ColumnGrouping`](../../index/interfaces/Row_ColumnGrouping.md) : `never` - \| `"columnPinningFeature"` *extends* keyof `TFeatures` ? [`Row_ColumnPinning`](../../index/interfaces/Row_ColumnPinning.md)\<`TFeatures`, `TData`\> : `never` - \| `"columnVisibilityFeature"` *extends* keyof `TFeatures` ? [`Row_ColumnVisibility`](../../index/interfaces/Row_ColumnVisibility.md)\<`TFeatures`, `TData`\> : `never` - \| `"rowExpandingFeature"` *extends* keyof `TFeatures` ? [`Row_RowExpanding`](../../index/interfaces/Row_RowExpanding.md) : `never` - \| `"rowPinningFeature"` *extends* keyof `TFeatures` ? [`Row_RowPinning`](../../index/interfaces/Row_RowPinning.md) : `never` - \| `"rowSelectionFeature"` *extends* keyof `TFeatures` ? [`Row_RowSelection`](../../index/interfaces/Row_RowSelection.md) : `never`\> & [`UnionToIntersection`](../../index/type-aliases/UnionToIntersection.md)\<\{ \[K in string \| number \| symbol\]: K extends "coreReativityFeature" ? never : TFeatures\[K\] extends TableFeature\ ? "Row" extends keyof FeatureConstructorOptions ? FeatureConstructorOptions\[keyof FeatureConstructorOptions & "Row"\] : never : any \}\[keyof `TFeatures`\]\> & [`Row_Plugins`](../../index/interfaces/Row_Plugins.md)\<`TFeatures`, `TData`\> & `Partial`\<[`Row_ColumnGrouping`](../../index/interfaces/Row_ColumnGrouping.md)\> +[`Row_Core`](../../index/interfaces/Row_Core.md)\<`TFeatures`, `TData`\> & [`ExtractFeatureMapTypes`](../../index/type-aliases/ExtractFeatureMapTypes.md)\<`TFeatures`, [`Row_FeatureMap`](../../index/interfaces/Row_FeatureMap.md)\<`TFeatures`, `TData`\>\> & `Partial`\<[`Row_ColumnGrouping`](../../index/interfaces/Row_ColumnGrouping.md)\> ### columnId diff --git a/docs/reference/static-functions/functions/row_getIsGrouped.md b/docs/reference/static-functions/functions/row_getIsGrouped.md index cc16a37cf4..b3e47304e0 100644 --- a/docs/reference/static-functions/functions/row_getIsGrouped.md +++ b/docs/reference/static-functions/functions/row_getIsGrouped.md @@ -9,7 +9,7 @@ title: row_getIsGrouped function row_getIsGrouped(row): boolean; ``` -Defined in: [features/column-grouping/columnGroupingFeature.utils.ts:250](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/columnGroupingFeature.utils.ts#L250) +Defined in: [features/column-grouping/columnGroupingFeature.utils.ts:249](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/columnGroupingFeature.utils.ts#L249) Checks whether this row was created as a grouped row. @@ -29,14 +29,7 @@ Grouped rows carry a `groupingColumnId`; ordinary leaf rows do not. ### row -[`Row_Core`](../../index/interfaces/Row_Core.md)\<`TFeatures`, `TData`\> & [`UnionToIntersection`](../../index/type-aliases/UnionToIntersection.md)\< - \| `"columnFilteringFeature"` *extends* keyof `TFeatures` ? [`Row_ColumnFiltering`](../../index/interfaces/Row_ColumnFiltering.md)\<`TFeatures`, `TData`\> : `never` - \| `"columnGroupingFeature"` *extends* keyof `TFeatures` ? [`Row_ColumnGrouping`](../../index/interfaces/Row_ColumnGrouping.md) : `never` - \| `"columnPinningFeature"` *extends* keyof `TFeatures` ? [`Row_ColumnPinning`](../../index/interfaces/Row_ColumnPinning.md)\<`TFeatures`, `TData`\> : `never` - \| `"columnVisibilityFeature"` *extends* keyof `TFeatures` ? [`Row_ColumnVisibility`](../../index/interfaces/Row_ColumnVisibility.md)\<`TFeatures`, `TData`\> : `never` - \| `"rowExpandingFeature"` *extends* keyof `TFeatures` ? [`Row_RowExpanding`](../../index/interfaces/Row_RowExpanding.md) : `never` - \| `"rowPinningFeature"` *extends* keyof `TFeatures` ? [`Row_RowPinning`](../../index/interfaces/Row_RowPinning.md) : `never` - \| `"rowSelectionFeature"` *extends* keyof `TFeatures` ? [`Row_RowSelection`](../../index/interfaces/Row_RowSelection.md) : `never`\> & [`UnionToIntersection`](../../index/type-aliases/UnionToIntersection.md)\<\{ \[K in string \| number \| symbol\]: K extends "coreReativityFeature" ? never : TFeatures\[K\] extends TableFeature\ ? "Row" extends keyof FeatureConstructorOptions ? FeatureConstructorOptions\[keyof FeatureConstructorOptions & "Row"\] : never : any \}\[keyof `TFeatures`\]\> & [`Row_Plugins`](../../index/interfaces/Row_Plugins.md)\<`TFeatures`, `TData`\> & `Partial`\<[`Row_ColumnGrouping`](../../index/interfaces/Row_ColumnGrouping.md)\> +[`Row_Core`](../../index/interfaces/Row_Core.md)\<`TFeatures`, `TData`\> & [`ExtractFeatureMapTypes`](../../index/type-aliases/ExtractFeatureMapTypes.md)\<`TFeatures`, [`Row_FeatureMap`](../../index/interfaces/Row_FeatureMap.md)\<`TFeatures`, `TData`\>\> & `Partial`\<[`Row_ColumnGrouping`](../../index/interfaces/Row_ColumnGrouping.md)\> ## Returns diff --git a/docs/reference/static-functions/functions/table_getCenterFooterGroups.md b/docs/reference/static-functions/functions/table_getCenterFooterGroups.md index ac7675064e..083bbe01af 100644 --- a/docs/reference/static-functions/functions/table_getCenterFooterGroups.md +++ b/docs/reference/static-functions/functions/table_getCenterFooterGroups.md @@ -6,7 +6,7 @@ title: table_getCenterFooterGroups # Function: table\_getCenterFooterGroups() ```ts -function table_getCenterFooterGroups(table): any[]; +function table_getCenterFooterGroups(table): HeaderGroup[]; ``` Defined in: [features/column-pinning/columnPinningFeature.utils.ts:516](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-pinning/columnPinningFeature.utils.ts#L516) @@ -33,7 +33,7 @@ Footer groups reuse the center header groups in reverse order. ## Returns -`any`[] +[`HeaderGroup`](../../index/type-aliases/HeaderGroup.md)\<`TFeatures`, `TData`\>[] ## Example diff --git a/docs/reference/static-functions/functions/table_getCenterLeafHeaders.md b/docs/reference/static-functions/functions/table_getCenterLeafHeaders.md index a0305e0b95..4281566c5d 100644 --- a/docs/reference/static-functions/functions/table_getCenterLeafHeaders.md +++ b/docs/reference/static-functions/functions/table_getCenterLeafHeaders.md @@ -6,7 +6,7 @@ title: table_getCenterLeafHeaders # Function: table\_getCenterLeafHeaders() ```ts -function table_getCenterLeafHeaders(table): any[]; +function table_getCenterLeafHeaders(table): Header[]; ``` Defined in: [features/column-pinning/columnPinningFeature.utils.ts:671](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-pinning/columnPinningFeature.utils.ts#L671) @@ -33,7 +33,7 @@ Parent headers are filtered out from the center flat header list. ## Returns -`any`[] +[`Header`](../../index/type-aliases/Header.md)\<`TFeatures`, `TData`, `unknown`\>[] ## Example diff --git a/docs/reference/static-functions/functions/table_getCenterTotalSize.md b/docs/reference/static-functions/functions/table_getCenterTotalSize.md index 502c496aa4..f782b8c10e 100644 --- a/docs/reference/static-functions/functions/table_getCenterTotalSize.md +++ b/docs/reference/static-functions/functions/table_getCenterTotalSize.md @@ -6,7 +6,7 @@ title: table_getCenterTotalSize # Function: table\_getCenterTotalSize() ```ts -function table_getCenterTotalSize(table): any; +function table_getCenterTotalSize(table): number; ``` Defined in: [features/column-sizing/columnSizingFeature.utils.ts:343](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-sizing/columnSizingFeature.utils.ts#L343) @@ -33,7 +33,7 @@ An empty center region returns `0`. ## Returns -`any` +`number` ## Example diff --git a/docs/reference/static-functions/functions/table_getCenterVisibleLeafColumns.md b/docs/reference/static-functions/functions/table_getCenterVisibleLeafColumns.md index 2ec8d51723..0139b76eca 100644 --- a/docs/reference/static-functions/functions/table_getCenterVisibleLeafColumns.md +++ b/docs/reference/static-functions/functions/table_getCenterVisibleLeafColumns.md @@ -6,7 +6,7 @@ title: table_getCenterVisibleLeafColumns # Function: table\_getCenterVisibleLeafColumns() ```ts -function table_getCenterVisibleLeafColumns(table): any[]; +function table_getCenterVisibleLeafColumns(table): Column[]; ``` Defined in: [features/column-pinning/columnPinningFeature.utils.ts:854](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-pinning/columnPinningFeature.utils.ts#L854) @@ -34,7 +34,7 @@ separately from the scrollable middle region. ## Returns -`any`[] +[`Column`](../../index/type-aliases/Column.md)\<`TFeatures`, `TData`, `unknown`\>[] ## Example diff --git a/docs/reference/static-functions/functions/table_getGlobalAutoFilterFn.md b/docs/reference/static-functions/functions/table_getGlobalAutoFilterFn.md index 6f65b4a0c2..721529d659 100644 --- a/docs/reference/static-functions/functions/table_getGlobalAutoFilterFn.md +++ b/docs/reference/static-functions/functions/table_getGlobalAutoFilterFn.md @@ -6,7 +6,7 @@ title: table_getGlobalAutoFilterFn # Function: table\_getGlobalAutoFilterFn() ```ts -function table_getGlobalAutoFilterFn(): FilterFn; +function table_getGlobalAutoFilterFn(): (row, columnId, filterValue) => boolean & object; ``` Defined in: [features/global-filtering/globalFilteringFeature.utils.ts:45](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/global-filtering/globalFilteringFeature.utils.ts#L45) @@ -18,7 +18,7 @@ matching across globally filterable columns. ## Returns -[`FilterFn`](../../index/interfaces/FilterFn.md)\<`any`, `any`\> +\<`TFeatures`, `TData`\>(`row`, `columnId`, `filterValue`) => `boolean` & `object` ## Example diff --git a/docs/reference/static-functions/functions/table_getLeftFooterGroups.md b/docs/reference/static-functions/functions/table_getLeftFooterGroups.md index 1e467514a7..aa392093b2 100644 --- a/docs/reference/static-functions/functions/table_getLeftFooterGroups.md +++ b/docs/reference/static-functions/functions/table_getLeftFooterGroups.md @@ -6,7 +6,7 @@ title: table_getLeftFooterGroups # Function: table\_getLeftFooterGroups() ```ts -function table_getLeftFooterGroups(table): any[]; +function table_getLeftFooterGroups(table): HeaderGroup[]; ``` Defined in: [features/column-pinning/columnPinningFeature.utils.ts:472](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-pinning/columnPinningFeature.utils.ts#L472) @@ -33,7 +33,7 @@ Footer groups reuse the left header groups in reverse order. ## Returns -`any`[] +[`HeaderGroup`](../../index/type-aliases/HeaderGroup.md)\<`TFeatures`, `TData`\>[] ## Example diff --git a/docs/reference/static-functions/functions/table_getLeftLeafHeaders.md b/docs/reference/static-functions/functions/table_getLeftLeafHeaders.md index d4da6f0198..0e799aef84 100644 --- a/docs/reference/static-functions/functions/table_getLeftLeafHeaders.md +++ b/docs/reference/static-functions/functions/table_getLeftLeafHeaders.md @@ -6,7 +6,7 @@ title: table_getLeftLeafHeaders # Function: table\_getLeftLeafHeaders() ```ts -function table_getLeftLeafHeaders(table): any[]; +function table_getLeftLeafHeaders(table): Header[]; ``` Defined in: [features/column-pinning/columnPinningFeature.utils.ts:629](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-pinning/columnPinningFeature.utils.ts#L629) @@ -33,7 +33,7 @@ Parent headers are filtered out from the left flat header list. ## Returns -`any`[] +[`Header`](../../index/type-aliases/Header.md)\<`TFeatures`, `TData`, `unknown`\>[] ## Example diff --git a/docs/reference/static-functions/functions/table_getLeftTotalSize.md b/docs/reference/static-functions/functions/table_getLeftTotalSize.md index 05f041a409..28e8badc84 100644 --- a/docs/reference/static-functions/functions/table_getLeftTotalSize.md +++ b/docs/reference/static-functions/functions/table_getLeftTotalSize.md @@ -6,7 +6,7 @@ title: table_getLeftTotalSize # Function: table\_getLeftTotalSize() ```ts -function table_getLeftTotalSize(table): any; +function table_getLeftTotalSize(table): number; ``` Defined in: [features/column-sizing/columnSizingFeature.utils.ts:318](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-sizing/columnSizingFeature.utils.ts#L318) @@ -33,7 +33,7 @@ An empty left pinning region returns `0`. ## Returns -`any` +`number` ## Example diff --git a/docs/reference/static-functions/functions/table_getLeftVisibleLeafColumns.md b/docs/reference/static-functions/functions/table_getLeftVisibleLeafColumns.md index b719bdf086..4ec9a86559 100644 --- a/docs/reference/static-functions/functions/table_getLeftVisibleLeafColumns.md +++ b/docs/reference/static-functions/functions/table_getLeftVisibleLeafColumns.md @@ -6,7 +6,7 @@ title: table_getLeftVisibleLeafColumns # Function: table\_getLeftVisibleLeafColumns() ```ts -function table_getLeftVisibleLeafColumns(table): any[]; +function table_getLeftVisibleLeafColumns(table): Column_Internal[]; ``` Defined in: [features/column-pinning/columnPinningFeature.utils.ts:807](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-pinning/columnPinningFeature.utils.ts#L807) @@ -33,7 +33,7 @@ Hidden pinned columns are filtered out after the left pin order is applied. ## Returns -`any`[] +[`Column_Internal`](../../index/type-aliases/Column_Internal.md)\<`TFeatures`, `TData`, `unknown`\>[] ## Example diff --git a/docs/reference/static-functions/functions/table_getPinnedLeafColumns.md b/docs/reference/static-functions/functions/table_getPinnedLeafColumns.md index ec4a84480c..b2daa8904b 100644 --- a/docs/reference/static-functions/functions/table_getPinnedLeafColumns.md +++ b/docs/reference/static-functions/functions/table_getPinnedLeafColumns.md @@ -6,7 +6,7 @@ title: table_getPinnedLeafColumns # Function: table\_getPinnedLeafColumns() ```ts -function table_getPinnedLeafColumns(table, position): any[]; +function table_getPinnedLeafColumns(table, position): Column[]; ``` Defined in: [features/column-pinning/columnPinningFeature.utils.ts:767](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-pinning/columnPinningFeature.utils.ts#L767) @@ -38,7 +38,7 @@ read all leaf columns without partitioning. ## Returns -`any`[] +[`Column`](../../index/type-aliases/Column.md)\<`TFeatures`, `TData`, `unknown`\>[] ## Example diff --git a/docs/reference/static-functions/functions/table_getPinnedVisibleLeafColumns.md b/docs/reference/static-functions/functions/table_getPinnedVisibleLeafColumns.md index dfcac4f821..e52b14dc1e 100644 --- a/docs/reference/static-functions/functions/table_getPinnedVisibleLeafColumns.md +++ b/docs/reference/static-functions/functions/table_getPinnedVisibleLeafColumns.md @@ -6,7 +6,7 @@ title: table_getPinnedVisibleLeafColumns # Function: table\_getPinnedVisibleLeafColumns() ```ts -function table_getPinnedVisibleLeafColumns(table, position?): any[]; +function table_getPinnedVisibleLeafColumns(table, position?): Column[]; ``` Defined in: [features/column-pinning/columnPinningFeature.utils.ts:878](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-pinning/columnPinningFeature.utils.ts#L878) @@ -38,7 +38,7 @@ or `'right'` to get one partition. ## Returns -`any`[] +[`Column`](../../index/type-aliases/Column.md)\<`TFeatures`, `TData`, `unknown`\>[] ## Example diff --git a/docs/reference/static-functions/functions/table_getRightFooterGroups.md b/docs/reference/static-functions/functions/table_getRightFooterGroups.md index 1d8c9f638d..46deee1c9a 100644 --- a/docs/reference/static-functions/functions/table_getRightFooterGroups.md +++ b/docs/reference/static-functions/functions/table_getRightFooterGroups.md @@ -6,7 +6,7 @@ title: table_getRightFooterGroups # Function: table\_getRightFooterGroups() ```ts -function table_getRightFooterGroups(table): any[]; +function table_getRightFooterGroups(table): HeaderGroup[]; ``` Defined in: [features/column-pinning/columnPinningFeature.utils.ts:494](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-pinning/columnPinningFeature.utils.ts#L494) @@ -33,7 +33,7 @@ Footer groups reuse the right header groups in reverse order. ## Returns -`any`[] +[`HeaderGroup`](../../index/type-aliases/HeaderGroup.md)\<`TFeatures`, `TData`\>[] ## Example diff --git a/docs/reference/static-functions/functions/table_getRightLeafHeaders.md b/docs/reference/static-functions/functions/table_getRightLeafHeaders.md index 7058ec4abc..eb29c71bde 100644 --- a/docs/reference/static-functions/functions/table_getRightLeafHeaders.md +++ b/docs/reference/static-functions/functions/table_getRightLeafHeaders.md @@ -6,7 +6,7 @@ title: table_getRightLeafHeaders # Function: table\_getRightLeafHeaders() ```ts -function table_getRightLeafHeaders(table): any[]; +function table_getRightLeafHeaders(table): Header[]; ``` Defined in: [features/column-pinning/columnPinningFeature.utils.ts:650](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-pinning/columnPinningFeature.utils.ts#L650) @@ -33,7 +33,7 @@ Parent headers are filtered out from the right flat header list. ## Returns -`any`[] +[`Header`](../../index/type-aliases/Header.md)\<`TFeatures`, `TData`, `unknown`\>[] ## Example diff --git a/docs/reference/static-functions/functions/table_getRightTotalSize.md b/docs/reference/static-functions/functions/table_getRightTotalSize.md index a2f60f6573..6368ed68b0 100644 --- a/docs/reference/static-functions/functions/table_getRightTotalSize.md +++ b/docs/reference/static-functions/functions/table_getRightTotalSize.md @@ -6,7 +6,7 @@ title: table_getRightTotalSize # Function: table\_getRightTotalSize() ```ts -function table_getRightTotalSize(table): any; +function table_getRightTotalSize(table): number; ``` Defined in: [features/column-sizing/columnSizingFeature.utils.ts:368](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-sizing/columnSizingFeature.utils.ts#L368) @@ -33,7 +33,7 @@ An empty right pinning region returns `0`. ## Returns -`any` +`number` ## Example diff --git a/docs/reference/static-functions/functions/table_getRightVisibleLeafColumns.md b/docs/reference/static-functions/functions/table_getRightVisibleLeafColumns.md index e9c8091311..07b2a7b665 100644 --- a/docs/reference/static-functions/functions/table_getRightVisibleLeafColumns.md +++ b/docs/reference/static-functions/functions/table_getRightVisibleLeafColumns.md @@ -6,7 +6,7 @@ title: table_getRightVisibleLeafColumns # Function: table\_getRightVisibleLeafColumns() ```ts -function table_getRightVisibleLeafColumns(table): any[]; +function table_getRightVisibleLeafColumns(table): Column_Internal[]; ``` Defined in: [features/column-pinning/columnPinningFeature.utils.ts:830](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-pinning/columnPinningFeature.utils.ts#L830) @@ -33,7 +33,7 @@ Hidden pinned columns are filtered out after the right pin order is applied. ## Returns -`any`[] +[`Column_Internal`](../../index/type-aliases/Column_Internal.md)\<`TFeatures`, `TData`, `unknown`\>[] ## Example diff --git a/docs/reference/static-functions/functions/table_resetGlobalFilter.md b/docs/reference/static-functions/functions/table_resetGlobalFilter.md index 258033c77b..c450daf3a4 100644 --- a/docs/reference/static-functions/functions/table_resetGlobalFilter.md +++ b/docs/reference/static-functions/functions/table_resetGlobalFilter.md @@ -9,7 +9,7 @@ title: table_resetGlobalFilter function table_resetGlobalFilter(table, defaultState?): void; ``` -Defined in: [features/global-filtering/globalFilteringFeature.utils.ts:108](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/global-filtering/globalFilteringFeature.utils.ts#L108) +Defined in: [features/global-filtering/globalFilteringFeature.utils.ts:110](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/global-filtering/globalFilteringFeature.utils.ts#L110) Resets `globalFilter` to the configured initial state or feature default. diff --git a/docs/reference/static-functions/functions/table_resetGrouping.md b/docs/reference/static-functions/functions/table_resetGrouping.md index 572a90dfa3..7dc2c56d7c 100644 --- a/docs/reference/static-functions/functions/table_resetGrouping.md +++ b/docs/reference/static-functions/functions/table_resetGrouping.md @@ -9,7 +9,7 @@ title: table_resetGrouping function table_resetGrouping(table, defaultState?): void; ``` -Defined in: [features/column-grouping/columnGroupingFeature.utils.ts:230](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/columnGroupingFeature.utils.ts#L230) +Defined in: [features/column-grouping/columnGroupingFeature.utils.ts:229](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/columnGroupingFeature.utils.ts#L229) Resets `grouping` to the configured initial state or feature default. diff --git a/docs/reference/static-functions/functions/table_resetHeaderSizeInfo.md b/docs/reference/static-functions/functions/table_resetHeaderSizeInfo.md index 0104e7d50a..44cfcab09a 100644 --- a/docs/reference/static-functions/functions/table_resetHeaderSizeInfo.md +++ b/docs/reference/static-functions/functions/table_resetHeaderSizeInfo.md @@ -9,7 +9,7 @@ title: table_resetHeaderSizeInfo function table_resetHeaderSizeInfo(table, defaultState?): void; ``` -Defined in: [features/column-resizing/columnResizingFeature.utils.ts:303](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-resizing/columnResizingFeature.utils.ts#L303) +Defined in: [features/column-resizing/columnResizingFeature.utils.ts:302](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-resizing/columnResizingFeature.utils.ts#L302) Resets `columnResizing` to the configured initial state or feature default. diff --git a/docs/reference/static-functions/functions/table_setColumnResizing.md b/docs/reference/static-functions/functions/table_setColumnResizing.md index 6432281a6e..b9258f5547 100644 --- a/docs/reference/static-functions/functions/table_setColumnResizing.md +++ b/docs/reference/static-functions/functions/table_setColumnResizing.md @@ -9,7 +9,7 @@ title: table_setColumnResizing function table_setColumnResizing(table, updater): void; ``` -Defined in: [features/column-resizing/columnResizingFeature.utils.ts:280](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-resizing/columnResizingFeature.utils.ts#L280) +Defined in: [features/column-resizing/columnResizingFeature.utils.ts:279](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-resizing/columnResizingFeature.utils.ts#L279) Routes a transient column resizing updater through the table's resize handler. diff --git a/docs/reference/static-functions/functions/table_setGlobalFilter.md b/docs/reference/static-functions/functions/table_setGlobalFilter.md index ace83dc6a5..2e2ca480ce 100644 --- a/docs/reference/static-functions/functions/table_setGlobalFilter.md +++ b/docs/reference/static-functions/functions/table_setGlobalFilter.md @@ -9,7 +9,7 @@ title: table_setGlobalFilter function table_setGlobalFilter(table, updater): void; ``` -Defined in: [features/global-filtering/globalFilteringFeature.utils.ts:89](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/global-filtering/globalFilteringFeature.utils.ts#L89) +Defined in: [features/global-filtering/globalFilteringFeature.utils.ts:91](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/global-filtering/globalFilteringFeature.utils.ts#L91) Routes a global filter updater through the table's global filter handler. diff --git a/docs/reference/static-functions/functions/table_setGrouping.md b/docs/reference/static-functions/functions/table_setGrouping.md index ff8e4e52ec..6dda237b93 100644 --- a/docs/reference/static-functions/functions/table_setGrouping.md +++ b/docs/reference/static-functions/functions/table_setGrouping.md @@ -9,7 +9,7 @@ title: table_setGrouping function table_setGrouping(table, updater): void; ``` -Defined in: [features/column-grouping/columnGroupingFeature.utils.ts:211](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/columnGroupingFeature.utils.ts#L211) +Defined in: [features/column-grouping/columnGroupingFeature.utils.ts:210](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/columnGroupingFeature.utils.ts#L210) Routes a grouping updater through the table's grouping change handler.