fix(cdk/table): ensure CdkTable updates view with OnPush and trackBy #31451
+45
−1
Conversation
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
When CdkTable is used with OnPush change detection and a `trackBy` function, changes to the `dataSource` might not trigger a view update if the `trackBy` function indicates that the rows themselves haven't changed (even if their internal data has). This can leave the data-bound elements within the table rows displaying outdated information. This commit adds `markForCheck()` calls within the `_renderRows` method of `CdkTable`. These calls ensure that when the table's data is updated (even without full row re-creation due to `trackBy`), the component is explicitly marked for change detection. This triggers a re-evaluation of the bindings for all visible rows, ensuring the view remains consistent with the underlying data. Fixes angular#24483
skrtheboss
requested review from
mmalerba and
wagnermaciel
and removed request for
a team
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.
Fixes #24483
Description
When
CdkTableis used with theOnPushchange detection strategy and atrackByfunction, changes to thedataSourcemight not trigger a view update if thetrackByfunction indicates that the row instances themselves haven't changed. This can lead to the data-bound elements within the table rows displaying outdated information, even if their underlying data properties have been modified.This PR addresses the issue by adding
_changeDetectorRef.markForCheck()calls within therenderRowsmethod ofCdkTable. These calls ensure that whenever the table's data or row definitions are updated, the component is explicitly marked for change detection. This forces a re-evaluation of the bindings for all visible rows, ensuring the view remains consistent with the latest underlying data.A new test case has been added to
table.spec.tsto specifically verify this behavior in anOnPushcomponent usingtrackBywhen data properties are updated.