This is documentation for Stream Chat React-native SDK v3, which is no longer actively maintained. For up-to-date documentation, see the latest version (v5).

ChannelListMessenger

Component to render list of channels, within the ChannelList component. This is the default component provided to the prop List on the ChannelList component.

Props

additionalFlatListProps

Additional props provided to the underlying FlatList.

Example

const flatListProps = { bounces: true };

<ChannelList additionalFlatListProps={flatListProps} />;

Don’t use additionalFlatListProps to access the FlatList ref, use setFlatListRef instead.

Type
object

channels

Array of channels currently loaded within the ChannelList component.

Type
array

error

True if a call to query channels API call within ChannelList component results in error, either during first load or during pagination.

Type
boolean

loadingChannels

True if ChannelList component is loading the first page of channels.

Type
boolean

loadingNextPage

True if ChannelList component is loading more channels as part of pagination. This will be set to true when user scrolls to bottom of the list and hasNextPage is true.

Type
boolean

loadMoreThreshold

Sets the onEndReachedThreshold of the underlying FlatList.

TypeDefault
number2

loadNextPage

Function to load next page for the ChannelList component.

Type
function

refreshing

True if ChannelList component is refreshing the list (using refreshList function call). Refreshing state will be triggered either when user executes pull-to-refresh gesture or if network connection is being recovered. This value is attached to refreshing prop of underlying FlatList component of ChannelList.

Type
boolean

refreshList

Function to manually re-sync or refresh the channels in ChannelList component.

Calling refreshList will trigger a RefreshControl on underlying FlatList component.

Type
function

reloadList

Function to manually reload the channels in ChannelList component.

Calling reloadList will wipe out the existing list of channels and show a loading indicator until new results are ready.

Type
function

setFlatListRef

Callback function to access the underlying FlatList ref.

Example

const flatListRef = useRef();

<ChannelList setFlatListRef={ref => (flatListRef.current = ref)} />;
Type
function
ParameterDescription
refFlatList ref

EmptyStateIndicator

Rendered when the channel list is empty and not loading via the ListEmptyComponent prop on the FlatList.

TypeDefault
componentEmptyStateIndicator

FooterLoadingIndicator

Rendered when loadingNextPage from ChannelsContext is true via the ListFooterComponent prop on the FlatList.

ListHeaderComponent

Rendered when provided if the channel list is not empty via the ListHeaderComponent prop on the FlatList.

Type
component

LoadingErrorIndicator

Rendered when error from ChannelsContext is true, and the channel list is empty and not loading.

TypeDefault
componentLoadingErrorIndicator

LoadingIndicator

Rendered when the channel list is empty and loading via the ListEmptyComponent prop on the FlatList.

TypeDefault
componentChannelListLoadingIndicator

© Getstream.io, Inc. All Rights Reserved.