stream-chat-android-compose/io.getstream.chat.android.compose.ui.channels/ChannelsScreen

ChannelsScreen

@Composable
fun ChannelsScreen(viewModelFactory: ChannelViewModelFactory = ChannelViewModelFactory(), viewModelKey: String? = null, title: String = "Stream Chat", isShowingHeader: Boolean = true, searchMode: SearchMode = SearchMode.None, onHeaderActionClick: () -> Unit = {}, onHeaderAvatarClick: () -> Unit = {}, onChannelClick: (Channel) -> Unit = {}, onSearchMessageItemClick: (Message) -> Unit = {}, onViewChannelInfoAction: (Channel) -> Unit = {}, onBackPressed: () -> Unit = {}, isBackPressEnabled: Boolean = true)

Default root Channel screen component, that provides the necessary ViewModel.

It can be used without most parameters for default behavior, that can be tweaked if necessary.

Parameters

viewModelFactory

The factory used to build the ViewModels and power the behavior. You can use the default implementation by not passing in an instance yourself, or you can customize the behavior using its parameters.

viewModelKey

Key to differentiate between instances of ChannelListViewModel.

title

Header title.

isShowingHeader

If we show the header or hide it.

searchMode

The search mode for the screen.

onHeaderActionClick

Handler for the default header action.

onHeaderAvatarClick

Handle for when the user clicks on the header avatar.

onChannelClick

Handler for Channel item clicks.

onViewChannelInfoAction

Handler for when the user selects the ViewInfo option for a Channel.

onBackPressed

Handler for back press action.

isBackPressEnabled

Indicator if the default back handler is enabled. Set to false to fully disable the back handling and catch the back-press event in a BackHandler higher in the compose hierarchy. Default: true.