docs(table-core): correct getIsSome*Selected JSDoc to at-least-one se… - #6478
Merged
KevinVandy merged 2 commits intoJul 31, 2026
Merged
Conversation
…mantics `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.
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (5)
📝 WalkthroughWalkthroughChangesRow selection documentation
Estimated code review effort: 1 (Trivial) | ~3 minutes Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
View your CI Pipeline Execution ↗ for commit 4a76a33
☁️ Nx Cloud last updated this comment at |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Changes
getIsSomeRowsSelected()andgetIsSomePageRowsSelected()are documented as "partial" selection checks, which is the v8 meaning. In v9 both returntruewhenever at least one row is selected, including when every row is selected.table_getIsSomeRowsSelecteddelegates totable_getSelectedRowIds, i.e.Object.keys(state.rowSelection).length > 0, so it is neither scoped to filtered rows nor "partial".table_getIsSomePageRowsSelectedhas no!getIsAllPageRowsSelected()guard, so a fully selected page also returnstrue.That behaviour is the intended one: the migration guide says these "now mean at least one, including the all-selected case. They no longer mean 'some but not all.'", and the unit tests assert it. Only the JSDoc kept the old wording, and its own second sentence ("The result is true when at least one row id is selected") already contradicted its summary.
The generated reference pages carry the same sentences, so they are updated alongside.
Checklist
Summary by CodeRabbit