From 9f641f95f560d4a2e953397b53851bf072b45354 Mon Sep 17 00:00:00 2001 From: dfedoryshchev Date: Fri, 31 Jul 2026 18:54:56 +0100 Subject: [PATCH] docs(table-core): correct getIsSome*Selected JSDoc to at-least-one semantics `getIsSomeRowsSelected` and `getIsSomePageRowsSelected` were still documented as "partial" selection checks, which is the v8 meaning. In v9 they return true whenever at least one row is selected, including when all of them are. `table_getIsSomeRowsSelected` also reads `state.rowSelection` rather than the filtered row model, so "across filtered rows" was inaccurate as well. The generated reference pages carry the same sentences, so they are updated alongside the JSDoc. --- docs/reference/index/interfaces/Table_RowSelection.md | 4 ++-- .../functions/table_getIsSomePageRowsSelected.md | 2 +- .../functions/table_getIsSomeRowsSelected.md | 4 ++-- .../src/features/row-selection/rowSelectionFeature.types.ts | 4 ++-- .../src/features/row-selection/rowSelectionFeature.utils.ts | 6 +++--- 5 files changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/reference/index/interfaces/Table_RowSelection.md b/docs/reference/index/interfaces/Table_RowSelection.md index 4735a3deaf..a1329f56c5 100644 --- a/docs/reference/index/interfaces/Table_RowSelection.md +++ b/docs/reference/index/interfaces/Table_RowSelection.md @@ -105,7 +105,7 @@ getIsSomePageRowsSelected: () => boolean; Defined in: [features/row-selection/rowSelectionFeature.types.ts:150](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/rowSelectionFeature.types.ts#L150) -Checks whether the current page has a partial row selection. +Checks whether at least one selectable row on the current page is selected. #### Returns @@ -121,7 +121,7 @@ getIsSomeRowsSelected: () => boolean; Defined in: [features/row-selection/rowSelectionFeature.types.ts:154](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/rowSelectionFeature.types.ts#L154) -Checks whether filtered rows have a partial row selection. +Checks whether at least one row id is selected. #### Returns diff --git a/docs/reference/static-functions/functions/table_getIsSomePageRowsSelected.md b/docs/reference/static-functions/functions/table_getIsSomePageRowsSelected.md index 11b4674ed6..528e8fa3a5 100644 --- a/docs/reference/static-functions/functions/table_getIsSomePageRowsSelected.md +++ b/docs/reference/static-functions/functions/table_getIsSomePageRowsSelected.md @@ -11,7 +11,7 @@ function table_getIsSomePageRowsSelected(table): boolean; Defined in: [features/row-selection/rowSelectionFeature.utils.ts:424](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/rowSelectionFeature.utils.ts#L424) -Checks whether the current page has a partial selection. +Checks whether at least one selectable row on the current page is selected. ## Type Parameters diff --git a/docs/reference/static-functions/functions/table_getIsSomeRowsSelected.md b/docs/reference/static-functions/functions/table_getIsSomeRowsSelected.md index a1a03bad8e..2d303b4015 100644 --- a/docs/reference/static-functions/functions/table_getIsSomeRowsSelected.md +++ b/docs/reference/static-functions/functions/table_getIsSomeRowsSelected.md @@ -11,9 +11,9 @@ function table_getIsSomeRowsSelected(table): boolean; Defined in: [features/row-selection/rowSelectionFeature.utils.ts:406](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/rowSelectionFeature.utils.ts#L406) -Checks whether selection is partially applied across filtered rows. +Checks whether at least one row id is selected. -The result is true when at least one row id is selected +The result stays true when every row is selected. ## Type Parameters diff --git a/packages/table-core/src/features/row-selection/rowSelectionFeature.types.ts b/packages/table-core/src/features/row-selection/rowSelectionFeature.types.ts index 1c4c0632be..e39d7fe67c 100644 --- a/packages/table-core/src/features/row-selection/rowSelectionFeature.types.ts +++ b/packages/table-core/src/features/row-selection/rowSelectionFeature.types.ts @@ -145,11 +145,11 @@ export interface Table_RowSelection< */ getIsAllRowsSelected: () => boolean /** - * Checks whether the current page has a partial row selection. + * Checks whether at least one selectable row on the current page is selected. */ getIsSomePageRowsSelected: () => boolean /** - * Checks whether filtered rows have a partial row selection. + * Checks whether at least one row id is selected. */ getIsSomeRowsSelected: () => boolean /** diff --git a/packages/table-core/src/features/row-selection/rowSelectionFeature.utils.ts b/packages/table-core/src/features/row-selection/rowSelectionFeature.utils.ts index a0c449799e..02f4e6a181 100644 --- a/packages/table-core/src/features/row-selection/rowSelectionFeature.utils.ts +++ b/packages/table-core/src/features/row-selection/rowSelectionFeature.utils.ts @@ -394,9 +394,9 @@ export function table_getIsAllPageRowsSelected< } /** - * Checks whether selection is partially applied across filtered rows. + * Checks whether at least one row id is selected. * - * The result is true when at least one row id is selected + * The result stays true when every row is selected. * * @example * ```ts @@ -414,7 +414,7 @@ export function table_getIsSomeRowsSelected< } /** - * Checks whether the current page has a partial selection. + * Checks whether at least one selectable row on the current page is selected. * * @example * ```ts