diff --git a/.changeset/central-noop-state-guard.md b/.changeset/central-noop-state-guard.md new file mode 100644 index 0000000000..bd44bc2c30 --- /dev/null +++ b/.changeset/central-noop-state-guard.md @@ -0,0 +1,15 @@ +--- +'@tanstack/table-core': patch +--- + +Centralize state updates behind a `setStateSlice` util with an optional structural no-op policy. Equality-guarded slices give their state owner a functional updater that resolves against the owner's latest value and returns the existing reference when nothing changed. Atom and framework state owners can then skip the write and re-render without comparing against a potentially stale controlled table snapshot. + +This removes an entire class of render loops where an auto reset (for example `autoResetExpanded` after a `data` reference change) fired a change handler with a freshly allocated but semantically identical value, causing controlled-state consumers to re-render, produce a new `data` reference, and loop. + +Behavior notes: + +- A custom `onXChange` handler is still invoked for an apparent no-op. Only its state container knows the latest queued value, so it performs the equality check when it applies the guarded updater. This preserves same-tick update composition in frameworks such as React. +- State updaters are evaluated once, by the state owner. Controlled fallback atoms therefore remain correct if control is later released, and external atom owners do not run functional updaters twice. +- `stateSlicesEqual` compares enumerable string and symbol keys through the three container levels used by stock state. Sparse arrays remain distinct from explicit `undefined` entries; deeper or non-plain values compare by reference and safely allow the update. +- Structural equality is opt-in per slice. Opaque `globalFilter` values and row-scaled `rowSelection`/`rowPinning` maps stay direct. The high-frequency `columnSizing`, `columnResizing`, and ordinary cell-selection write paths also avoid a comparison on every pointer update. +- Auto-reset-prone cell selection applies equality specifically to resets, while its drag handler keeps an O(1) active-focus guard. Expanded state similarly guards reset/auto-reset while ordinary writes stay direct, and toggle-all keeps its explicit O(1) no-op checks. diff --git a/docs/reference/index/functions/assignPrototypeAPIs.md b/docs/reference/index/functions/assignPrototypeAPIs.md index fe6f50024b..f1ade1972f 100644 --- a/docs/reference/index/functions/assignPrototypeAPIs.md +++ b/docs/reference/index/functions/assignPrototypeAPIs.md @@ -13,7 +13,7 @@ function assignPrototypeAPIs( apis): void; ``` -Defined in: [utils.ts:453](https://github.com/TanStack/table/blob/main/packages/table-core/src/utils.ts#L453) +Defined in: [utils.ts:586](https://github.com/TanStack/table/blob/main/packages/table-core/src/utils.ts#L586) Assigns API methods to a prototype object for memory-efficient method sharing. All instances created with this prototype will share the same method references. diff --git a/docs/reference/index/functions/assignTableAPIs.md b/docs/reference/index/functions/assignTableAPIs.md index 20f87dbe60..b95cabe589 100644 --- a/docs/reference/index/functions/assignTableAPIs.md +++ b/docs/reference/index/functions/assignTableAPIs.md @@ -12,7 +12,7 @@ function assignTableAPIs( apis): void; ``` -Defined in: [utils.ts:411](https://github.com/TanStack/table/blob/main/packages/table-core/src/utils.ts#L411) +Defined in: [utils.ts:544](https://github.com/TanStack/table/blob/main/packages/table-core/src/utils.ts#L544) Assigns Table API methods directly to the table instance. Unlike row/cell/column/header, the table is a singleton so methods are assigned directly. diff --git a/docs/reference/index/functions/callMemoOrStaticFn.md b/docs/reference/index/functions/callMemoOrStaticFn.md index e04608ef9a..8e206337af 100644 --- a/docs/reference/index/functions/callMemoOrStaticFn.md +++ b/docs/reference/index/functions/callMemoOrStaticFn.md @@ -13,7 +13,7 @@ function callMemoOrStaticFn( args): TReturn; ``` -Defined in: [utils.ts:499](https://github.com/TanStack/table/blob/main/packages/table-core/src/utils.ts#L499) +Defined in: [utils.ts:632](https://github.com/TanStack/table/blob/main/packages/table-core/src/utils.ts#L632) Looks to run the memoized function with the builder pattern on the object if it exists, otherwise fall back to the static method passed in. diff --git a/docs/reference/index/functions/flattenBy.md b/docs/reference/index/functions/flattenBy.md index e7821f0f7b..c7e456f6f1 100644 --- a/docs/reference/index/functions/flattenBy.md +++ b/docs/reference/index/functions/flattenBy.md @@ -9,7 +9,7 @@ title: flattenBy function flattenBy(arr, getChildren): TNode[]; ``` -Defined in: [utils.ts:131](https://github.com/TanStack/table/blob/main/packages/table-core/src/utils.ts#L131) +Defined in: [utils.ts:264](https://github.com/TanStack/table/blob/main/packages/table-core/src/utils.ts#L264) Flattens a tree of nodes by recursively reading child nodes. diff --git a/docs/reference/index/functions/getFunctionNameInfo.md b/docs/reference/index/functions/getFunctionNameInfo.md index 6f5b3b2199..a2a8662156 100644 --- a/docs/reference/index/functions/getFunctionNameInfo.md +++ b/docs/reference/index/functions/getFunctionNameInfo.md @@ -9,7 +9,7 @@ title: getFunctionNameInfo function getFunctionNameInfo(staticFnName, splitBy): object; ``` -Defined in: [utils.ts:394](https://github.com/TanStack/table/blob/main/packages/table-core/src/utils.ts#L394) +Defined in: [utils.ts:527](https://github.com/TanStack/table/blob/main/packages/table-core/src/utils.ts#L527) Assumes that a function name is in the format of `parentName_fnKey` and returns the `fnKey` and `fnName` in the format of `parentName.fnKey`. diff --git a/docs/reference/index/functions/isFunction.md b/docs/reference/index/functions/isFunction.md index 730cfd7000..25f7e30327 100644 --- a/docs/reference/index/functions/isFunction.md +++ b/docs/reference/index/functions/isFunction.md @@ -9,7 +9,7 @@ title: isFunction function isFunction(d): d is T; ``` -Defined in: [utils.ts:122](https://github.com/TanStack/table/blob/main/packages/table-core/src/utils.ts#L122) +Defined in: [utils.ts:255](https://github.com/TanStack/table/blob/main/packages/table-core/src/utils.ts#L255) Returns whether a value is a function. diff --git a/docs/reference/index/functions/memo.md b/docs/reference/index/functions/memo.md index 1737b56562..d335095f0b 100644 --- a/docs/reference/index/functions/memo.md +++ b/docs/reference/index/functions/memo.md @@ -9,7 +9,7 @@ title: memo function memo(__namedParameters): (depArgs?) => TResult; ``` -Defined in: [utils.ts:166](https://github.com/TanStack/table/blob/main/packages/table-core/src/utils.ts#L166) +Defined in: [utils.ts:299](https://github.com/TanStack/table/blob/main/packages/table-core/src/utils.ts#L299) Creates a dependency-tracked memoized function for table internals. diff --git a/docs/reference/index/functions/setStateSlice.md b/docs/reference/index/functions/setStateSlice.md new file mode 100644 index 0000000000..af1d384981 --- /dev/null +++ b/docs/reference/index/functions/setStateSlice.md @@ -0,0 +1,66 @@ +--- +id: setStateSlice +title: setStateSlice +--- + +# Function: setStateSlice() + +```ts +function setStateSlice( + instance, + key, + updater, + isEqual): void; +``` + +Defined in: [utils.ts:223](https://github.com/TanStack/table/blob/main/packages/table-core/src/utils.ts#L223) + +Routes a state slice update through the slice's `onChange` handler, +preserving the owner's current reference for structural no-ops. + +Equality is evaluated inside the updater received by the state owner, never +against the table's potentially stale controlled snapshot. This keeps +same-tick updates composable in queued host containers such as React state, +evaluates the original updater only when the owner applies it, and lets atom +owners suppress notifications by returning their existing reference. + +A user-provided change handler is still invoked for a no-op because only that +handler's state container can know its latest queued value. The guarded +updater returns that container's previous reference, preventing a state write +or render in state containers with identity bailout semantics. + +Hot-path slices that skip guarding entirely (selection maps that scale with +row count, pointer-frequency resize state) call their change handler +directly instead of routing through this util. Custom feature slices with a +cheaper or semantic-aware comparison can pass `isEqual` to override the +structural default. + +## Type Parameters + +### K + +`K` *extends* `string` & `object` \| keyof TableState\_All + +## Parameters + +### instance + +#### options + +`object` + +### key + +`K` + +### updater + +[`Updater`](../type-aliases/Updater.md)\<`StateSliceForKey`\<`K`\>\> + +### isEqual + +[`StateSliceEqualityFn`](../type-aliases/StateSliceEqualityFn.md)\<`StateSliceForKey`\<`K`\>\> = `stateSlicesEqual` + +## Returns + +`void` diff --git a/docs/reference/index/functions/skipFirstRun.md b/docs/reference/index/functions/skipFirstRun.md index 4d1fce09df..f27dfced47 100644 --- a/docs/reference/index/functions/skipFirstRun.md +++ b/docs/reference/index/functions/skipFirstRun.md @@ -9,7 +9,7 @@ title: skipFirstRun function skipFirstRun(fn): () => void; ``` -Defined in: [utils.ts:217](https://github.com/TanStack/table/blob/main/packages/table-core/src/utils.ts#L217) +Defined in: [utils.ts:350](https://github.com/TanStack/table/blob/main/packages/table-core/src/utils.ts#L350) Wraps a callback so that its first invocation is skipped. diff --git a/docs/reference/index/functions/stateSlicesEqual.md b/docs/reference/index/functions/stateSlicesEqual.md new file mode 100644 index 0000000000..25dd2f931d --- /dev/null +++ b/docs/reference/index/functions/stateSlicesEqual.md @@ -0,0 +1,34 @@ +--- +id: stateSlicesEqual +title: stateSlicesEqual +--- + +# Function: stateSlicesEqual() + +```ts +function stateSlicesEqual(a, b): boolean; +``` + +Defined in: [utils.ts:155](https://github.com/TanStack/table/blob/main/packages/table-core/src/utils.ts#L155) + +Structurally compares two state slice values as deeply as stock feature +state can nest and no deeper. + +Three container levels cover flat maps and arrays, arrays of state objects, +array-valued filter values, and `columnResizing.columnSizingStart` tuples. +Deeper containers and non-plain values compare by reference. A `false` +result is always safe: the state update simply proceeds. + +## Parameters + +### a + +`unknown` + +### b + +`unknown` + +## Returns + +`boolean` diff --git a/docs/reference/index/functions/tableMemo.md b/docs/reference/index/functions/tableMemo.md index 460d43ed79..60153264ad 100644 --- a/docs/reference/index/functions/tableMemo.md +++ b/docs/reference/index/functions/tableMemo.md @@ -9,7 +9,7 @@ title: tableMemo function tableMemo(__namedParameters): (depArgs?) => TResult; ``` -Defined in: [utils.ts:254](https://github.com/TanStack/table/blob/main/packages/table-core/src/utils.ts#L254) +Defined in: [utils.ts:387](https://github.com/TanStack/table/blob/main/packages/table-core/src/utils.ts#L387) Creates a table-aware memoized function. diff --git a/docs/reference/index/index.md b/docs/reference/index/index.md index 59d855171c..5fa997eb4b 100644 --- a/docs/reference/index/index.md +++ b/docs/reference/index/index.md @@ -292,6 +292,7 @@ title: index - [SortDirection](type-aliases/SortDirection.md) - [SortFnOption](type-aliases/SortFnOption.md) - [SortingState](type-aliases/SortingState.md) +- [StateSliceEqualityFn](type-aliases/StateSliceEqualityFn.md) - [StringOrTemplateHeader](type-aliases/StringOrTemplateHeader.md) - [Table](type-aliases/Table.md) - [Table\_RowModels](type-aliases/Table_RowModels.md) @@ -413,7 +414,9 @@ title: index - [makeStateUpdater](functions/makeStateUpdater.md) - [memo](functions/memo.md) - [metaHelper](functions/metaHelper.md) +- [setStateSlice](functions/setStateSlice.md) - [skipFirstRun](functions/skipFirstRun.md) +- [stateSlicesEqual](functions/stateSlicesEqual.md) - [tableFeatures](functions/tableFeatures.md) - [tableMemo](functions/tableMemo.md) - [tableOptions](functions/tableOptions.md) diff --git a/docs/reference/index/interfaces/API.md b/docs/reference/index/interfaces/API.md index eb025ed111..5e23fb15df 100644 --- a/docs/reference/index/interfaces/API.md +++ b/docs/reference/index/interfaces/API.md @@ -5,7 +5,7 @@ title: API # Interface: API\<_TDeps, _TDepArgs\> -Defined in: [utils.ts:381](https://github.com/TanStack/table/blob/main/packages/table-core/src/utils.ts#L381) +Defined in: [utils.ts:514](https://github.com/TanStack/table/blob/main/packages/table-core/src/utils.ts#L514) ## Type Parameters @@ -25,7 +25,7 @@ Defined in: [utils.ts:381](https://github.com/TanStack/table/blob/main/packages/ fn: (...args) => any; ``` -Defined in: [utils.ts:382](https://github.com/TanStack/table/blob/main/packages/table-core/src/utils.ts#L382) +Defined in: [utils.ts:515](https://github.com/TanStack/table/blob/main/packages/table-core/src/utils.ts#L515) #### Parameters @@ -45,7 +45,7 @@ Defined in: [utils.ts:382](https://github.com/TanStack/table/blob/main/packages/ optional memoDeps: (depArgs?) => any[] | undefined; ``` -Defined in: [utils.ts:383](https://github.com/TanStack/table/blob/main/packages/table-core/src/utils.ts#L383) +Defined in: [utils.ts:516](https://github.com/TanStack/table/blob/main/packages/table-core/src/utils.ts#L516) #### Parameters diff --git a/docs/reference/index/interfaces/PrototypeAPI.md b/docs/reference/index/interfaces/PrototypeAPI.md index 6ec51839df..265e0be24c 100644 --- a/docs/reference/index/interfaces/PrototypeAPI.md +++ b/docs/reference/index/interfaces/PrototypeAPI.md @@ -5,7 +5,7 @@ title: PrototypeAPI # Interface: PrototypeAPI\<_TDeps, _TDepArgs\> -Defined in: [utils.ts:436](https://github.com/TanStack/table/blob/main/packages/table-core/src/utils.ts#L436) +Defined in: [utils.ts:569](https://github.com/TanStack/table/blob/main/packages/table-core/src/utils.ts#L569) ## Type Parameters @@ -25,7 +25,7 @@ Defined in: [utils.ts:436](https://github.com/TanStack/table/blob/main/packages/ fn: (self, ...args) => any; ``` -Defined in: [utils.ts:437](https://github.com/TanStack/table/blob/main/packages/table-core/src/utils.ts#L437) +Defined in: [utils.ts:570](https://github.com/TanStack/table/blob/main/packages/table-core/src/utils.ts#L570) #### Parameters @@ -49,7 +49,7 @@ Defined in: [utils.ts:437](https://github.com/TanStack/table/blob/main/packages/ optional memoDeps: (self, depArgs?) => any[] | undefined; ``` -Defined in: [utils.ts:438](https://github.com/TanStack/table/blob/main/packages/table-core/src/utils.ts#L438) +Defined in: [utils.ts:571](https://github.com/TanStack/table/blob/main/packages/table-core/src/utils.ts#L571) #### Parameters diff --git a/docs/reference/index/type-aliases/APIObject.md b/docs/reference/index/type-aliases/APIObject.md index d604946d0d..25cb17c6a6 100644 --- a/docs/reference/index/type-aliases/APIObject.md +++ b/docs/reference/index/type-aliases/APIObject.md @@ -9,7 +9,7 @@ title: APIObject type APIObject = Record>; ``` -Defined in: [utils.ts:386](https://github.com/TanStack/table/blob/main/packages/table-core/src/utils.ts#L386) +Defined in: [utils.ts:519](https://github.com/TanStack/table/blob/main/packages/table-core/src/utils.ts#L519) ## Type Parameters diff --git a/docs/reference/index/type-aliases/PrototypeAPIObject.md b/docs/reference/index/type-aliases/PrototypeAPIObject.md index fe6a04f0a4..79503a3baa 100644 --- a/docs/reference/index/type-aliases/PrototypeAPIObject.md +++ b/docs/reference/index/type-aliases/PrototypeAPIObject.md @@ -9,7 +9,7 @@ title: PrototypeAPIObject type PrototypeAPIObject = Record>; ``` -Defined in: [utils.ts:441](https://github.com/TanStack/table/blob/main/packages/table-core/src/utils.ts#L441) +Defined in: [utils.ts:574](https://github.com/TanStack/table/blob/main/packages/table-core/src/utils.ts#L574) ## Type Parameters diff --git a/docs/reference/index/type-aliases/StateSliceEqualityFn.md b/docs/reference/index/type-aliases/StateSliceEqualityFn.md new file mode 100644 index 0000000000..a425c16487 --- /dev/null +++ b/docs/reference/index/type-aliases/StateSliceEqualityFn.md @@ -0,0 +1,32 @@ +--- +id: StateSliceEqualityFn +title: StateSliceEqualityFn +--- + +# Type Alias: StateSliceEqualityFn()\ + +```ts +type StateSliceEqualityFn = (current, next) => boolean; +``` + +Defined in: [utils.ts:200](https://github.com/TanStack/table/blob/main/packages/table-core/src/utils.ts#L200) + +## Type Parameters + +### T + +`T` + +## Parameters + +### current + +`T` + +### next + +`T` + +## Returns + +`boolean` diff --git a/docs/reference/static-functions/functions/cell_getCanSelect.md b/docs/reference/static-functions/functions/cell_getCanSelect.md index c585a0fe6c..9340ae4b60 100644 --- a/docs/reference/static-functions/functions/cell_getCanSelect.md +++ b/docs/reference/static-functions/functions/cell_getCanSelect.md @@ -9,7 +9,7 @@ title: cell_getCanSelect function cell_getCanSelect(cell): boolean; ``` -Defined in: [features/cell-selection/cellSelectionFeature.utils.ts:507](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/cell-selection/cellSelectionFeature.utils.ts#L507) +Defined in: [features/cell-selection/cellSelectionFeature.utils.ts:515](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/cell-selection/cellSelectionFeature.utils.ts#L515) Checks whether this cell can currently be selected. diff --git a/docs/reference/static-functions/functions/cell_getIsFocused.md b/docs/reference/static-functions/functions/cell_getIsFocused.md index 10093099f9..474bfc2006 100644 --- a/docs/reference/static-functions/functions/cell_getIsFocused.md +++ b/docs/reference/static-functions/functions/cell_getIsFocused.md @@ -9,7 +9,7 @@ title: cell_getIsFocused function cell_getIsFocused(cell): boolean; ``` -Defined in: [features/cell-selection/cellSelectionFeature.utils.ts:605](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/cell-selection/cellSelectionFeature.utils.ts#L605) +Defined in: [features/cell-selection/cellSelectionFeature.utils.ts:613](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/cell-selection/cellSelectionFeature.utils.ts#L613) Checks whether this cell is the active cell. diff --git a/docs/reference/static-functions/functions/cell_getIsSelected.md b/docs/reference/static-functions/functions/cell_getIsSelected.md index 0564003e51..88a4bae545 100644 --- a/docs/reference/static-functions/functions/cell_getIsSelected.md +++ b/docs/reference/static-functions/functions/cell_getIsSelected.md @@ -9,7 +9,7 @@ title: cell_getIsSelected function cell_getIsSelected(cell): boolean; ``` -Defined in: [features/cell-selection/cellSelectionFeature.utils.ts:581](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/cell-selection/cellSelectionFeature.utils.ts#L581) +Defined in: [features/cell-selection/cellSelectionFeature.utils.ts:589](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/cell-selection/cellSelectionFeature.utils.ts#L589) Checks whether this cell falls inside the final positive selection. diff --git a/docs/reference/static-functions/functions/cell_getSelectionEdges.md b/docs/reference/static-functions/functions/cell_getSelectionEdges.md index 422fa4dd92..5562f58b4c 100644 --- a/docs/reference/static-functions/functions/cell_getSelectionEdges.md +++ b/docs/reference/static-functions/functions/cell_getSelectionEdges.md @@ -9,7 +9,7 @@ title: cell_getSelectionEdges function cell_getSelectionEdges(cell): CellSelectionEdges; ``` -Defined in: [features/cell-selection/cellSelectionFeature.utils.ts:649](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/cell-selection/cellSelectionFeature.utils.ts#L649) +Defined in: [features/cell-selection/cellSelectionFeature.utils.ts:657](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/cell-selection/cellSelectionFeature.utils.ts#L657) Returns which sides of this cell sit on the outer boundary of the selection. diff --git a/docs/reference/static-functions/functions/cell_getSelectionExtendHandler.md b/docs/reference/static-functions/functions/cell_getSelectionExtendHandler.md index bfe0a32c60..0f9a9311c7 100644 --- a/docs/reference/static-functions/functions/cell_getSelectionExtendHandler.md +++ b/docs/reference/static-functions/functions/cell_getSelectionExtendHandler.md @@ -9,7 +9,7 @@ title: cell_getSelectionExtendHandler function cell_getSelectionExtendHandler(cell): (_e) => void; ``` -Defined in: [features/cell-selection/cellSelectionFeature.utils.ts:1482](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/cell-selection/cellSelectionFeature.utils.ts#L1482) +Defined in: [features/cell-selection/cellSelectionFeature.utils.ts:1490](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/cell-selection/cellSelectionFeature.utils.ts#L1490) Creates a handler that extends the active range to this cell during a drag. diff --git a/docs/reference/static-functions/functions/cell_getSelectionStartHandler.md b/docs/reference/static-functions/functions/cell_getSelectionStartHandler.md index 39a1fb9eb5..790da99c2e 100644 --- a/docs/reference/static-functions/functions/cell_getSelectionStartHandler.md +++ b/docs/reference/static-functions/functions/cell_getSelectionStartHandler.md @@ -9,7 +9,7 @@ title: cell_getSelectionStartHandler function cell_getSelectionStartHandler(cell, _contextDocument?): (e) => void; ``` -Defined in: [features/cell-selection/cellSelectionFeature.utils.ts:1403](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/cell-selection/cellSelectionFeature.utils.ts#L1403) +Defined in: [features/cell-selection/cellSelectionFeature.utils.ts:1411](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/cell-selection/cellSelectionFeature.utils.ts#L1411) Creates a handler that begins a selection at this cell. diff --git a/docs/reference/static-functions/functions/cell_getTabIndex.md b/docs/reference/static-functions/functions/cell_getTabIndex.md index 01d3b4c6a0..4b67c59bef 100644 --- a/docs/reference/static-functions/functions/cell_getTabIndex.md +++ b/docs/reference/static-functions/functions/cell_getTabIndex.md @@ -9,7 +9,7 @@ title: cell_getTabIndex function cell_getTabIndex(cell): number; ``` -Defined in: [features/cell-selection/cellSelectionFeature.utils.ts:629](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/cell-selection/cellSelectionFeature.utils.ts#L629) +Defined in: [features/cell-selection/cellSelectionFeature.utils.ts:637](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/cell-selection/cellSelectionFeature.utils.ts#L637) Returns `0` for the focused cell and `-1` otherwise, for roving tabindex. diff --git a/docs/reference/static-functions/functions/column_clearSorting.md b/docs/reference/static-functions/functions/column_clearSorting.md index c2b816fb20..2c9248a816 100644 --- a/docs/reference/static-functions/functions/column_clearSorting.md +++ b/docs/reference/static-functions/functions/column_clearSorting.md @@ -9,7 +9,7 @@ title: column_clearSorting function column_clearSorting(column): void; ``` -Defined in: [features/row-sorting/rowSortingFeature.utils.ts:510](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/rowSortingFeature.utils.ts#L510) +Defined in: [features/row-sorting/rowSortingFeature.utils.ts:512](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/rowSortingFeature.utils.ts#L512) Removes this column from the sorting state. diff --git a/docs/reference/static-functions/functions/column_getAutoFilterFn.md b/docs/reference/static-functions/functions/column_getAutoFilterFn.md index b586997770..642ca0cf9f 100644 --- a/docs/reference/static-functions/functions/column_getAutoFilterFn.md +++ b/docs/reference/static-functions/functions/column_getAutoFilterFn.md @@ -11,7 +11,7 @@ function column_getAutoFilterFn(column): | undefined; ``` -Defined in: [features/column-filtering/columnFilteringFeature.utils.ts:42](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-filtering/columnFilteringFeature.utils.ts#L42) +Defined in: [features/column-filtering/columnFilteringFeature.utils.ts:47](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-filtering/columnFilteringFeature.utils.ts#L47) Chooses a built-in filter function from the column's first core row value. diff --git a/docs/reference/static-functions/functions/column_getAutoSortDir.md b/docs/reference/static-functions/functions/column_getAutoSortDir.md index 60bec9e41c..8320d6b745 100644 --- a/docs/reference/static-functions/functions/column_getAutoSortDir.md +++ b/docs/reference/static-functions/functions/column_getAutoSortDir.md @@ -9,7 +9,7 @@ title: column_getAutoSortDir function column_getAutoSortDir(column): "asc" | "desc"; ``` -Defined in: [features/row-sorting/rowSortingFeature.utils.ts:181](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/rowSortingFeature.utils.ts#L181) +Defined in: [features/row-sorting/rowSortingFeature.utils.ts:183](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/rowSortingFeature.utils.ts#L183) Chooses the default first sort direction from sampled filtered row values. diff --git a/docs/reference/static-functions/functions/column_getAutoSortFn.md b/docs/reference/static-functions/functions/column_getAutoSortFn.md index 15ab5619f7..6b3e68170c 100644 --- a/docs/reference/static-functions/functions/column_getAutoSortFn.md +++ b/docs/reference/static-functions/functions/column_getAutoSortFn.md @@ -9,7 +9,7 @@ title: column_getAutoSortFn function column_getAutoSortFn(column): SortFn; ``` -Defined in: [features/row-sorting/rowSortingFeature.utils.ts:108](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/rowSortingFeature.utils.ts#L108) +Defined in: [features/row-sorting/rowSortingFeature.utils.ts:110](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/rowSortingFeature.utils.ts#L110) Chooses a built-in sorting function from sampled filtered row values. diff --git a/docs/reference/static-functions/functions/column_getCanFilter.md b/docs/reference/static-functions/functions/column_getCanFilter.md index 217daf2686..28641eb540 100644 --- a/docs/reference/static-functions/functions/column_getCanFilter.md +++ b/docs/reference/static-functions/functions/column_getCanFilter.md @@ -9,7 +9,7 @@ title: column_getCanFilter function column_getCanFilter(column): boolean; ``` -Defined in: [features/column-filtering/columnFilteringFeature.utils.ts:144](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-filtering/columnFilteringFeature.utils.ts#L144) +Defined in: [features/column-filtering/columnFilteringFeature.utils.ts:149](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-filtering/columnFilteringFeature.utils.ts#L149) Checks whether column filtering is enabled for this accessor column. diff --git a/docs/reference/static-functions/functions/column_getCanHide.md b/docs/reference/static-functions/functions/column_getCanHide.md index 70404494a0..95ba481340 100644 --- a/docs/reference/static-functions/functions/column_getCanHide.md +++ b/docs/reference/static-functions/functions/column_getCanHide.md @@ -9,7 +9,7 @@ title: column_getCanHide function column_getCanHide(column): boolean; ``` -Defined in: [features/column-visibility/columnVisibilityFeature.utils.ts:113](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/columnVisibilityFeature.utils.ts#L113) +Defined in: [features/column-visibility/columnVisibilityFeature.utils.ts:114](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/columnVisibilityFeature.utils.ts#L114) Checks whether this column is allowed to be hidden. diff --git a/docs/reference/static-functions/functions/column_getCanMultiSort.md b/docs/reference/static-functions/functions/column_getCanMultiSort.md index a0478bef13..1d384646ec 100644 --- a/docs/reference/static-functions/functions/column_getCanMultiSort.md +++ b/docs/reference/static-functions/functions/column_getCanMultiSort.md @@ -9,7 +9,7 @@ title: column_getCanMultiSort function column_getCanMultiSort(column): boolean; ``` -Defined in: [features/row-sorting/rowSortingFeature.utils.ts:445](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/rowSortingFeature.utils.ts#L445) +Defined in: [features/row-sorting/rowSortingFeature.utils.ts:447](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/rowSortingFeature.utils.ts#L447) Checks whether this column can be added to a multi-sort state. diff --git a/docs/reference/static-functions/functions/column_getCanSort.md b/docs/reference/static-functions/functions/column_getCanSort.md index 7544811f9d..d843b055ea 100644 --- a/docs/reference/static-functions/functions/column_getCanSort.md +++ b/docs/reference/static-functions/functions/column_getCanSort.md @@ -9,7 +9,7 @@ title: column_getCanSort function column_getCanSort(column): boolean; ``` -Defined in: [features/row-sorting/rowSortingFeature.utils.ts:422](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/rowSortingFeature.utils.ts#L422) +Defined in: [features/row-sorting/rowSortingFeature.utils.ts:424](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/rowSortingFeature.utils.ts#L424) Checks whether this accessor column can participate in sorting. diff --git a/docs/reference/static-functions/functions/column_getFilterFn.md b/docs/reference/static-functions/functions/column_getFilterFn.md index 06c8014cfc..15472e1030 100644 --- a/docs/reference/static-functions/functions/column_getFilterFn.md +++ b/docs/reference/static-functions/functions/column_getFilterFn.md @@ -11,7 +11,7 @@ function column_getFilterFn(column): | undefined; ``` -Defined in: [features/column-filtering/columnFilteringFeature.utils.ts:104](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-filtering/columnFilteringFeature.utils.ts#L104) +Defined in: [features/column-filtering/columnFilteringFeature.utils.ts:109](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-filtering/columnFilteringFeature.utils.ts#L109) Resolves the filter function configured for a column. diff --git a/docs/reference/static-functions/functions/column_getFilterIndex.md b/docs/reference/static-functions/functions/column_getFilterIndex.md index 47962cb43a..a2aba819af 100644 --- a/docs/reference/static-functions/functions/column_getFilterIndex.md +++ b/docs/reference/static-functions/functions/column_getFilterIndex.md @@ -9,7 +9,7 @@ title: column_getFilterIndex function column_getFilterIndex(column): number; ``` -Defined in: [features/column-filtering/columnFilteringFeature.utils.ts:206](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-filtering/columnFilteringFeature.utils.ts#L206) +Defined in: [features/column-filtering/columnFilteringFeature.utils.ts:211](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-filtering/columnFilteringFeature.utils.ts#L211) Finds this column's position in the ordered `state.columnFilters` array. diff --git a/docs/reference/static-functions/functions/column_getFilterValue.md b/docs/reference/static-functions/functions/column_getFilterValue.md index 8443ea7412..559d6ffaba 100644 --- a/docs/reference/static-functions/functions/column_getFilterValue.md +++ b/docs/reference/static-functions/functions/column_getFilterValue.md @@ -9,7 +9,7 @@ title: column_getFilterValue function column_getFilterValue(column): unknown; ``` -Defined in: [features/column-filtering/columnFilteringFeature.utils.ts:186](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-filtering/columnFilteringFeature.utils.ts#L186) +Defined in: [features/column-filtering/columnFilteringFeature.utils.ts:191](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-filtering/columnFilteringFeature.utils.ts#L191) Reads this column's current filter value from `state.columnFilters`. diff --git a/docs/reference/static-functions/functions/column_getFirstSortDir.md b/docs/reference/static-functions/functions/column_getFirstSortDir.md index 301d4ce731..8225b466b7 100644 --- a/docs/reference/static-functions/functions/column_getFirstSortDir.md +++ b/docs/reference/static-functions/functions/column_getFirstSortDir.md @@ -9,7 +9,7 @@ title: column_getFirstSortDir function column_getFirstSortDir(column): "asc" | "desc"; ``` -Defined in: [features/row-sorting/rowSortingFeature.utils.ts:366](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/rowSortingFeature.utils.ts#L366) +Defined in: [features/row-sorting/rowSortingFeature.utils.ts:368](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/rowSortingFeature.utils.ts#L368) Resolves the first direction used when this column begins sorting. diff --git a/docs/reference/static-functions/functions/column_getIndex.md b/docs/reference/static-functions/functions/column_getIndex.md index ff1d7a8157..a1132e9492 100644 --- a/docs/reference/static-functions/functions/column_getIndex.md +++ b/docs/reference/static-functions/functions/column_getIndex.md @@ -9,7 +9,7 @@ title: column_getIndex function column_getIndex(column, position?): number; ``` -Defined in: [features/column-ordering/columnOrderingFeature.utils.ts:76](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-ordering/columnOrderingFeature.utils.ts#L76) +Defined in: [features/column-ordering/columnOrderingFeature.utils.ts:81](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-ordering/columnOrderingFeature.utils.ts#L81) Finds this column's index within a visible pinning region. diff --git a/docs/reference/static-functions/functions/column_getIsFiltered.md b/docs/reference/static-functions/functions/column_getIsFiltered.md index ff5dd51947..def40032fa 100644 --- a/docs/reference/static-functions/functions/column_getIsFiltered.md +++ b/docs/reference/static-functions/functions/column_getIsFiltered.md @@ -9,7 +9,7 @@ title: column_getIsFiltered function column_getIsFiltered(column): boolean; ``` -Defined in: [features/column-filtering/columnFilteringFeature.utils.ts:168](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-filtering/columnFilteringFeature.utils.ts#L168) +Defined in: [features/column-filtering/columnFilteringFeature.utils.ts:173](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-filtering/columnFilteringFeature.utils.ts#L173) Checks whether this column currently has an entry in `state.columnFilters`. diff --git a/docs/reference/static-functions/functions/column_getIsFirstColumn.md b/docs/reference/static-functions/functions/column_getIsFirstColumn.md index 045536ac17..197acf9554 100644 --- a/docs/reference/static-functions/functions/column_getIsFirstColumn.md +++ b/docs/reference/static-functions/functions/column_getIsFirstColumn.md @@ -9,7 +9,7 @@ title: column_getIsFirstColumn function column_getIsFirstColumn(column, position?): boolean; ``` -Defined in: [features/column-ordering/columnOrderingFeature.utils.ts:110](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-ordering/columnOrderingFeature.utils.ts#L110) +Defined in: [features/column-ordering/columnOrderingFeature.utils.ts:115](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-ordering/columnOrderingFeature.utils.ts#L115) Checks whether this column is the first visible column in a pinning region. diff --git a/docs/reference/static-functions/functions/column_getIsLastColumn.md b/docs/reference/static-functions/functions/column_getIsLastColumn.md index 62d590211e..12fd96101d 100644 --- a/docs/reference/static-functions/functions/column_getIsLastColumn.md +++ b/docs/reference/static-functions/functions/column_getIsLastColumn.md @@ -9,7 +9,7 @@ title: column_getIsLastColumn function column_getIsLastColumn(column, position?): boolean; ``` -Defined in: [features/column-ordering/columnOrderingFeature.utils.ts:132](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-ordering/columnOrderingFeature.utils.ts#L132) +Defined in: [features/column-ordering/columnOrderingFeature.utils.ts:137](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-ordering/columnOrderingFeature.utils.ts#L137) Checks whether this column is the last visible column in a pinning region. diff --git a/docs/reference/static-functions/functions/column_getIsSorted.md b/docs/reference/static-functions/functions/column_getIsSorted.md index 71e0d1e3cb..a3818115c1 100644 --- a/docs/reference/static-functions/functions/column_getIsSorted.md +++ b/docs/reference/static-functions/functions/column_getIsSorted.md @@ -9,7 +9,7 @@ title: column_getIsSorted function column_getIsSorted(column): false | SortDirection; ``` -Defined in: [features/row-sorting/rowSortingFeature.utils.ts:468](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/rowSortingFeature.utils.ts#L468) +Defined in: [features/row-sorting/rowSortingFeature.utils.ts:470](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/rowSortingFeature.utils.ts#L470) Reads this column's current sort direction. diff --git a/docs/reference/static-functions/functions/column_getIsVisible.md b/docs/reference/static-functions/functions/column_getIsVisible.md index 879d20a8a2..2e39506eec 100644 --- a/docs/reference/static-functions/functions/column_getIsVisible.md +++ b/docs/reference/static-functions/functions/column_getIsVisible.md @@ -9,7 +9,7 @@ title: column_getIsVisible function column_getIsVisible(column): boolean; ``` -Defined in: [features/column-visibility/columnVisibilityFeature.utils.ts:81](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/columnVisibilityFeature.utils.ts#L81) +Defined in: [features/column-visibility/columnVisibilityFeature.utils.ts:82](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/columnVisibilityFeature.utils.ts#L82) Checks whether this column is visible. diff --git a/docs/reference/static-functions/functions/column_getNextSortingOrder.md b/docs/reference/static-functions/functions/column_getNextSortingOrder.md index 0041cea2ca..289418d742 100644 --- a/docs/reference/static-functions/functions/column_getNextSortingOrder.md +++ b/docs/reference/static-functions/functions/column_getNextSortingOrder.md @@ -9,7 +9,7 @@ title: column_getNextSortingOrder function column_getNextSortingOrder(column, multi?): false | "asc" | "desc"; ``` -Defined in: [features/row-sorting/rowSortingFeature.utils.ts:389](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/rowSortingFeature.utils.ts#L389) +Defined in: [features/row-sorting/rowSortingFeature.utils.ts:391](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/rowSortingFeature.utils.ts#L391) Resolves the next sort order for this column's toggle cycle. diff --git a/docs/reference/static-functions/functions/column_getSortFn.md b/docs/reference/static-functions/functions/column_getSortFn.md index 3c0ee45ca7..da39e4786c 100644 --- a/docs/reference/static-functions/functions/column_getSortFn.md +++ b/docs/reference/static-functions/functions/column_getSortFn.md @@ -9,7 +9,7 @@ title: column_getSortFn function column_getSortFn(column): SortFn; ``` -Defined in: [features/row-sorting/rowSortingFeature.utils.ts:213](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/rowSortingFeature.utils.ts#L213) +Defined in: [features/row-sorting/rowSortingFeature.utils.ts:215](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/rowSortingFeature.utils.ts#L215) Resolves the sorting function configured for a column. diff --git a/docs/reference/static-functions/functions/column_getSortIndex.md b/docs/reference/static-functions/functions/column_getSortIndex.md index 1f3e19c583..6eb887a4ce 100644 --- a/docs/reference/static-functions/functions/column_getSortIndex.md +++ b/docs/reference/static-functions/functions/column_getSortIndex.md @@ -9,7 +9,7 @@ title: column_getSortIndex function column_getSortIndex(column): number; ``` -Defined in: [features/row-sorting/rowSortingFeature.utils.ts:489](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/rowSortingFeature.utils.ts#L489) +Defined in: [features/row-sorting/rowSortingFeature.utils.ts:491](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/rowSortingFeature.utils.ts#L491) Finds this column's position in the ordered `state.sorting` array. diff --git a/docs/reference/static-functions/functions/column_getToggleSortingHandler.md b/docs/reference/static-functions/functions/column_getToggleSortingHandler.md index cc3ae34960..7fb9b4ce53 100644 --- a/docs/reference/static-functions/functions/column_getToggleSortingHandler.md +++ b/docs/reference/static-functions/functions/column_getToggleSortingHandler.md @@ -9,7 +9,7 @@ title: column_getToggleSortingHandler function column_getToggleSortingHandler(column): (e) => void; ``` -Defined in: [features/row-sorting/rowSortingFeature.utils.ts:532](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/rowSortingFeature.utils.ts#L532) +Defined in: [features/row-sorting/rowSortingFeature.utils.ts:534](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/rowSortingFeature.utils.ts#L534) Creates a header event handler that toggles this column's sorting. diff --git a/docs/reference/static-functions/functions/column_getToggleVisibilityHandler.md b/docs/reference/static-functions/functions/column_getToggleVisibilityHandler.md index 6c2e2f30dc..1bf8923d80 100644 --- a/docs/reference/static-functions/functions/column_getToggleVisibilityHandler.md +++ b/docs/reference/static-functions/functions/column_getToggleVisibilityHandler.md @@ -9,7 +9,7 @@ title: column_getToggleVisibilityHandler function column_getToggleVisibilityHandler(column): (e) => void; ``` -Defined in: [features/column-visibility/columnVisibilityFeature.utils.ts:135](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/columnVisibilityFeature.utils.ts#L135) +Defined in: [features/column-visibility/columnVisibilityFeature.utils.ts:136](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/columnVisibilityFeature.utils.ts#L136) Creates a checkbox-style handler that writes this column's visibility. diff --git a/docs/reference/static-functions/functions/column_setFilterValue.md b/docs/reference/static-functions/functions/column_setFilterValue.md index 63e4690bc7..1b1b7576b3 100644 --- a/docs/reference/static-functions/functions/column_setFilterValue.md +++ b/docs/reference/static-functions/functions/column_setFilterValue.md @@ -9,7 +9,7 @@ title: column_setFilterValue function column_setFilterValue(column, value): void; ``` -Defined in: [features/column-filtering/columnFilteringFeature.utils.ts:229](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-filtering/columnFilteringFeature.utils.ts#L229) +Defined in: [features/column-filtering/columnFilteringFeature.utils.ts:234](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-filtering/columnFilteringFeature.utils.ts#L234) Adds, updates, or removes this column's filter value. diff --git a/docs/reference/static-functions/functions/column_toggleSorting.md b/docs/reference/static-functions/functions/column_toggleSorting.md index 7f600b8b40..57bcec5ad5 100644 --- a/docs/reference/static-functions/functions/column_toggleSorting.md +++ b/docs/reference/static-functions/functions/column_toggleSorting.md @@ -12,7 +12,7 @@ function column_toggleSorting( multi?): void; ``` -Defined in: [features/row-sorting/rowSortingFeature.utils.ts:252](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/rowSortingFeature.utils.ts#L252) +Defined in: [features/row-sorting/rowSortingFeature.utils.ts:254](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/rowSortingFeature.utils.ts#L254) Applies the next sorting state for this column. diff --git a/docs/reference/static-functions/functions/column_toggleVisibility.md b/docs/reference/static-functions/functions/column_toggleVisibility.md index 2682fe73e5..06ae01664b 100644 --- a/docs/reference/static-functions/functions/column_toggleVisibility.md +++ b/docs/reference/static-functions/functions/column_toggleVisibility.md @@ -9,7 +9,7 @@ title: column_toggleVisibility function column_toggleVisibility(column, visible?): void; ``` -Defined in: [features/column-visibility/columnVisibilityFeature.utils.ts:44](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/columnVisibilityFeature.utils.ts#L44) +Defined in: [features/column-visibility/columnVisibilityFeature.utils.ts:45](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/columnVisibilityFeature.utils.ts#L45) Updates this column's visibility when hiding is allowed. diff --git a/docs/reference/static-functions/functions/getDefaultCellSelectionState.md b/docs/reference/static-functions/functions/getDefaultCellSelectionState.md index 55359197dd..6f81af612d 100644 --- a/docs/reference/static-functions/functions/getDefaultCellSelectionState.md +++ b/docs/reference/static-functions/functions/getDefaultCellSelectionState.md @@ -9,7 +9,7 @@ title: getDefaultCellSelectionState function getDefaultCellSelectionState(): CellSelectionState; ``` -Defined in: [features/cell-selection/cellSelectionFeature.utils.ts:37](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/cell-selection/cellSelectionFeature.utils.ts#L37) +Defined in: [features/cell-selection/cellSelectionFeature.utils.ts:42](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/cell-selection/cellSelectionFeature.utils.ts#L42) Creates the default cell selection state. diff --git a/docs/reference/static-functions/functions/getDefaultColumnFiltersState.md b/docs/reference/static-functions/functions/getDefaultColumnFiltersState.md index ecceb38179..95c5f5aa82 100644 --- a/docs/reference/static-functions/functions/getDefaultColumnFiltersState.md +++ b/docs/reference/static-functions/functions/getDefaultColumnFiltersState.md @@ -9,7 +9,7 @@ title: getDefaultColumnFiltersState function getDefaultColumnFiltersState(): ColumnFiltersState; ``` -Defined in: [features/column-filtering/columnFilteringFeature.utils.ts:22](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-filtering/columnFilteringFeature.utils.ts#L22) +Defined in: [features/column-filtering/columnFilteringFeature.utils.ts:27](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-filtering/columnFilteringFeature.utils.ts#L27) Creates the default column filter state. diff --git a/docs/reference/static-functions/functions/getDefaultColumnOrderState.md b/docs/reference/static-functions/functions/getDefaultColumnOrderState.md index d8e7edec3b..bcbd9f2f11 100644 --- a/docs/reference/static-functions/functions/getDefaultColumnOrderState.md +++ b/docs/reference/static-functions/functions/getDefaultColumnOrderState.md @@ -9,7 +9,7 @@ title: getDefaultColumnOrderState function getDefaultColumnOrderState(): ColumnOrderState; ``` -Defined in: [features/column-ordering/columnOrderingFeature.utils.ts:25](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-ordering/columnOrderingFeature.utils.ts#L25) +Defined in: [features/column-ordering/columnOrderingFeature.utils.ts:30](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-ordering/columnOrderingFeature.utils.ts#L30) Creates the default column order state. diff --git a/docs/reference/static-functions/functions/getDefaultColumnVisibilityState.md b/docs/reference/static-functions/functions/getDefaultColumnVisibilityState.md index 171c42417a..70a59ec342 100644 --- a/docs/reference/static-functions/functions/getDefaultColumnVisibilityState.md +++ b/docs/reference/static-functions/functions/getDefaultColumnVisibilityState.md @@ -9,7 +9,7 @@ title: getDefaultColumnVisibilityState function getDefaultColumnVisibilityState(): ColumnVisibilityState; ``` -Defined in: [features/column-visibility/columnVisibilityFeature.utils.ts:27](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/columnVisibilityFeature.utils.ts#L27) +Defined in: [features/column-visibility/columnVisibilityFeature.utils.ts:28](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/columnVisibilityFeature.utils.ts#L28) Creates the default column visibility state. diff --git a/docs/reference/static-functions/functions/isRowSelected.md b/docs/reference/static-functions/functions/isRowSelected.md index f20be1e146..415b90ca44 100644 --- a/docs/reference/static-functions/functions/isRowSelected.md +++ b/docs/reference/static-functions/functions/isRowSelected.md @@ -9,7 +9,7 @@ title: isRowSelected function isRowSelected(row, rowSelection): boolean; ``` -Defined in: [features/row-selection/rowSelectionFeature.utils.ts:993](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/rowSelectionFeature.utils.ts#L993) +Defined in: [features/row-selection/rowSelectionFeature.utils.ts:996](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/rowSelectionFeature.utils.ts#L996) Returns whether a row id is selected in the current row selection state. diff --git a/docs/reference/static-functions/functions/isSubRowSelected.md b/docs/reference/static-functions/functions/isSubRowSelected.md index 607aab2ba7..2d9841ef73 100644 --- a/docs/reference/static-functions/functions/isSubRowSelected.md +++ b/docs/reference/static-functions/functions/isSubRowSelected.md @@ -9,7 +9,7 @@ title: isSubRowSelected function isSubRowSelected(row): boolean | "some" | "all"; ``` -Defined in: [features/row-selection/rowSelectionFeature.utils.ts:1010](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/rowSelectionFeature.utils.ts#L1010) +Defined in: [features/row-selection/rowSelectionFeature.utils.ts:1013](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/rowSelectionFeature.utils.ts#L1013) Returns whether all, some, or none of a row's selectable descendants are selected. diff --git a/docs/reference/static-functions/functions/isTouchStartEvent.md b/docs/reference/static-functions/functions/isTouchStartEvent.md index 0557c6c2f1..6083cffb25 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:428](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-resizing/columnResizingFeature.utils.ts#L428) +Defined in: [features/column-resizing/columnResizingFeature.utils.ts:431](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-resizing/columnResizingFeature.utils.ts#L431) Narrows an unknown event to a `touchstart` event. diff --git a/docs/reference/static-functions/functions/orderColumns.md b/docs/reference/static-functions/functions/orderColumns.md index d3ffa1d327..f05a0dbc94 100644 --- a/docs/reference/static-functions/functions/orderColumns.md +++ b/docs/reference/static-functions/functions/orderColumns.md @@ -9,7 +9,7 @@ title: orderColumns function orderColumns(table, leafColumns): Column_Internal[]; ``` -Defined in: [features/column-ordering/columnOrderingFeature.utils.ts:254](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-ordering/columnOrderingFeature.utils.ts#L254) +Defined in: [features/column-ordering/columnOrderingFeature.utils.ts:259](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-ordering/columnOrderingFeature.utils.ts#L259) Applies grouped-column placement rules to an already ordered leaf-column list. diff --git a/docs/reference/static-functions/functions/passiveEventSupported.md b/docs/reference/static-functions/functions/passiveEventSupported.md index 77c532b492..eec40d18b7 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:394](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-resizing/columnResizingFeature.utils.ts#L394) +Defined in: [features/column-resizing/columnResizingFeature.utils.ts:397](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-resizing/columnResizingFeature.utils.ts#L397) Detects whether the current environment supports passive event listeners. diff --git a/docs/reference/static-functions/functions/row_getCanExpand.md b/docs/reference/static-functions/functions/row_getCanExpand.md index eb5e84e379..46b59a809f 100644 --- a/docs/reference/static-functions/functions/row_getCanExpand.md +++ b/docs/reference/static-functions/functions/row_getCanExpand.md @@ -9,7 +9,7 @@ title: row_getCanExpand function row_getCanExpand(row): boolean; ``` -Defined in: [features/row-expanding/rowExpandingFeature.utils.ts:378](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-expanding/rowExpandingFeature.utils.ts#L378) +Defined in: [features/row-expanding/rowExpandingFeature.utils.ts:383](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-expanding/rowExpandingFeature.utils.ts#L383) Checks whether this row can be expanded. diff --git a/docs/reference/static-functions/functions/row_getCanMultiSelect.md b/docs/reference/static-functions/functions/row_getCanMultiSelect.md index d2790bdb0d..ec3f6f4133 100644 --- a/docs/reference/static-functions/functions/row_getCanMultiSelect.md +++ b/docs/reference/static-functions/functions/row_getCanMultiSelect.md @@ -9,7 +9,7 @@ title: row_getCanMultiSelect function row_getCanMultiSelect(row): boolean; ``` -Defined in: [features/row-selection/rowSelectionFeature.utils.ts:667](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/rowSelectionFeature.utils.ts#L667) +Defined in: [features/row-selection/rowSelectionFeature.utils.ts:670](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/rowSelectionFeature.utils.ts#L670) Checks whether this row can be selected alongside other rows. diff --git a/docs/reference/static-functions/functions/row_getCanSelect.md b/docs/reference/static-functions/functions/row_getCanSelect.md index 2edb7247a1..2f49ceba98 100644 --- a/docs/reference/static-functions/functions/row_getCanSelect.md +++ b/docs/reference/static-functions/functions/row_getCanSelect.md @@ -9,7 +9,7 @@ title: row_getCanSelect function row_getCanSelect(row): boolean; ``` -Defined in: [features/row-selection/rowSelectionFeature.utils.ts:621](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/rowSelectionFeature.utils.ts#L621) +Defined in: [features/row-selection/rowSelectionFeature.utils.ts:624](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/rowSelectionFeature.utils.ts#L624) Checks whether this row can be selected. diff --git a/docs/reference/static-functions/functions/row_getCanSelectSubRows.md b/docs/reference/static-functions/functions/row_getCanSelectSubRows.md index f9ba0d1e44..9f1e4af4cf 100644 --- a/docs/reference/static-functions/functions/row_getCanSelectSubRows.md +++ b/docs/reference/static-functions/functions/row_getCanSelectSubRows.md @@ -9,7 +9,7 @@ title: row_getCanSelectSubRows function row_getCanSelectSubRows(row): boolean; ``` -Defined in: [features/row-selection/rowSelectionFeature.utils.ts:644](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/rowSelectionFeature.utils.ts#L644) +Defined in: [features/row-selection/rowSelectionFeature.utils.ts:647](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/rowSelectionFeature.utils.ts#L647) Checks whether selecting this row should also select its subRows. diff --git a/docs/reference/static-functions/functions/row_getIsAllParentsExpanded.md b/docs/reference/static-functions/functions/row_getIsAllParentsExpanded.md index e9d9add8f8..6681da102a 100644 --- a/docs/reference/static-functions/functions/row_getIsAllParentsExpanded.md +++ b/docs/reference/static-functions/functions/row_getIsAllParentsExpanded.md @@ -9,7 +9,7 @@ title: row_getIsAllParentsExpanded function row_getIsAllParentsExpanded(row): boolean; ``` -Defined in: [features/row-expanding/rowExpandingFeature.utils.ts:398](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-expanding/rowExpandingFeature.utils.ts#L398) +Defined in: [features/row-expanding/rowExpandingFeature.utils.ts:403](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-expanding/rowExpandingFeature.utils.ts#L403) Checks whether every ancestor of this row is expanded. diff --git a/docs/reference/static-functions/functions/row_getIsAllSubRowsSelected.md b/docs/reference/static-functions/functions/row_getIsAllSubRowsSelected.md index 3d7bf9c37a..7c1afa1a92 100644 --- a/docs/reference/static-functions/functions/row_getIsAllSubRowsSelected.md +++ b/docs/reference/static-functions/functions/row_getIsAllSubRowsSelected.md @@ -9,7 +9,7 @@ title: row_getIsAllSubRowsSelected function row_getIsAllSubRowsSelected(row): boolean; ``` -Defined in: [features/row-selection/rowSelectionFeature.utils.ts:603](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/rowSelectionFeature.utils.ts#L603) +Defined in: [features/row-selection/rowSelectionFeature.utils.ts:606](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/rowSelectionFeature.utils.ts#L606) Checks whether all selectable descendants are selected. diff --git a/docs/reference/static-functions/functions/row_getIsExpanded.md b/docs/reference/static-functions/functions/row_getIsExpanded.md index b54f1e7ebc..41ca001e81 100644 --- a/docs/reference/static-functions/functions/row_getIsExpanded.md +++ b/docs/reference/static-functions/functions/row_getIsExpanded.md @@ -9,7 +9,7 @@ title: row_getIsExpanded function row_getIsExpanded(row): boolean; ``` -Defined in: [features/row-expanding/rowExpandingFeature.utils.ts:343](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-expanding/rowExpandingFeature.utils.ts#L343) +Defined in: [features/row-expanding/rowExpandingFeature.utils.ts:348](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-expanding/rowExpandingFeature.utils.ts#L348) Checks whether this row is expanded. diff --git a/docs/reference/static-functions/functions/row_getIsSelected.md b/docs/reference/static-functions/functions/row_getIsSelected.md index 5ed80cc080..9a8ee8ef38 100644 --- a/docs/reference/static-functions/functions/row_getIsSelected.md +++ b/docs/reference/static-functions/functions/row_getIsSelected.md @@ -9,7 +9,7 @@ title: row_getIsSelected function row_getIsSelected(row): boolean; ``` -Defined in: [features/row-selection/rowSelectionFeature.utils.ts:568](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/rowSelectionFeature.utils.ts#L568) +Defined in: [features/row-selection/rowSelectionFeature.utils.ts:571](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/rowSelectionFeature.utils.ts#L571) Checks whether this row id is selected in `state.rowSelection`. diff --git a/docs/reference/static-functions/functions/row_getIsSomeSelected.md b/docs/reference/static-functions/functions/row_getIsSomeSelected.md index c359bdc12c..f52f0ddeec 100644 --- a/docs/reference/static-functions/functions/row_getIsSomeSelected.md +++ b/docs/reference/static-functions/functions/row_getIsSomeSelected.md @@ -9,7 +9,7 @@ title: row_getIsSomeSelected function row_getIsSomeSelected(row): boolean; ``` -Defined in: [features/row-selection/rowSelectionFeature.utils.ts:586](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/rowSelectionFeature.utils.ts#L586) +Defined in: [features/row-selection/rowSelectionFeature.utils.ts:589](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/rowSelectionFeature.utils.ts#L589) Checks whether some, but not all, selectable descendants are selected. diff --git a/docs/reference/static-functions/functions/row_getToggleExpandedHandler.md b/docs/reference/static-functions/functions/row_getToggleExpandedHandler.md index 22537d3c1f..c11e6ed2dd 100644 --- a/docs/reference/static-functions/functions/row_getToggleExpandedHandler.md +++ b/docs/reference/static-functions/functions/row_getToggleExpandedHandler.md @@ -9,7 +9,7 @@ title: row_getToggleExpandedHandler function row_getToggleExpandedHandler(row): () => void; ``` -Defined in: [features/row-expanding/rowExpandingFeature.utils.ts:423](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-expanding/rowExpandingFeature.utils.ts#L423) +Defined in: [features/row-expanding/rowExpandingFeature.utils.ts:428](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-expanding/rowExpandingFeature.utils.ts#L428) Creates a row control handler that toggles this row's expanded state. diff --git a/docs/reference/static-functions/functions/row_getToggleSelectedHandler.md b/docs/reference/static-functions/functions/row_getToggleSelectedHandler.md index 69703244b2..909fa29165 100644 --- a/docs/reference/static-functions/functions/row_getToggleSelectedHandler.md +++ b/docs/reference/static-functions/functions/row_getToggleSelectedHandler.md @@ -9,7 +9,7 @@ title: row_getToggleSelectedHandler function row_getToggleSelectedHandler(row, opts?): (e) => void; ``` -Defined in: [features/row-selection/rowSelectionFeature.utils.ts:694](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/rowSelectionFeature.utils.ts#L694) +Defined in: [features/row-selection/rowSelectionFeature.utils.ts:697](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/rowSelectionFeature.utils.ts#L697) Creates a checkbox-style handler that selects or deselects this row. diff --git a/docs/reference/static-functions/functions/row_getVisibleCells.md b/docs/reference/static-functions/functions/row_getVisibleCells.md index 66f70bf8f3..45cb9d799a 100644 --- a/docs/reference/static-functions/functions/row_getVisibleCells.md +++ b/docs/reference/static-functions/functions/row_getVisibleCells.md @@ -9,7 +9,7 @@ title: row_getVisibleCells function row_getVisibleCells(row): Cell[]; ``` -Defined in: [features/column-visibility/columnVisibilityFeature.utils.ts:159](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/columnVisibilityFeature.utils.ts#L159) +Defined in: [features/column-visibility/columnVisibilityFeature.utils.ts:160](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/columnVisibilityFeature.utils.ts#L160) Collects the cells from this row whose columns are visible. diff --git a/docs/reference/static-functions/functions/row_getVisibleCellsByColumnId.md b/docs/reference/static-functions/functions/row_getVisibleCellsByColumnId.md index 6208e81771..26562586a8 100644 --- a/docs/reference/static-functions/functions/row_getVisibleCellsByColumnId.md +++ b/docs/reference/static-functions/functions/row_getVisibleCellsByColumnId.md @@ -9,7 +9,7 @@ title: row_getVisibleCellsByColumnId function row_getVisibleCellsByColumnId(row): Record>; ``` -Defined in: [features/column-visibility/columnVisibilityFeature.utils.ts:215](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/columnVisibilityFeature.utils.ts#L215) +Defined in: [features/column-visibility/columnVisibilityFeature.utils.ts:216](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/columnVisibilityFeature.utils.ts#L216) Builds a lookup map of this row's visible cells keyed by column id. diff --git a/docs/reference/static-functions/functions/row_toggleExpanded.md b/docs/reference/static-functions/functions/row_toggleExpanded.md index 2a262152d8..4c9b8baf45 100644 --- a/docs/reference/static-functions/functions/row_toggleExpanded.md +++ b/docs/reference/static-functions/functions/row_toggleExpanded.md @@ -9,7 +9,7 @@ title: row_toggleExpanded function row_toggleExpanded(row, expanded?): void; ``` -Defined in: [features/row-expanding/rowExpandingFeature.utils.ts:284](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-expanding/rowExpandingFeature.utils.ts#L284) +Defined in: [features/row-expanding/rowExpandingFeature.utils.ts:289](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-expanding/rowExpandingFeature.utils.ts#L289) Expands or collapses this row. diff --git a/docs/reference/static-functions/functions/row_toggleSelected.md b/docs/reference/static-functions/functions/row_toggleSelected.md index b110304ff1..9892e799f5 100644 --- a/docs/reference/static-functions/functions/row_toggleSelected.md +++ b/docs/reference/static-functions/functions/row_toggleSelected.md @@ -12,7 +12,7 @@ function row_toggleSelected( opts?): void; ``` -Defined in: [features/row-selection/rowSelectionFeature.utils.ts:531](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/rowSelectionFeature.utils.ts#L531) +Defined in: [features/row-selection/rowSelectionFeature.utils.ts:534](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/rowSelectionFeature.utils.ts#L534) Selects or deselects this row. diff --git a/docs/reference/static-functions/functions/selectRowsFn.md b/docs/reference/static-functions/functions/selectRowsFn.md index 0032af5a3d..2dc290766c 100644 --- a/docs/reference/static-functions/functions/selectRowsFn.md +++ b/docs/reference/static-functions/functions/selectRowsFn.md @@ -9,7 +9,7 @@ title: selectRowsFn function selectRowsFn(rowModel, table): RowModel; ``` -Defined in: [features/row-selection/rowSelectionFeature.utils.ts:962](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/rowSelectionFeature.utils.ts#L962) +Defined in: [features/row-selection/rowSelectionFeature.utils.ts:965](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/rowSelectionFeature.utils.ts#L965) Builds a row model containing rows selected by the current row selection state. diff --git a/docs/reference/static-functions/functions/shouldAutoRemoveFilter.md b/docs/reference/static-functions/functions/shouldAutoRemoveFilter.md index dd578f0db8..15528e8b9c 100644 --- a/docs/reference/static-functions/functions/shouldAutoRemoveFilter.md +++ b/docs/reference/static-functions/functions/shouldAutoRemoveFilter.md @@ -12,7 +12,7 @@ function shouldAutoRemoveFilter( column?): boolean; ``` -Defined in: [features/column-filtering/columnFilteringFeature.utils.ts:343](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-filtering/columnFilteringFeature.utils.ts#L343) +Defined in: [features/column-filtering/columnFilteringFeature.utils.ts:348](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-filtering/columnFilteringFeature.utils.ts#L348) Returns whether a filter value should be removed from filter state. diff --git a/docs/reference/static-functions/functions/table_autoResetCellSelection.md b/docs/reference/static-functions/functions/table_autoResetCellSelection.md index 9313c1407b..09c4143ff3 100644 --- a/docs/reference/static-functions/functions/table_autoResetCellSelection.md +++ b/docs/reference/static-functions/functions/table_autoResetCellSelection.md @@ -9,7 +9,7 @@ title: table_autoResetCellSelection function table_autoResetCellSelection(table): void; ``` -Defined in: [features/cell-selection/cellSelectionFeature.utils.ts:99](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/cell-selection/cellSelectionFeature.utils.ts#L99) +Defined in: [features/cell-selection/cellSelectionFeature.utils.ts:107](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/cell-selection/cellSelectionFeature.utils.ts#L107) Schedules a cell selection reset after `data` changes. diff --git a/docs/reference/static-functions/functions/table_autoResetSorting.md b/docs/reference/static-functions/functions/table_autoResetSorting.md index c7ca2c37e7..51fbc5b800 100644 --- a/docs/reference/static-functions/functions/table_autoResetSorting.md +++ b/docs/reference/static-functions/functions/table_autoResetSorting.md @@ -9,7 +9,7 @@ title: table_autoResetSorting function table_autoResetSorting(table): void; ``` -Defined in: [features/row-sorting/rowSortingFeature.utils.ts:81](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/rowSortingFeature.utils.ts#L81) +Defined in: [features/row-sorting/rowSortingFeature.utils.ts:83](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/rowSortingFeature.utils.ts#L83) Resets sorting after the table data changes when explicitly enabled. diff --git a/docs/reference/static-functions/functions/table_extendCellSelection.md b/docs/reference/static-functions/functions/table_extendCellSelection.md index 0b328b9508..7bc7561ff4 100644 --- a/docs/reference/static-functions/functions/table_extendCellSelection.md +++ b/docs/reference/static-functions/functions/table_extendCellSelection.md @@ -9,7 +9,7 @@ title: table_extendCellSelection function table_extendCellSelection(table, direction): void; ``` -Defined in: [features/cell-selection/cellSelectionFeature.utils.ts:1068](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/cell-selection/cellSelectionFeature.utils.ts#L1068) +Defined in: [features/cell-selection/cellSelectionFeature.utils.ts:1076](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/cell-selection/cellSelectionFeature.utils.ts#L1076) Extends the active range one step in a direction, keeping its anchor fixed. diff --git a/docs/reference/static-functions/functions/table_firstPage.md b/docs/reference/static-functions/functions/table_firstPage.md index b8eede8120..339f861da9 100644 --- a/docs/reference/static-functions/functions/table_firstPage.md +++ b/docs/reference/static-functions/functions/table_firstPage.md @@ -9,7 +9,7 @@ title: table_firstPage function table_firstPage(table): void; ``` -Defined in: [features/row-pagination/rowPaginationFeature.utils.ts:360](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pagination/rowPaginationFeature.utils.ts#L360) +Defined in: [features/row-pagination/rowPaginationFeature.utils.ts:359](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pagination/rowPaginationFeature.utils.ts#L359) Moves the table to the first page. diff --git a/docs/reference/static-functions/functions/table_getCanLastPage.md b/docs/reference/static-functions/functions/table_getCanLastPage.md index de36b2f23f..edfcd49371 100644 --- a/docs/reference/static-functions/functions/table_getCanLastPage.md +++ b/docs/reference/static-functions/functions/table_getCanLastPage.md @@ -9,7 +9,7 @@ title: table_getCanLastPage function table_getCanLastPage(table): boolean; ``` -Defined in: [features/row-pagination/rowPaginationFeature.utils.ts:300](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pagination/rowPaginationFeature.utils.ts#L300) +Defined in: [features/row-pagination/rowPaginationFeature.utils.ts:299](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pagination/rowPaginationFeature.utils.ts#L299) Checks whether a known, finite last page exists after the current page. diff --git a/docs/reference/static-functions/functions/table_getCanNextPage.md b/docs/reference/static-functions/functions/table_getCanNextPage.md index b4dd8a0ea9..9ed18a222b 100644 --- a/docs/reference/static-functions/functions/table_getCanNextPage.md +++ b/docs/reference/static-functions/functions/table_getCanNextPage.md @@ -9,7 +9,7 @@ title: table_getCanNextPage function table_getCanNextPage(table): boolean; ``` -Defined in: [features/row-pagination/rowPaginationFeature.utils.ts:270](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pagination/rowPaginationFeature.utils.ts#L270) +Defined in: [features/row-pagination/rowPaginationFeature.utils.ts:269](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pagination/rowPaginationFeature.utils.ts#L269) Checks whether the current page index can move forward. diff --git a/docs/reference/static-functions/functions/table_getCanPreviousPage.md b/docs/reference/static-functions/functions/table_getCanPreviousPage.md index 3c83e83f0b..ffbde6d182 100644 --- a/docs/reference/static-functions/functions/table_getCanPreviousPage.md +++ b/docs/reference/static-functions/functions/table_getCanPreviousPage.md @@ -9,7 +9,7 @@ title: table_getCanPreviousPage function table_getCanPreviousPage(table): boolean; ``` -Defined in: [features/row-pagination/rowPaginationFeature.utils.ts:252](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pagination/rowPaginationFeature.utils.ts#L252) +Defined in: [features/row-pagination/rowPaginationFeature.utils.ts:251](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pagination/rowPaginationFeature.utils.ts#L251) Checks whether the current page index can move backward. diff --git a/docs/reference/static-functions/functions/table_getCanSomeRowsExpand.md b/docs/reference/static-functions/functions/table_getCanSomeRowsExpand.md index 8d8555ce3d..71ae9234b4 100644 --- a/docs/reference/static-functions/functions/table_getCanSomeRowsExpand.md +++ b/docs/reference/static-functions/functions/table_getCanSomeRowsExpand.md @@ -9,7 +9,7 @@ title: table_getCanSomeRowsExpand function table_getCanSomeRowsExpand(table): boolean; ``` -Defined in: [features/row-expanding/rowExpandingFeature.utils.ts:145](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-expanding/rowExpandingFeature.utils.ts#L145) +Defined in: [features/row-expanding/rowExpandingFeature.utils.ts:150](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-expanding/rowExpandingFeature.utils.ts#L150) Checks whether at least one pre-paginated row can expand. diff --git a/docs/reference/static-functions/functions/table_getCellSelectionBounds.md b/docs/reference/static-functions/functions/table_getCellSelectionBounds.md index 1128ecc17e..65cf926c87 100644 --- a/docs/reference/static-functions/functions/table_getCellSelectionBounds.md +++ b/docs/reference/static-functions/functions/table_getCellSelectionBounds.md @@ -9,7 +9,7 @@ title: table_getCellSelectionBounds function table_getCellSelectionBounds(table): CellSelectionBounds[]; ``` -Defined in: [features/cell-selection/cellSelectionFeature.utils.ts:406](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/cell-selection/cellSelectionFeature.utils.ts#L406) +Defined in: [features/cell-selection/cellSelectionFeature.utils.ts:414](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/cell-selection/cellSelectionFeature.utils.ts#L414) Resolves ordered range operations into disjoint, positive display-order index rectangles. diff --git a/docs/reference/static-functions/functions/table_getCellSelectionColumnIds.md b/docs/reference/static-functions/functions/table_getCellSelectionColumnIds.md index 3fc32eb23f..32596d764d 100644 --- a/docs/reference/static-functions/functions/table_getCellSelectionColumnIds.md +++ b/docs/reference/static-functions/functions/table_getCellSelectionColumnIds.md @@ -9,7 +9,7 @@ title: table_getCellSelectionColumnIds function table_getCellSelectionColumnIds(table): string[]; ``` -Defined in: [features/cell-selection/cellSelectionFeature.utils.ts:1353](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/cell-selection/cellSelectionFeature.utils.ts#L1353) +Defined in: [features/cell-selection/cellSelectionFeature.utils.ts:1361](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/cell-selection/cellSelectionFeature.utils.ts#L1361) Returns the ids of all columns intersected by the selection. diff --git a/docs/reference/static-functions/functions/table_getCellSelectionColumnIndexes.md b/docs/reference/static-functions/functions/table_getCellSelectionColumnIndexes.md index a8ec8efbff..cf41d723c5 100644 --- a/docs/reference/static-functions/functions/table_getCellSelectionColumnIndexes.md +++ b/docs/reference/static-functions/functions/table_getCellSelectionColumnIndexes.md @@ -9,7 +9,7 @@ title: table_getCellSelectionColumnIndexes function table_getCellSelectionColumnIndexes(table): Record; ``` -Defined in: [features/cell-selection/cellSelectionFeature.utils.ts:192](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/cell-selection/cellSelectionFeature.utils.ts#L192) +Defined in: [features/cell-selection/cellSelectionFeature.utils.ts:200](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/cell-selection/cellSelectionFeature.utils.ts#L200) Builds a column id to render-order index map. diff --git a/docs/reference/static-functions/functions/table_getCellSelectionMergeBounds.md b/docs/reference/static-functions/functions/table_getCellSelectionMergeBounds.md index c5a344bff5..c187e0f248 100644 --- a/docs/reference/static-functions/functions/table_getCellSelectionMergeBounds.md +++ b/docs/reference/static-functions/functions/table_getCellSelectionMergeBounds.md @@ -9,7 +9,7 @@ title: table_getCellSelectionMergeBounds function table_getCellSelectionMergeBounds(table): CellSelectionBounds[]; ``` -Defined in: [features/cell-selection/cellSelectionFeature.utils.ts:255](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/cell-selection/cellSelectionFeature.utils.ts#L255) +Defined in: [features/cell-selection/cellSelectionFeature.utils.ts:263](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/cell-selection/cellSelectionFeature.utils.ts#L263) Resolves the merged-cell rectangles of the rendered rows into selection's own index space. diff --git a/docs/reference/static-functions/functions/table_getCellSelectionRowIds.md b/docs/reference/static-functions/functions/table_getCellSelectionRowIds.md index 7e987cb147..627192652a 100644 --- a/docs/reference/static-functions/functions/table_getCellSelectionRowIds.md +++ b/docs/reference/static-functions/functions/table_getCellSelectionRowIds.md @@ -9,7 +9,7 @@ title: table_getCellSelectionRowIds function table_getCellSelectionRowIds(table): string[]; ``` -Defined in: [features/cell-selection/cellSelectionFeature.utils.ts:1316](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/cell-selection/cellSelectionFeature.utils.ts#L1316) +Defined in: [features/cell-selection/cellSelectionFeature.utils.ts:1324](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/cell-selection/cellSelectionFeature.utils.ts#L1324) Returns the ids of all rows intersected by the selection. diff --git a/docs/reference/static-functions/functions/table_getCenterTotalSize.md b/docs/reference/static-functions/functions/table_getCenterTotalSize.md index 22f8379b99..6ddf7f2077 100644 --- a/docs/reference/static-functions/functions/table_getCenterTotalSize.md +++ b/docs/reference/static-functions/functions/table_getCenterTotalSize.md @@ -9,7 +9,7 @@ title: table_getCenterTotalSize function table_getCenterTotalSize(table): number; ``` -Defined in: [features/column-sizing/columnSizingFeature.utils.ts:428](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-sizing/columnSizingFeature.utils.ts#L428) +Defined in: [features/column-sizing/columnSizingFeature.utils.ts:430](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-sizing/columnSizingFeature.utils.ts#L430) Sums the rendered size of the center, unpinned header region. diff --git a/docs/reference/static-functions/functions/table_getColumnIndexes.md b/docs/reference/static-functions/functions/table_getColumnIndexes.md index 72adadd59c..546f4280fd 100644 --- a/docs/reference/static-functions/functions/table_getColumnIndexes.md +++ b/docs/reference/static-functions/functions/table_getColumnIndexes.md @@ -9,7 +9,7 @@ title: table_getColumnIndexes function table_getColumnIndexes(table): ColumnIndexes; ``` -Defined in: [features/column-ordering/columnOrderingFeature.utils.ts:40](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-ordering/columnOrderingFeature.utils.ts#L40) +Defined in: [features/column-ordering/columnOrderingFeature.utils.ts:45](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-ordering/columnOrderingFeature.utils.ts#L45) Builds column-id to index records for each visible pinning region. diff --git a/docs/reference/static-functions/functions/table_getEndTotalSize.md b/docs/reference/static-functions/functions/table_getEndTotalSize.md index 021a1eefdb..68ff6af37c 100644 --- a/docs/reference/static-functions/functions/table_getEndTotalSize.md +++ b/docs/reference/static-functions/functions/table_getEndTotalSize.md @@ -9,7 +9,7 @@ title: table_getEndTotalSize function table_getEndTotalSize(table): number; ``` -Defined in: [features/column-sizing/columnSizingFeature.utils.ts:453](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-sizing/columnSizingFeature.utils.ts#L453) +Defined in: [features/column-sizing/columnSizingFeature.utils.ts:455](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-sizing/columnSizingFeature.utils.ts#L455) Sums the rendered size of the logical end pinned header region. diff --git a/docs/reference/static-functions/functions/table_getExpandedDepth.md b/docs/reference/static-functions/functions/table_getExpandedDepth.md index b65b28ec64..a002316015 100644 --- a/docs/reference/static-functions/functions/table_getExpandedDepth.md +++ b/docs/reference/static-functions/functions/table_getExpandedDepth.md @@ -9,7 +9,7 @@ title: table_getExpandedDepth function table_getExpandedDepth(table): number; ``` -Defined in: [features/row-expanding/rowExpandingFeature.utils.ts:245](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-expanding/rowExpandingFeature.utils.ts#L245) +Defined in: [features/row-expanding/rowExpandingFeature.utils.ts:250](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-expanding/rowExpandingFeature.utils.ts#L250) Computes the deepest expanded row id depth. diff --git a/docs/reference/static-functions/functions/table_getFilteredSelectedRowModel.md b/docs/reference/static-functions/functions/table_getFilteredSelectedRowModel.md index bf34a4dc7b..2046d92bff 100644 --- a/docs/reference/static-functions/functions/table_getFilteredSelectedRowModel.md +++ b/docs/reference/static-functions/functions/table_getFilteredSelectedRowModel.md @@ -15,7 +15,7 @@ function table_getFilteredSelectedRowModel(table): }; ``` -Defined in: [features/row-selection/rowSelectionFeature.utils.ts:269](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/rowSelectionFeature.utils.ts#L269) +Defined in: [features/row-selection/rowSelectionFeature.utils.ts:272](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/rowSelectionFeature.utils.ts#L272) Builds a row model containing selected rows from the filtered row model. diff --git a/docs/reference/static-functions/functions/table_getFocusedCell.md b/docs/reference/static-functions/functions/table_getFocusedCell.md index 22184b8115..aac6b6f08c 100644 --- a/docs/reference/static-functions/functions/table_getFocusedCell.md +++ b/docs/reference/static-functions/functions/table_getFocusedCell.md @@ -11,7 +11,7 @@ function table_getFocusedCell(table): | undefined; ``` -Defined in: [features/cell-selection/cellSelectionFeature.utils.ts:752](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/cell-selection/cellSelectionFeature.utils.ts#L752) +Defined in: [features/cell-selection/cellSelectionFeature.utils.ts:760](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/cell-selection/cellSelectionFeature.utils.ts#L760) Returns the active cell, i.e. the anchor of the most recent operation. diff --git a/docs/reference/static-functions/functions/table_getGroupedSelectedRowModel.md b/docs/reference/static-functions/functions/table_getGroupedSelectedRowModel.md index 7da9e087a0..067cead7e1 100644 --- a/docs/reference/static-functions/functions/table_getGroupedSelectedRowModel.md +++ b/docs/reference/static-functions/functions/table_getGroupedSelectedRowModel.md @@ -15,7 +15,7 @@ function table_getGroupedSelectedRowModel(table): }; ``` -Defined in: [features/row-selection/rowSelectionFeature.utils.ts:303](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/rowSelectionFeature.utils.ts#L303) +Defined in: [features/row-selection/rowSelectionFeature.utils.ts:306](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/rowSelectionFeature.utils.ts#L306) Builds a row model containing selected rows from the grouped row model. diff --git a/docs/reference/static-functions/functions/table_getIsAllColumnsVisible.md b/docs/reference/static-functions/functions/table_getIsAllColumnsVisible.md index 95c750147a..6888ca8113 100644 --- a/docs/reference/static-functions/functions/table_getIsAllColumnsVisible.md +++ b/docs/reference/static-functions/functions/table_getIsAllColumnsVisible.md @@ -9,7 +9,7 @@ title: table_getIsAllColumnsVisible function table_getIsAllColumnsVisible(table): boolean; ``` -Defined in: [features/column-visibility/columnVisibilityFeature.utils.ts:359](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/columnVisibilityFeature.utils.ts#L359) +Defined in: [features/column-visibility/columnVisibilityFeature.utils.ts:360](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/columnVisibilityFeature.utils.ts#L360) Checks whether every leaf column is currently visible. diff --git a/docs/reference/static-functions/functions/table_getIsAllPageRowsSelected.md b/docs/reference/static-functions/functions/table_getIsAllPageRowsSelected.md index 6e4fb94c5c..3938c10c39 100644 --- a/docs/reference/static-functions/functions/table_getIsAllPageRowsSelected.md +++ b/docs/reference/static-functions/functions/table_getIsAllPageRowsSelected.md @@ -9,7 +9,7 @@ title: table_getIsAllPageRowsSelected function table_getIsAllPageRowsSelected(table): boolean; ``` -Defined in: [features/row-selection/rowSelectionFeature.utils.ts:395](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/rowSelectionFeature.utils.ts#L395) +Defined in: [features/row-selection/rowSelectionFeature.utils.ts:398](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/rowSelectionFeature.utils.ts#L398) Checks whether every selectable row on the current page is selected. diff --git a/docs/reference/static-functions/functions/table_getIsAllRowsExpanded.md b/docs/reference/static-functions/functions/table_getIsAllRowsExpanded.md index a0b395cf8d..1a7fb4a46c 100644 --- a/docs/reference/static-functions/functions/table_getIsAllRowsExpanded.md +++ b/docs/reference/static-functions/functions/table_getIsAllRowsExpanded.md @@ -9,7 +9,7 @@ title: table_getIsAllRowsExpanded function table_getIsAllRowsExpanded(table): boolean; ``` -Defined in: [features/row-expanding/rowExpandingFeature.utils.ts:202](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-expanding/rowExpandingFeature.utils.ts#L202) +Defined in: [features/row-expanding/rowExpandingFeature.utils.ts:207](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-expanding/rowExpandingFeature.utils.ts#L207) Checks whether every expandable row in the current row model is expanded. diff --git a/docs/reference/static-functions/functions/table_getIsAllRowsSelected.md b/docs/reference/static-functions/functions/table_getIsAllRowsSelected.md index 849812a28b..696a29518f 100644 --- a/docs/reference/static-functions/functions/table_getIsAllRowsSelected.md +++ b/docs/reference/static-functions/functions/table_getIsAllRowsSelected.md @@ -9,7 +9,7 @@ title: table_getIsAllRowsSelected function table_getIsAllRowsSelected(table): boolean; ``` -Defined in: [features/row-selection/rowSelectionFeature.utils.ts:355](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/rowSelectionFeature.utils.ts#L355) +Defined in: [features/row-selection/rowSelectionFeature.utils.ts:358](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/rowSelectionFeature.utils.ts#L358) Checks whether every selectable filtered row is selected. diff --git a/docs/reference/static-functions/functions/table_getIsSomeColumnsVisible.md b/docs/reference/static-functions/functions/table_getIsSomeColumnsVisible.md index d163cd2cc6..4133f8338b 100644 --- a/docs/reference/static-functions/functions/table_getIsSomeColumnsVisible.md +++ b/docs/reference/static-functions/functions/table_getIsSomeColumnsVisible.md @@ -9,7 +9,7 @@ title: table_getIsSomeColumnsVisible function table_getIsSomeColumnsVisible(table): boolean; ``` -Defined in: [features/column-visibility/columnVisibilityFeature.utils.ts:381](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/columnVisibilityFeature.utils.ts#L381) +Defined in: [features/column-visibility/columnVisibilityFeature.utils.ts:382](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/columnVisibilityFeature.utils.ts#L382) Checks whether at least one leaf column is currently visible. diff --git a/docs/reference/static-functions/functions/table_getIsSomePageRowsSelected.md b/docs/reference/static-functions/functions/table_getIsSomePageRowsSelected.md index d3511c2f46..4e2a9e999c 100644 --- a/docs/reference/static-functions/functions/table_getIsSomePageRowsSelected.md +++ b/docs/reference/static-functions/functions/table_getIsSomePageRowsSelected.md @@ -9,7 +9,7 @@ title: table_getIsSomePageRowsSelected function table_getIsSomePageRowsSelected(table): boolean; ``` -Defined in: [features/row-selection/rowSelectionFeature.utils.ts:452](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/rowSelectionFeature.utils.ts#L452) +Defined in: [features/row-selection/rowSelectionFeature.utils.ts:455](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/rowSelectionFeature.utils.ts#L455) Checks whether at least one selectable row on the current page is selected. diff --git a/docs/reference/static-functions/functions/table_getIsSomeRowsExpanded.md b/docs/reference/static-functions/functions/table_getIsSomeRowsExpanded.md index a65d9d6348..a974e7e31e 100644 --- a/docs/reference/static-functions/functions/table_getIsSomeRowsExpanded.md +++ b/docs/reference/static-functions/functions/table_getIsSomeRowsExpanded.md @@ -9,7 +9,7 @@ title: table_getIsSomeRowsExpanded function table_getIsSomeRowsExpanded(table): boolean; ``` -Defined in: [features/row-expanding/rowExpandingFeature.utils.ts:181](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-expanding/rowExpandingFeature.utils.ts#L181) +Defined in: [features/row-expanding/rowExpandingFeature.utils.ts:186](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-expanding/rowExpandingFeature.utils.ts#L186) Checks whether any row is expanded. diff --git a/docs/reference/static-functions/functions/table_getIsSomeRowsSelected.md b/docs/reference/static-functions/functions/table_getIsSomeRowsSelected.md index bfcdcdd6e1..39f64dfc67 100644 --- a/docs/reference/static-functions/functions/table_getIsSomeRowsSelected.md +++ b/docs/reference/static-functions/functions/table_getIsSomeRowsSelected.md @@ -9,7 +9,7 @@ title: table_getIsSomeRowsSelected function table_getIsSomeRowsSelected(table): boolean; ``` -Defined in: [features/row-selection/rowSelectionFeature.utils.ts:434](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/rowSelectionFeature.utils.ts#L434) +Defined in: [features/row-selection/rowSelectionFeature.utils.ts:437](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/rowSelectionFeature.utils.ts#L437) Checks whether at least one row id is selected. diff --git a/docs/reference/static-functions/functions/table_getOrderColumnsFn.md b/docs/reference/static-functions/functions/table_getOrderColumnsFn.md index 228ff7143b..3a32300509 100644 --- a/docs/reference/static-functions/functions/table_getOrderColumnsFn.md +++ b/docs/reference/static-functions/functions/table_getOrderColumnsFn.md @@ -9,7 +9,7 @@ title: table_getOrderColumnsFn function table_getOrderColumnsFn(table): (columns) => Column_Internal[]; ``` -Defined in: [features/column-ordering/columnOrderingFeature.utils.ts:195](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-ordering/columnOrderingFeature.utils.ts#L195) +Defined in: [features/column-ordering/columnOrderingFeature.utils.ts:200](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-ordering/columnOrderingFeature.utils.ts#L200) Creates the ordering function used to arrange leaf columns. diff --git a/docs/reference/static-functions/functions/table_getPageCount.md b/docs/reference/static-functions/functions/table_getPageCount.md index 196234b098..eb8ed3133b 100644 --- a/docs/reference/static-functions/functions/table_getPageCount.md +++ b/docs/reference/static-functions/functions/table_getPageCount.md @@ -9,7 +9,7 @@ title: table_getPageCount function table_getPageCount(table): number; ``` -Defined in: [features/row-pagination/rowPaginationFeature.utils.ts:402](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pagination/rowPaginationFeature.utils.ts#L402) +Defined in: [features/row-pagination/rowPaginationFeature.utils.ts:401](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pagination/rowPaginationFeature.utils.ts#L401) Resolves the number of pages for the current pagination state. diff --git a/docs/reference/static-functions/functions/table_getPageOptions.md b/docs/reference/static-functions/functions/table_getPageOptions.md index ac5ff1e720..bb306b1672 100644 --- a/docs/reference/static-functions/functions/table_getPageOptions.md +++ b/docs/reference/static-functions/functions/table_getPageOptions.md @@ -9,7 +9,7 @@ title: table_getPageOptions function table_getPageOptions(table): number[]; ``` -Defined in: [features/row-pagination/rowPaginationFeature.utils.ts:229](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pagination/rowPaginationFeature.utils.ts#L229) +Defined in: [features/row-pagination/rowPaginationFeature.utils.ts:228](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pagination/rowPaginationFeature.utils.ts#L228) Builds the zero-based page indexes available for the current page count. diff --git a/docs/reference/static-functions/functions/table_getPreSelectedRowModel.md b/docs/reference/static-functions/functions/table_getPreSelectedRowModel.md index 0a8cfd53f6..cfd00db2e0 100644 --- a/docs/reference/static-functions/functions/table_getPreSelectedRowModel.md +++ b/docs/reference/static-functions/functions/table_getPreSelectedRowModel.md @@ -9,7 +9,7 @@ title: table_getPreSelectedRowModel function table_getPreSelectedRowModel(table): RowModel; ``` -Defined in: [features/row-selection/rowSelectionFeature.utils.ts:217](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/rowSelectionFeature.utils.ts#L217) +Defined in: [features/row-selection/rowSelectionFeature.utils.ts:220](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/rowSelectionFeature.utils.ts#L220) Reads the row model before row selection is projected into selected rows. diff --git a/docs/reference/static-functions/functions/table_getRowCount.md b/docs/reference/static-functions/functions/table_getRowCount.md index 7df9644bc8..563176719a 100644 --- a/docs/reference/static-functions/functions/table_getRowCount.md +++ b/docs/reference/static-functions/functions/table_getRowCount.md @@ -9,7 +9,7 @@ title: table_getRowCount function table_getRowCount(table): number; ``` -Defined in: [features/row-pagination/rowPaginationFeature.utils.ts:433](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pagination/rowPaginationFeature.utils.ts#L433) +Defined in: [features/row-pagination/rowPaginationFeature.utils.ts:432](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pagination/rowPaginationFeature.utils.ts#L432) Resolves the total row count used for pagination math. diff --git a/docs/reference/static-functions/functions/table_getSelectedCellCount.md b/docs/reference/static-functions/functions/table_getSelectedCellCount.md index 900be23ede..5789631727 100644 --- a/docs/reference/static-functions/functions/table_getSelectedCellCount.md +++ b/docs/reference/static-functions/functions/table_getSelectedCellCount.md @@ -9,7 +9,7 @@ title: table_getSelectedCellCount function table_getSelectedCellCount(table): number; ``` -Defined in: [features/cell-selection/cellSelectionFeature.utils.ts:1256](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/cell-selection/cellSelectionFeature.utils.ts#L1256) +Defined in: [features/cell-selection/cellSelectionFeature.utils.ts:1264](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/cell-selection/cellSelectionFeature.utils.ts#L1264) Returns the number of selected cells. diff --git a/docs/reference/static-functions/functions/table_getSelectedCellIds.md b/docs/reference/static-functions/functions/table_getSelectedCellIds.md index db50cdbf8c..43ad284022 100644 --- a/docs/reference/static-functions/functions/table_getSelectedCellIds.md +++ b/docs/reference/static-functions/functions/table_getSelectedCellIds.md @@ -9,7 +9,7 @@ title: table_getSelectedCellIds function table_getSelectedCellIds(table): string[]; ``` -Defined in: [features/cell-selection/cellSelectionFeature.utils.ts:1198](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/cell-selection/cellSelectionFeature.utils.ts#L1198) +Defined in: [features/cell-selection/cellSelectionFeature.utils.ts:1206](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/cell-selection/cellSelectionFeature.utils.ts#L1206) Returns the ids of all selected cells, in row-major order. diff --git a/docs/reference/static-functions/functions/table_getSelectedCellRangesData.md b/docs/reference/static-functions/functions/table_getSelectedCellRangesData.md index 41dc492c72..40d97808d9 100644 --- a/docs/reference/static-functions/functions/table_getSelectedCellRangesData.md +++ b/docs/reference/static-functions/functions/table_getSelectedCellRangesData.md @@ -9,7 +9,7 @@ title: table_getSelectedCellRangesData function table_getSelectedCellRangesData(table): unknown[][][]; ``` -Defined in: [features/cell-selection/cellSelectionFeature.utils.ts:1230](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/cell-selection/cellSelectionFeature.utils.ts#L1230) +Defined in: [features/cell-selection/cellSelectionFeature.utils.ts:1238](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/cell-selection/cellSelectionFeature.utils.ts#L1238) Returns each final positive region's values as a row-major grid. diff --git a/docs/reference/static-functions/functions/table_getSelectedRowIds.md b/docs/reference/static-functions/functions/table_getSelectedRowIds.md index d916fb8e22..bea43bc0c6 100644 --- a/docs/reference/static-functions/functions/table_getSelectedRowIds.md +++ b/docs/reference/static-functions/functions/table_getSelectedRowIds.md @@ -9,7 +9,7 @@ title: table_getSelectedRowIds function table_getSelectedRowIds(table): string[]; ``` -Defined in: [features/row-selection/rowSelectionFeature.utils.ts:336](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/rowSelectionFeature.utils.ts#L336) +Defined in: [features/row-selection/rowSelectionFeature.utils.ts:339](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/rowSelectionFeature.utils.ts#L339) Returns the ids of all selected rows. diff --git a/docs/reference/static-functions/functions/table_getSelectedRowModel.md b/docs/reference/static-functions/functions/table_getSelectedRowModel.md index 6e3089ca55..6f3beeb411 100644 --- a/docs/reference/static-functions/functions/table_getSelectedRowModel.md +++ b/docs/reference/static-functions/functions/table_getSelectedRowModel.md @@ -15,7 +15,7 @@ function table_getSelectedRowModel(table): }; ``` -Defined in: [features/row-selection/rowSelectionFeature.utils.ts:235](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/rowSelectionFeature.utils.ts#L235) +Defined in: [features/row-selection/rowSelectionFeature.utils.ts:238](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/rowSelectionFeature.utils.ts#L238) Builds a row model containing selected rows from the core row model. diff --git a/docs/reference/static-functions/functions/table_getStartTotalSize.md b/docs/reference/static-functions/functions/table_getStartTotalSize.md index ade24cf29b..14deaae226 100644 --- a/docs/reference/static-functions/functions/table_getStartTotalSize.md +++ b/docs/reference/static-functions/functions/table_getStartTotalSize.md @@ -9,7 +9,7 @@ title: table_getStartTotalSize function table_getStartTotalSize(table): number; ``` -Defined in: [features/column-sizing/columnSizingFeature.utils.ts:403](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-sizing/columnSizingFeature.utils.ts#L403) +Defined in: [features/column-sizing/columnSizingFeature.utils.ts:405](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-sizing/columnSizingFeature.utils.ts#L405) Sums the rendered size of the logical start pinned header region. diff --git a/docs/reference/static-functions/functions/table_getToggleAllColumnsVisibilityHandler.md b/docs/reference/static-functions/functions/table_getToggleAllColumnsVisibilityHandler.md index faa80e467d..143e06a1dd 100644 --- a/docs/reference/static-functions/functions/table_getToggleAllColumnsVisibilityHandler.md +++ b/docs/reference/static-functions/functions/table_getToggleAllColumnsVisibilityHandler.md @@ -9,7 +9,7 @@ title: table_getToggleAllColumnsVisibilityHandler function table_getToggleAllColumnsVisibilityHandler(table): (e) => void; ``` -Defined in: [features/column-visibility/columnVisibilityFeature.utils.ts:403](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/columnVisibilityFeature.utils.ts#L403) +Defined in: [features/column-visibility/columnVisibilityFeature.utils.ts:404](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/columnVisibilityFeature.utils.ts#L404) Creates a checkbox-style handler that shows or hides all columns. diff --git a/docs/reference/static-functions/functions/table_getToggleAllPageRowsSelectedHandler.md b/docs/reference/static-functions/functions/table_getToggleAllPageRowsSelectedHandler.md index 3c6c85b090..33ecb89763 100644 --- a/docs/reference/static-functions/functions/table_getToggleAllPageRowsSelectedHandler.md +++ b/docs/reference/static-functions/functions/table_getToggleAllPageRowsSelectedHandler.md @@ -9,7 +9,7 @@ title: table_getToggleAllPageRowsSelectedHandler function table_getToggleAllPageRowsSelectedHandler(table): (e) => void; ``` -Defined in: [features/row-selection/rowSelectionFeature.utils.ts:500](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/rowSelectionFeature.utils.ts#L500) +Defined in: [features/row-selection/rowSelectionFeature.utils.ts:503](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/rowSelectionFeature.utils.ts#L503) Creates a checkbox-style handler that selects or deselects current page rows. diff --git a/docs/reference/static-functions/functions/table_getToggleAllRowsExpandedHandler.md b/docs/reference/static-functions/functions/table_getToggleAllRowsExpandedHandler.md index 0d25c3b2b2..e0899d6665 100644 --- a/docs/reference/static-functions/functions/table_getToggleAllRowsExpandedHandler.md +++ b/docs/reference/static-functions/functions/table_getToggleAllRowsExpandedHandler.md @@ -9,7 +9,7 @@ title: table_getToggleAllRowsExpandedHandler function table_getToggleAllRowsExpandedHandler(table): (_e) => void; ``` -Defined in: [features/row-expanding/rowExpandingFeature.utils.ts:162](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-expanding/rowExpandingFeature.utils.ts#L162) +Defined in: [features/row-expanding/rowExpandingFeature.utils.ts:167](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-expanding/rowExpandingFeature.utils.ts#L167) Creates an event handler that toggles all rows expanded. diff --git a/docs/reference/static-functions/functions/table_getToggleAllRowsSelectedHandler.md b/docs/reference/static-functions/functions/table_getToggleAllRowsSelectedHandler.md index d1528b7fef..7cdae01bb8 100644 --- a/docs/reference/static-functions/functions/table_getToggleAllRowsSelectedHandler.md +++ b/docs/reference/static-functions/functions/table_getToggleAllRowsSelectedHandler.md @@ -9,7 +9,7 @@ title: table_getToggleAllRowsSelectedHandler function table_getToggleAllRowsSelectedHandler(table): (e) => void; ``` -Defined in: [features/row-selection/rowSelectionFeature.utils.ts:477](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/rowSelectionFeature.utils.ts#L477) +Defined in: [features/row-selection/rowSelectionFeature.utils.ts:480](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/rowSelectionFeature.utils.ts#L480) Creates a checkbox-style handler that selects or deselects all rows. diff --git a/docs/reference/static-functions/functions/table_getTotalSize.md b/docs/reference/static-functions/functions/table_getTotalSize.md index d85f2ee5ee..d5b94aff37 100644 --- a/docs/reference/static-functions/functions/table_getTotalSize.md +++ b/docs/reference/static-functions/functions/table_getTotalSize.md @@ -9,7 +9,7 @@ title: table_getTotalSize function table_getTotalSize(table): number; ``` -Defined in: [features/column-sizing/columnSizingFeature.utils.ts:382](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-sizing/columnSizingFeature.utils.ts#L382) +Defined in: [features/column-sizing/columnSizingFeature.utils.ts:384](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-sizing/columnSizingFeature.utils.ts#L384) Sums the rendered size of the full table header row. diff --git a/docs/reference/static-functions/functions/table_getVisibleFlatColumns.md b/docs/reference/static-functions/functions/table_getVisibleFlatColumns.md index 5d472e6591..e599ea6543 100644 --- a/docs/reference/static-functions/functions/table_getVisibleFlatColumns.md +++ b/docs/reference/static-functions/functions/table_getVisibleFlatColumns.md @@ -9,7 +9,7 @@ title: table_getVisibleFlatColumns function table_getVisibleFlatColumns(table): Column[]; ``` -Defined in: [features/column-visibility/columnVisibilityFeature.utils.ts:241](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/columnVisibilityFeature.utils.ts#L241) +Defined in: [features/column-visibility/columnVisibilityFeature.utils.ts:242](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/columnVisibilityFeature.utils.ts#L242) Filters the flat column list down to visible columns. diff --git a/docs/reference/static-functions/functions/table_getVisibleLeafColumns.md b/docs/reference/static-functions/functions/table_getVisibleLeafColumns.md index 6b0512bbb9..f107739dad 100644 --- a/docs/reference/static-functions/functions/table_getVisibleLeafColumns.md +++ b/docs/reference/static-functions/functions/table_getVisibleLeafColumns.md @@ -9,7 +9,7 @@ title: table_getVisibleLeafColumns function table_getVisibleLeafColumns(table): Column[]; ``` -Defined in: [features/column-visibility/columnVisibilityFeature.utils.ts:263](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/columnVisibilityFeature.utils.ts#L263) +Defined in: [features/column-visibility/columnVisibilityFeature.utils.ts:264](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/columnVisibilityFeature.utils.ts#L264) Filters leaf columns down to those currently visible. diff --git a/docs/reference/static-functions/functions/table_lastPage.md b/docs/reference/static-functions/functions/table_lastPage.md index 51fd61f96d..bca8d84d82 100644 --- a/docs/reference/static-functions/functions/table_lastPage.md +++ b/docs/reference/static-functions/functions/table_lastPage.md @@ -9,7 +9,7 @@ title: table_lastPage function table_lastPage(table): void; ``` -Defined in: [features/row-pagination/rowPaginationFeature.utils.ts:378](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pagination/rowPaginationFeature.utils.ts#L378) +Defined in: [features/row-pagination/rowPaginationFeature.utils.ts:377](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pagination/rowPaginationFeature.utils.ts#L377) Moves the table to the last known page. diff --git a/docs/reference/static-functions/functions/table_moveCellSelection.md b/docs/reference/static-functions/functions/table_moveCellSelection.md index fa84dbbfc5..8331ec2a45 100644 --- a/docs/reference/static-functions/functions/table_moveCellSelection.md +++ b/docs/reference/static-functions/functions/table_moveCellSelection.md @@ -9,7 +9,7 @@ title: table_moveCellSelection function table_moveCellSelection(table, direction): void; ``` -Defined in: [features/cell-selection/cellSelectionFeature.utils.ts:1031](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/cell-selection/cellSelectionFeature.utils.ts#L1031) +Defined in: [features/cell-selection/cellSelectionFeature.utils.ts:1039](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/cell-selection/cellSelectionFeature.utils.ts#L1039) Moves the selection one step in a direction, collapsing it to a single cell. diff --git a/docs/reference/static-functions/functions/table_nextPage.md b/docs/reference/static-functions/functions/table_nextPage.md index 59d4339a63..af59de29c5 100644 --- a/docs/reference/static-functions/functions/table_nextPage.md +++ b/docs/reference/static-functions/functions/table_nextPage.md @@ -9,7 +9,7 @@ title: table_nextPage function table_nextPage(table): void; ``` -Defined in: [features/row-pagination/rowPaginationFeature.utils.ts:341](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pagination/rowPaginationFeature.utils.ts#L341) +Defined in: [features/row-pagination/rowPaginationFeature.utils.ts:340](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pagination/rowPaginationFeature.utils.ts#L340) Moves the table to the next page. diff --git a/docs/reference/static-functions/functions/table_previousPage.md b/docs/reference/static-functions/functions/table_previousPage.md index de8f7e4613..c7b8d0c6ec 100644 --- a/docs/reference/static-functions/functions/table_previousPage.md +++ b/docs/reference/static-functions/functions/table_previousPage.md @@ -9,7 +9,7 @@ title: table_previousPage function table_previousPage(table): void; ``` -Defined in: [features/row-pagination/rowPaginationFeature.utils.ts:323](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pagination/rowPaginationFeature.utils.ts#L323) +Defined in: [features/row-pagination/rowPaginationFeature.utils.ts:322](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pagination/rowPaginationFeature.utils.ts#L322) Moves the table to the previous page. diff --git a/docs/reference/static-functions/functions/table_resetCellSelection.md b/docs/reference/static-functions/functions/table_resetCellSelection.md index 890038e2e2..f2e4ea1886 100644 --- a/docs/reference/static-functions/functions/table_resetCellSelection.md +++ b/docs/reference/static-functions/functions/table_resetCellSelection.md @@ -9,7 +9,7 @@ title: table_resetCellSelection function table_resetCellSelection(table, defaultState?): void; ``` -Defined in: [features/cell-selection/cellSelectionFeature.utils.ts:70](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/cell-selection/cellSelectionFeature.utils.ts#L70) +Defined in: [features/cell-selection/cellSelectionFeature.utils.ts:77](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/cell-selection/cellSelectionFeature.utils.ts#L77) Resets `cellSelection` to the configured initial state or feature default. diff --git a/docs/reference/static-functions/functions/table_resetColumnFilters.md b/docs/reference/static-functions/functions/table_resetColumnFilters.md index e4afcadfda..f0c594b0e7 100644 --- a/docs/reference/static-functions/functions/table_resetColumnFilters.md +++ b/docs/reference/static-functions/functions/table_resetColumnFilters.md @@ -9,7 +9,7 @@ title: table_resetColumnFilters function table_resetColumnFilters(table, defaultState?): void; ``` -Defined in: [features/column-filtering/columnFilteringFeature.utils.ts:318](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-filtering/columnFilteringFeature.utils.ts#L318) +Defined in: [features/column-filtering/columnFilteringFeature.utils.ts:323](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-filtering/columnFilteringFeature.utils.ts#L323) Resets `columnFilters` to the configured initial state or feature default. diff --git a/docs/reference/static-functions/functions/table_resetColumnOrder.md b/docs/reference/static-functions/functions/table_resetColumnOrder.md index c80a9f31a2..eaf2ff55c6 100644 --- a/docs/reference/static-functions/functions/table_resetColumnOrder.md +++ b/docs/reference/static-functions/functions/table_resetColumnOrder.md @@ -9,7 +9,7 @@ title: table_resetColumnOrder function table_resetColumnOrder(table, defaultState?): void; ``` -Defined in: [features/column-ordering/columnOrderingFeature.utils.ts:174](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-ordering/columnOrderingFeature.utils.ts#L174) +Defined in: [features/column-ordering/columnOrderingFeature.utils.ts:179](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-ordering/columnOrderingFeature.utils.ts#L179) Resets `columnOrder` to the configured initial state or feature default. diff --git a/docs/reference/static-functions/functions/table_resetColumnSizing.md b/docs/reference/static-functions/functions/table_resetColumnSizing.md index af979c7427..46bb78160d 100644 --- a/docs/reference/static-functions/functions/table_resetColumnSizing.md +++ b/docs/reference/static-functions/functions/table_resetColumnSizing.md @@ -9,7 +9,7 @@ title: table_resetColumnSizing function table_resetColumnSizing(table, defaultState?): void; ``` -Defined in: [features/column-sizing/columnSizingFeature.utils.ts:357](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-sizing/columnSizingFeature.utils.ts#L357) +Defined in: [features/column-sizing/columnSizingFeature.utils.ts:359](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-sizing/columnSizingFeature.utils.ts#L359) Resets `columnSizing` to the configured initial state or feature default. diff --git a/docs/reference/static-functions/functions/table_resetColumnVisibility.md b/docs/reference/static-functions/functions/table_resetColumnVisibility.md index ec3bc8407d..2f2552b610 100644 --- a/docs/reference/static-functions/functions/table_resetColumnVisibility.md +++ b/docs/reference/static-functions/functions/table_resetColumnVisibility.md @@ -9,7 +9,7 @@ title: table_resetColumnVisibility function table_resetColumnVisibility(table, defaultState?): void; ``` -Defined in: [features/column-visibility/columnVisibilityFeature.utils.ts:307](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/columnVisibilityFeature.utils.ts#L307) +Defined in: [features/column-visibility/columnVisibilityFeature.utils.ts:308](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/columnVisibilityFeature.utils.ts#L308) Resets `columnVisibility` to the configured initial state or feature default. diff --git a/docs/reference/static-functions/functions/table_resetExpanded.md b/docs/reference/static-functions/functions/table_resetExpanded.md index f90d997ebc..3779fc1a01 100644 --- a/docs/reference/static-functions/functions/table_resetExpanded.md +++ b/docs/reference/static-functions/functions/table_resetExpanded.md @@ -9,7 +9,7 @@ title: table_resetExpanded function table_resetExpanded(table, defaultState?): void; ``` -Defined in: [features/row-expanding/rowExpandingFeature.utils.ts:116](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-expanding/rowExpandingFeature.utils.ts#L116) +Defined in: [features/row-expanding/rowExpandingFeature.utils.ts:120](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-expanding/rowExpandingFeature.utils.ts#L120) Resets `expanded` to the configured initial state or feature default. diff --git a/docs/reference/static-functions/functions/table_resetGlobalFilter.md b/docs/reference/static-functions/functions/table_resetGlobalFilter.md index 5f68207659..25f5e61e64 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:118](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/global-filtering/globalFilteringFeature.utils.ts#L118) +Defined in: [features/global-filtering/globalFilteringFeature.utils.ts:120](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/global-filtering/globalFilteringFeature.utils.ts#L120) Resets `globalFilter` 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 255bfde9bf..8a43c25531 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:368](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-resizing/columnResizingFeature.utils.ts#L368) +Defined in: [features/column-resizing/columnResizingFeature.utils.ts:371](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-resizing/columnResizingFeature.utils.ts#L371) Resets `columnResizing` to the configured initial state or feature default. diff --git a/docs/reference/static-functions/functions/table_resetPageIndex.md b/docs/reference/static-functions/functions/table_resetPageIndex.md index 11a84d2eff..ebbd23e061 100644 --- a/docs/reference/static-functions/functions/table_resetPageIndex.md +++ b/docs/reference/static-functions/functions/table_resetPageIndex.md @@ -9,7 +9,7 @@ title: table_resetPageIndex function table_resetPageIndex(table, defaultState?): void; ``` -Defined in: [features/row-pagination/rowPaginationFeature.utils.ts:150](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pagination/rowPaginationFeature.utils.ts#L150) +Defined in: [features/row-pagination/rowPaginationFeature.utils.ts:151](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pagination/rowPaginationFeature.utils.ts#L151) Resets only `pagination.pageIndex`. diff --git a/docs/reference/static-functions/functions/table_resetPagination.md b/docs/reference/static-functions/functions/table_resetPagination.md index f6b1977a2a..73871e8792 100644 --- a/docs/reference/static-functions/functions/table_resetPagination.md +++ b/docs/reference/static-functions/functions/table_resetPagination.md @@ -9,7 +9,7 @@ title: table_resetPagination function table_resetPagination(table, defaultState?): void; ``` -Defined in: [features/row-pagination/rowPaginationFeature.utils.ts:91](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pagination/rowPaginationFeature.utils.ts#L91) +Defined in: [features/row-pagination/rowPaginationFeature.utils.ts:92](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pagination/rowPaginationFeature.utils.ts#L92) Resets `pagination` to the configured initial state or feature default. diff --git a/docs/reference/static-functions/functions/table_resetRowSelection.md b/docs/reference/static-functions/functions/table_resetRowSelection.md index 51e0b9ced9..a044f3ea02 100644 --- a/docs/reference/static-functions/functions/table_resetRowSelection.md +++ b/docs/reference/static-functions/functions/table_resetRowSelection.md @@ -9,7 +9,7 @@ title: table_resetRowSelection function table_resetRowSelection(table, defaultState?): void; ``` -Defined in: [features/row-selection/rowSelectionFeature.utils.ts:68](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/rowSelectionFeature.utils.ts#L68) +Defined in: [features/row-selection/rowSelectionFeature.utils.ts:71](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/rowSelectionFeature.utils.ts#L71) Resets `rowSelection` to the configured initial state or feature default. diff --git a/docs/reference/static-functions/functions/table_resetSorting.md b/docs/reference/static-functions/functions/table_resetSorting.md index 20937d8142..b65a5d72a4 100644 --- a/docs/reference/static-functions/functions/table_resetSorting.md +++ b/docs/reference/static-functions/functions/table_resetSorting.md @@ -9,7 +9,7 @@ title: table_resetSorting function table_resetSorting(table, defaultState?): void; ``` -Defined in: [features/row-sorting/rowSortingFeature.utils.ts:60](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/rowSortingFeature.utils.ts#L60) +Defined in: [features/row-sorting/rowSortingFeature.utils.ts:62](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/rowSortingFeature.utils.ts#L62) Resets `sorting` to the configured initial state or feature default. diff --git a/docs/reference/static-functions/functions/table_selectAllCells.md b/docs/reference/static-functions/functions/table_selectAllCells.md index 06b1baae14..c20083e9ea 100644 --- a/docs/reference/static-functions/functions/table_selectAllCells.md +++ b/docs/reference/static-functions/functions/table_selectAllCells.md @@ -9,7 +9,7 @@ title: table_selectAllCells function table_selectAllCells(table): void; ``` -Defined in: [features/cell-selection/cellSelectionFeature.utils.ts:850](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/cell-selection/cellSelectionFeature.utils.ts#L850) +Defined in: [features/cell-selection/cellSelectionFeature.utils.ts:858](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/cell-selection/cellSelectionFeature.utils.ts#L858) Selects every selectable cell in the table as one range. diff --git a/docs/reference/static-functions/functions/table_selectCellRange.md b/docs/reference/static-functions/functions/table_selectCellRange.md index 78b7e77aca..a9031c466f 100644 --- a/docs/reference/static-functions/functions/table_selectCellRange.md +++ b/docs/reference/static-functions/functions/table_selectCellRange.md @@ -12,7 +12,7 @@ function table_selectCellRange( opts?): void; ``` -Defined in: [features/cell-selection/cellSelectionFeature.utils.ts:800](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/cell-selection/cellSelectionFeature.utils.ts#L800) +Defined in: [features/cell-selection/cellSelectionFeature.utils.ts:808](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/cell-selection/cellSelectionFeature.utils.ts#L808) Selects a rectangle using replace, include, or exclude semantics. diff --git a/docs/reference/static-functions/functions/table_setCellSelection.md b/docs/reference/static-functions/functions/table_setCellSelection.md index de94da89e0..d598219c4c 100644 --- a/docs/reference/static-functions/functions/table_setCellSelection.md +++ b/docs/reference/static-functions/functions/table_setCellSelection.md @@ -9,7 +9,7 @@ title: table_setCellSelection function table_setCellSelection(table, updater): void; ``` -Defined in: [features/cell-selection/cellSelectionFeature.utils.ts:49](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/cell-selection/cellSelectionFeature.utils.ts#L49) +Defined in: [features/cell-selection/cellSelectionFeature.utils.ts:54](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/cell-selection/cellSelectionFeature.utils.ts#L54) Routes a cell selection updater through the table's selection change handler. diff --git a/docs/reference/static-functions/functions/table_setColumnFilters.md b/docs/reference/static-functions/functions/table_setColumnFilters.md index f5f79a51a0..81701df195 100644 --- a/docs/reference/static-functions/functions/table_setColumnFilters.md +++ b/docs/reference/static-functions/functions/table_setColumnFilters.md @@ -9,7 +9,7 @@ title: table_setColumnFilters function table_setColumnFilters(table, updater): void; ``` -Defined in: [features/column-filtering/columnFilteringFeature.utils.ts:278](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-filtering/columnFilteringFeature.utils.ts#L278) +Defined in: [features/column-filtering/columnFilteringFeature.utils.ts:283](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-filtering/columnFilteringFeature.utils.ts#L283) Routes a column filter updater through the table's filter change handler. diff --git a/docs/reference/static-functions/functions/table_setColumnOrder.md b/docs/reference/static-functions/functions/table_setColumnOrder.md index 7c02b0dd4c..a140999f27 100644 --- a/docs/reference/static-functions/functions/table_setColumnOrder.md +++ b/docs/reference/static-functions/functions/table_setColumnOrder.md @@ -9,7 +9,7 @@ title: table_setColumnOrder function table_setColumnOrder(table, updater): void; ``` -Defined in: [features/column-ordering/columnOrderingFeature.utils.ts:155](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-ordering/columnOrderingFeature.utils.ts#L155) +Defined in: [features/column-ordering/columnOrderingFeature.utils.ts:160](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-ordering/columnOrderingFeature.utils.ts#L160) Routes a column order updater through the table's column-order change handler. diff --git a/docs/reference/static-functions/functions/table_setColumnVisibility.md b/docs/reference/static-functions/functions/table_setColumnVisibility.md index 45507af8c2..32183e02a3 100644 --- a/docs/reference/static-functions/functions/table_setColumnVisibility.md +++ b/docs/reference/static-functions/functions/table_setColumnVisibility.md @@ -9,7 +9,7 @@ title: table_setColumnVisibility function table_setColumnVisibility(table, updater): void; ``` -Defined in: [features/column-visibility/columnVisibilityFeature.utils.ts:285](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/columnVisibilityFeature.utils.ts#L285) +Defined in: [features/column-visibility/columnVisibilityFeature.utils.ts:286](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/columnVisibilityFeature.utils.ts#L286) Routes a column visibility updater through the table's visibility change handler. diff --git a/docs/reference/static-functions/functions/table_setFocusedCell.md b/docs/reference/static-functions/functions/table_setFocusedCell.md index 5bcf51a56e..1fe5d08e7f 100644 --- a/docs/reference/static-functions/functions/table_setFocusedCell.md +++ b/docs/reference/static-functions/functions/table_setFocusedCell.md @@ -12,7 +12,7 @@ function table_setFocusedCell( columnId): void; ``` -Defined in: [features/cell-selection/cellSelectionFeature.utils.ts:778](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/cell-selection/cellSelectionFeature.utils.ts#L778) +Defined in: [features/cell-selection/cellSelectionFeature.utils.ts:786](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/cell-selection/cellSelectionFeature.utils.ts#L786) Collapses the selection to a single cell at the given coordinates. diff --git a/docs/reference/static-functions/functions/table_setPageIndex.md b/docs/reference/static-functions/functions/table_setPageIndex.md index 1630ac2aba..239f083c3e 100644 --- a/docs/reference/static-functions/functions/table_setPageIndex.md +++ b/docs/reference/static-functions/functions/table_setPageIndex.md @@ -9,7 +9,7 @@ title: table_setPageIndex function table_setPageIndex(table, updater): void; ``` -Defined in: [features/row-pagination/rowPaginationFeature.utils.ts:116](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pagination/rowPaginationFeature.utils.ts#L116) +Defined in: [features/row-pagination/rowPaginationFeature.utils.ts:117](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pagination/rowPaginationFeature.utils.ts#L117) Updates `pagination.pageIndex` and clamps it to the known page range. diff --git a/docs/reference/static-functions/functions/table_setPageSize.md b/docs/reference/static-functions/functions/table_setPageSize.md index a9cf0cbebe..fa5759d4ce 100644 --- a/docs/reference/static-functions/functions/table_setPageSize.md +++ b/docs/reference/static-functions/functions/table_setPageSize.md @@ -9,7 +9,7 @@ title: table_setPageSize function table_setPageSize(table, updater): void; ``` -Defined in: [features/row-pagination/rowPaginationFeature.utils.ts:199](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pagination/rowPaginationFeature.utils.ts#L199) +Defined in: [features/row-pagination/rowPaginationFeature.utils.ts:198](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pagination/rowPaginationFeature.utils.ts#L198) Updates `pagination.pageSize` while preserving the current top row. diff --git a/docs/reference/static-functions/functions/table_setPagination.md b/docs/reference/static-functions/functions/table_setPagination.md index 5a4a81a20a..5de3988946 100644 --- a/docs/reference/static-functions/functions/table_setPagination.md +++ b/docs/reference/static-functions/functions/table_setPagination.md @@ -6,10 +6,10 @@ title: table_setPagination # Function: table\_setPagination() ```ts -function table_setPagination(table, updater): void | undefined; +function table_setPagination(table, updater): void; ``` -Defined in: [features/row-pagination/rowPaginationFeature.utils.ts:65](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pagination/rowPaginationFeature.utils.ts#L65) +Defined in: [features/row-pagination/rowPaginationFeature.utils.ts:72](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pagination/rowPaginationFeature.utils.ts#L72) Routes a pagination updater through the table's pagination change handler. @@ -39,7 +39,7 @@ updater path as the instance API. ## Returns -`void` \| `undefined` +`void` ## Example diff --git a/docs/reference/static-functions/functions/table_setSorting.md b/docs/reference/static-functions/functions/table_setSorting.md index 1a68222589..3b22985880 100644 --- a/docs/reference/static-functions/functions/table_setSorting.md +++ b/docs/reference/static-functions/functions/table_setSorting.md @@ -9,12 +9,14 @@ title: table_setSorting function table_setSorting(table, updater): void; ``` -Defined in: [features/row-sorting/rowSortingFeature.utils.ts:41](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/rowSortingFeature.utils.ts#L41) +Defined in: [features/row-sorting/rowSortingFeature.utils.ts:43](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/rowSortingFeature.utils.ts#L43) Routes a sorting updater through the table's sorting change handler. The updater may be a next `SortingState` array or a function of the previous -sorting state, matching the instance `table.setSorting` behavior. +sorting state, matching the instance `table.setSorting` behavior. State +owners receive an equality-guarded updater so structurally equal sorting +values preserve the owner's existing reference. ## Type Parameters diff --git a/docs/reference/static-functions/functions/table_toggleAllColumnsVisible.md b/docs/reference/static-functions/functions/table_toggleAllColumnsVisible.md index 085d449cda..b335bd69b6 100644 --- a/docs/reference/static-functions/functions/table_toggleAllColumnsVisible.md +++ b/docs/reference/static-functions/functions/table_toggleAllColumnsVisible.md @@ -9,7 +9,7 @@ title: table_toggleAllColumnsVisible function table_toggleAllColumnsVisible(table, value?): void; ``` -Defined in: [features/column-visibility/columnVisibilityFeature.utils.ts:332](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/columnVisibilityFeature.utils.ts#L332) +Defined in: [features/column-visibility/columnVisibilityFeature.utils.ts:333](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/columnVisibilityFeature.utils.ts#L333) Shows or hides every hideable leaf column. diff --git a/docs/reference/static-functions/functions/table_toggleAllPageRowsSelected.md b/docs/reference/static-functions/functions/table_toggleAllPageRowsSelected.md index edfc1541ea..6f963ec9e0 100644 --- a/docs/reference/static-functions/functions/table_toggleAllPageRowsSelected.md +++ b/docs/reference/static-functions/functions/table_toggleAllPageRowsSelected.md @@ -12,7 +12,7 @@ function table_toggleAllPageRowsSelected( opts?): void; ``` -Defined in: [features/row-selection/rowSelectionFeature.utils.ts:161](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/rowSelectionFeature.utils.ts#L161) +Defined in: [features/row-selection/rowSelectionFeature.utils.ts:164](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/rowSelectionFeature.utils.ts#L164) Selects or deselects every selectable row on the current page. diff --git a/docs/reference/static-functions/functions/table_toggleAllRowsExpanded.md b/docs/reference/static-functions/functions/table_toggleAllRowsExpanded.md index daa689cc70..d5f45dd72b 100644 --- a/docs/reference/static-functions/functions/table_toggleAllRowsExpanded.md +++ b/docs/reference/static-functions/functions/table_toggleAllRowsExpanded.md @@ -9,7 +9,7 @@ title: table_toggleAllRowsExpanded function table_toggleAllRowsExpanded(table, expanded?): void; ``` -Defined in: [features/row-expanding/rowExpandingFeature.utils.ts:88](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-expanding/rowExpandingFeature.utils.ts#L88) +Defined in: [features/row-expanding/rowExpandingFeature.utils.ts:92](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-expanding/rowExpandingFeature.utils.ts#L92) Expands or collapses every row. diff --git a/docs/reference/static-functions/functions/table_toggleAllRowsSelected.md b/docs/reference/static-functions/functions/table_toggleAllRowsSelected.md index 9e4305ed54..a825bcad94 100644 --- a/docs/reference/static-functions/functions/table_toggleAllRowsSelected.md +++ b/docs/reference/static-functions/functions/table_toggleAllRowsSelected.md @@ -12,7 +12,7 @@ function table_toggleAllRowsSelected( opts?): void; ``` -Defined in: [features/row-selection/rowSelectionFeature.utils.ts:101](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/rowSelectionFeature.utils.ts#L101) +Defined in: [features/row-selection/rowSelectionFeature.utils.ts:104](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/rowSelectionFeature.utils.ts#L104) Selects or deselects every selectable row before grouping. diff --git a/examples/alpine/aggregation/src/main.ts b/examples/alpine/aggregation/src/main.ts index f08851ba31..e79699aed7 100644 --- a/examples/alpine/aggregation/src/main.ts +++ b/examples/alpine/aggregation/src/main.ts @@ -1,7 +1,6 @@ import Alpine from 'alpinejs' import { FlexRender, - rowAggregationFeature, aggregationFn_count, aggregationFn_extent, aggregationFn_mean, @@ -13,6 +12,7 @@ import { createTable, filterFn_includesString, metaHelper, + rowAggregationFeature, rowPaginationFeature, rowSelectionFeature, tableFeatures, @@ -91,6 +91,7 @@ const columns = columnHelper.columns([ Alpine.data('table', () => { const local = Alpine.reactive({ data: makeData(10_000), + // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion rowSource: 'filtered' as RowSource, }) const table = createTable({ diff --git a/examples/alpine/filters/index.html b/examples/alpine/filters/index.html index 7c2841ce5d..e864c86d87 100644 --- a/examples/alpine/filters/index.html +++ b/examples/alpine/filters/index.html @@ -59,6 +59,27 @@ /> + +