docs: clarify how to replace the sort event#684
Open
spike-rabbit wants to merge 1 commit intomainfrom
Open
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the JSDoc documentation for the sort output event in DatatableComponent to provide better guidance on handling server-side paging. The review suggests improving the clarity and grammatical consistency of this documentation by using present tense and explicitly referencing the PageEvent interface properties, providing a clearer rephrasing for developers.
spike-rabbit
force-pushed
the
docs/clarify-sort-replacement
branch
from
8c1332c to
35c0741
Compare
There was a problem hiding this comment.
Pull request overview
Updates the DatatableComponent.sort deprecation JSDoc to better explain how consumers can handle server-side paging/sorting without relying on the deprecated (sort) output.
Changes:
- Adds a note suggesting using
(page)as the single subscription point and readingPageEvent.sortsfrom the payload.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
spike-rabbit
force-pushed
the
docs/clarify-sort-replacement
branch
from
35c0741 to
cf1c285
Compare
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.
Closes #682
What kind of change does this PR introduce? (check one with "x")
What is the current behavior? (You can also link to an open issue here)
No hint that the
pageevent can be a replacement forsort.What is the new behavior?
The deprecation note states, that
pageshould be used for server-side paging.Does this PR introduce a breaking change? (check one with "x")
If this PR contains a breaking change, please describe the impact and migration path for existing applications: ...
Other information:
@fh1ch should we also update the changelog?