Fix misleading ListItemComponent JSDoc in VirtualizedList types - #58500
Open
aravi365 wants to merge 1 commit into
Open
Fix misleading ListItemComponent JSDoc in VirtualizedList types#58500aravi365 wants to merge 1 commit into
aravi365 wants to merge 1 commit into
Conversation
The comment said ListItemComponent receives index and separators in addition to what renderItem gets, but _renderElement passes the same item, index and separators to both. Say that, and note that ListItemComponent takes precedence when both are set.
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.
Summary
I added
ListItemComponentto these types in #57754 and got the comment wrong. It says the component receivesindexandseparators"in addition to the data provided torenderItem", which reads as ifrenderItemdoesn't get them. It does._renderElementinVirtualizedListCellRenderer.jspasses the sameitem,indexandseparatorsto both.This fixes that sentence and mentions the one thing that actually is different, which is precedence. When both are set,
ListItemComponentwins and_renderElementlogs a warning saying so.Changelog:
[INTERNAL] [FIXED] - Fix JSDoc for ListItemComponent in VirtualizedList types
Test Plan
Comment-only change in a
.d.ts, no type changes. Checked the wording against_renderElement: