stream-chat-android-compose/io.getstream.chat.android.compose.ui.channels.list/ChannelList

ChannelList

fun ChannelList(modifier: Modifier = Modifier, contentPadding: PaddingValues = PaddingValues(), viewModel: ChannelListViewModel = viewModel( factory = ChannelListViewModelFactory( ChatClient.instance(), QuerySortByField.descByName("last_updated"), filters = null, ), ), lazyListState: LazyListState = rememberLazyListState(), onLastItemReached: () -> Unit = remember(viewModel) { { viewModel.loadMore() } }, onChannelClick: (Channel) -> Unit = {}, onChannelLongClick: (Channel) -> Unit = remember(viewModel) { { viewModel.selectChannel(it) } }, onSearchResultClick: (Message) -> Unit = {}, onStartChatClick: () -> Unit? = null)

Default ChannelList component, that relies on the ChannelListViewModel to load the data and show it on the UI.

Parameters

modifier

Modifier for styling.

contentPadding

Padding values to be applied to the channel list surrounding the content inside.

viewModel

The ViewModel that loads all the data and connects it to the UI. We provide a factory that builds the default ViewModel in case the user doesn't want to provide their own.

lazyListState

State of the lazy list that represents the list of channels. Useful for controlling the scroll state.

onLastItemReached

Handler for pagination, when the user reaches the last item in the list.

onChannelClick

Handler for a single item tap.

onChannelLongClick

Handler for a long item tap.

onSearchResultClick

Handler for a single search result tap.

onStartChatClick

Handler for the "Start a chat" button in the empty state. If null, the button is hidden.

@Composable

fun ChannelList(channelsState: ChannelsState, currentUser: User?, modifier: Modifier = Modifier, contentPadding: PaddingValues = PaddingValues(0.dp), lazyListState: LazyListState = rememberLazyListState(), onLastItemReached: () -> Unit = {}, onChannelClick: (Channel) -> Unit = {}, onChannelLongClick: (Channel) -> Unit = {}, onSearchResultClick: (Message) -> Unit = {}, onStartChatClick: () -> Unit? = null)

Root Channel list component, that represents different UI, based on the current channel state.

This is decoupled from ViewModels, so the user can provide manual and custom data handling, as well as define a completely custom UI component for the channel item.

If there is no state, no query active or the data is being loaded, we show the LoadingIndicator.

If there are no results or we're offline, usually due to an error in the API or network, we show an EmptyContent.

If there is data available and it is not empty, we show Channels.