The ChannelList displays a list of channels using React Native's FlatList component.
ChannelList internally fetches a list of channels using the client's query channels function; to which you can pass the filters, sort and options parameters via props on ChannelList.
When a user presses on a channel in the list you can provide navigation logic via the onSelect prop to navigate to the selected channel.
General Usage
The ChannelList can be used to display the all the participants in the form of FlatList.
Note: The component should be defined within the OverlayProvider and Chat wrappers so that all the contexts are provided to the component internally.
import { StreamChat } from 'stream-chat';
import { ChannelList, Chat, OverlayProvider } from 'stream-chat-react-native';
const client = StreamChat.getInstance('api_key');
const filters = { members: { $in: [ 'vishal', 'lucas', 'neil' ] } };
const sort = { last_updated: -1 };
const options = { limit: 20, messages_limit: 30 };
export const App = () => <OverlayProvider>
<Chat client={client}>
<ChannelList
filters={filters}
sort={sort}
options={options}
onSelect={(channel) => }
/>
</Chat>
</OverlayProvider>;
Context Providers
ChannelList contains the provider for the ChannelsContext. This can be accessed using the corresponding hook.
Props
filters
Filter object passed internally to the client query function as a parameter. You can filter a query on built-in and custom fields on a Channel.
For optimal performance you should pass a filter object with a static reference. You can use a filter object that is not created inline; or memoize an inline filter object before passing it to the ChannelList to achieve this.
sort
Sort object passed internally to the client query function as a parameter. You can sort a query on built-in and custom fields on a Channel.
For optimal performance you should pass a sort object with a static reference. You can use a sort object that is not created inline; or memoize an inline sort object before passing it to the ChannelList to achieve this.
options
Options object passed internally to the client query function as a parameter.
Unlike the filters or sort objects, changing the options object alone will not re-query the list of channels.
onSelect
Function called when a user presses an item in the ChannelList. The function is called with the Channel instance corresponding to the list item as the only parameter. This callback is often used for navigating to a channel screen.
A Channel instance is not serializable and will therefore raise warnings if passed as a parameter through navigation to another screen.
additionalFlatListProps
Additional props provided to the underlying FlatList.
loadMoreThreshold
Sets the onEndReachedThreshold of the underlying FlatList. We recommend using 0.1 as the default value for this prop, as changing it might hit additional channelQuery calls, and you might reach the limit.
lockChannelOrder
Locks the order of the channels in the list so they will not dynamically reorder by most recent message when a new message is received.
maxUnreadCount
Max number to display within unread notification badge. The value cannot be higher than 255, which is the limit on backend side.
numberOfSkeletons
The number of Skeleton items to display in the LoadingIndicator.
onAddedToChannel
Override for the default Event Listener behavior when the user is added to a channel. The default behavior adds the channel to the list.
| Parameter | Description |
|---|
| setChannels | Setter function for the internal channels state |
| event | Event Object corresponding to notification.added_to_channel |
onChannelDeleted
Override for the default Event Listener behavior when a channel is deleted. The default behavior removes the channel from the list.
| Parameter | Description |
|---|
| setChannels | Setter function for the internal channels state |
| event | Event Object corresponding to channel.deleted |
onChannelHidden
Override for the default Event Listener behavior when a channel is hidden. The default behavior removes the channel from the list.
| Parameter | Description |
|---|
| setChannels | Setter function for the internal channels state |
| event | Event Object corresponding to channel.deleted |
onChannelVisible
Override for the default Event Listener behavior when a channel is made visible. The default behavior adds the channel to the list.
| Parameter | Description |
|---|
| setChannels | Setter function for the internal channels state |
| event | Event Object corresponding to channel.deleted |
onChannelTruncated
Override for the default Event Listener behavior when a channel is truncated. The default behavior reloads the list.
| Parameter | Description |
|---|
| setChannels | Setter function for the internal channels state |
| event | Event Object corresponding to channel.deleted |
onChannelUpdated
Override for the default Event Listener behavior when a channel is updated. The default behavior updates the data on a channel with that from the event.
| Parameter | Description |
|---|
| setChannels | Setter function for the internal channels state |
| event | Event Object corresponding to channel.deleted |
onMessageNew
Override for the default Event Listener behavior when a message is received on a channel that is not being watched. The default behavior adds the channel to the list.
Warning: This function is deprecated. Use onNewMessageNotification instead.
| Parameter | Description |
|---|
| setChannels | Setter function for the internal channels state |
| event | Event Object corresponding to channel.deleted |
onNewMessageNotification
Override for the default Event Listener behavior when a message is received on a channel that is not being watched. The default behavior adds the channel to the list.
| Parameter | Description |
|---|
| setChannels | Setter function for the internal channels state |
| event | Event Object corresponding to channel.deleted |
onNewMessage
Override for the default Event Listener behavior when a message is received on a channel that is being watched. The default behavior moves the channel to the top of the list.
| Parameter | Description |
|---|
| lockChannelOrder | Locks the order of the channels in the list so they will not dynamically reorder by most recent message when a new message is received. |
| setChannels | Setter function for the internal channels state. |
| event | Event Object corresponding to message.new. |
onRemovedFromChannel
Override for the default Event Listener behavior when the user is removed from a channel. The default behavior removes the channel from the list.
| Parameter | Description |
|---|
| setChannels | Setter function for the internal channels state. |
| event | Event Object corresponding to channel.deleted. |
setFlatlistRef
Callback function to access the underlying FlatList ref.
UI Component Props
EmptyStateIndicator
Rendered when the channel list is empty and not loading via the ListEmptyComponent prop on the FlatList.
Rendered when loadingNextPage from ChannelsContext is true via the ListFooterComponent prop on the FlatList.
Rendered when error from ChannelsContext is true.
Rendered when isOnline from ChatContext is false.
List
Component to render the list of channels.
Rendered when provided if the channel list is not empty via the ListHeaderComponent prop on the FlatList.
| Type |
|---|
ComponentType |undefined |
LoadingErrorIndicator
Rendered when error from ChannelsContext is true, and the channel list is empty and not loading.
LoadingIndicator
Rendered when the channel list is empty and loading via the ListEmptyComponent prop on the FlatList.
Preview
List item rendered by the underlying FlatList.
PreviewAvatar
Avatar component rendered within Preview.
PreviewMessage
Message component rendered within Preview.
PreviewMutedStatus
Channel muted status component rendered within Preview.
PreviewStatus
Status component rendered within Preview.
PreviewTitle
Title component rendered within Preview.
PreviewUnreadCount
Unread count component rendered within Preview.
Skeleton
Row item rendered in the LoadingIndicator.
| Type | Default |
|---|
| ComponentType | undefined | Skeleton |