Document ListItemComponent prop on the FlatList page - #5198
Open
aravi365 wants to merge 1 commit into
Open
Conversation
FlatList supports ListItemComponent (it takes precedence over renderItem), and it is documented on the VirtualizedList page, but the FlatList page lists every other inherited List*Component prop except this one.
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
1 participant
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.
The FlatList page documents every inherited
List*Componentprop (ListEmptyComponent,ListFooterComponent,ListHeaderComponent,ItemSeparatorComponent) exceptListItemComponent, so it looks like the prop does not exist on FlatList.It does.
FlatList._rendererrenders<ListItemComponent {...props} />and falls back torenderItemonly when it is not set, so it also takes precedence when both are passed:https://github.com/react/react-native/blob/main/packages/react-native/Libraries/Lists/FlatList.js#L624
It is already documented on the VirtualizedList page. This adds the same entry to FlatList, in alphabetical position next to the other
List*Componentprops, and notes the precedence behaviour.Type is listed as
component, elementto match the prop's type and the neighbouring entries on the same page.