-
public interface ChatComponentFactoryFactory for creating stateless components that are used by default throughout the Chat UI.
Example of a custom ChatComponentFactory implementation that changes the default UI of the trailing content of the channel list header element:
ChatTheme( componentFactory = object : ChatComponentFactory() { @Composable override fun RowScope.ChannelListHeaderTrailingContent( onHeaderActionClick: () -> Unit, ) { IconButton(onClick = onHeaderActionClick) { Icon( imageVector = Icons.Default.Add, contentDescription = "Add", ) } } } ) { // Your Chat screens }ChatComponentFactory can also be extended in a separate class and passed to the ChatTheme as shown:
class MyChatComponentFactory : ChatComponentFactory { @Composable override fun RowScope.ChannelListHeaderTrailingContent(onHeaderActionClick: () -> Unit) { IconButton(onClick = onHeaderActionClick) { Icon( imageVector = Icons.Default.Add, contentDescription = "Add", ) } } } ChatTheme( componentFactory = MyComponentFactory() ) { // Your Chat screens }
-
-
Method Summary
Modifier and Type Method Description UnitChannelListHeader(Modifier modifier, String title, User currentUser, ConnectionState connectionState, Function1<User, Unit> onAvatarClick, Function0<Unit> onHeaderActionClick)The default header shown above the channel list. UnitChannelListHeaderLeadingContent(RowScope $self, User currentUser, Function1<User, Unit> onAvatarClick)The default leading content of the channel list header. UnitChannelListHeaderCenterContent(RowScope $self, ConnectionState connectionState, String title)The default center content of the channel list header. UnitChannelListHeaderTrailingContent(RowScope $self, Function0<Unit> onHeaderActionClick)The default trailing content of the channel list header. UnitChannelListLoadingIndicator(Modifier modifier)The default loading indicator of the channel list, when the initial data is loading. UnitChannelListEmptyContent(Modifier modifier)The default empty content of the channel list. UnitChannelListItemContent(LazyItemScope $self, ItemState.ChannelItemState channelItem, User currentUser, Function1<Channel, Unit> onChannelClick, Function1<Channel, Unit> onChannelLongClick)The default channel list item content. UnitChannelListHelperContent(BoxScope $self)The default helper content of the channel list. UnitChannelListLoadingMoreItemContent(LazyItemScope $self)The default loading more item, when the next page of the channel list is loading. UnitChannelListDividerItem(LazyItemScope $self)The default divider between channel items. UnitChannelItemLeadingContent(RowScope $self, ItemState.ChannelItemState channelItem, User currentUser)The default leading content of the channel item. UnitChannelItemCenterContent(RowScope $self, ItemState.ChannelItemState channelItem, User currentUser)The default center content of the channel item. UnitChannelItemTrailingContent(RowScope $self, ItemState.ChannelItemState channelItem, User currentUser)The default trailing content of the channel item. UnitChannelItemUnreadCountIndicator(Integer unreadCount, Modifier modifier)The default unread count indicator in the channel item. UnitChannelItemReadStatusIndicator(Channel channel, Message message, User currentUser, Modifier modifier)The default read status indicator in the channel item, weather the last message is sent, pending or read. UnitChannelListSearchInput(Modifier modifier, String query, Function0<Unit> onSearchStarted, Function1<String, Unit> onValueChange)The default search input of the channel list. UnitSearchInputLeadingIcon(RowScope $self)The default leading icon of the search input. UnitSearchInputLabel()The default label of the search input. UnitSearchInputClearButton(Function0<Unit> onClick)The default clear button of the search input. UnitChannelListEmptySearchContent(Modifier modifier, String searchQuery)The default empty search content of the channel list, when there are no matching search results. UnitSearchResultItemContent(LazyItemScope $self, ItemState.SearchResultItemState searchResultItem, User currentUser, Function1<Message, Unit> onSearchResultClick)The default search result item of the channel list. UnitSearchResultItemLeadingContent(RowScope $self, ItemState.SearchResultItemState searchResultItem, User currentUser)The default leading content of a search result item. UnitSearchResultItemCenterContent(RowScope $self, ItemState.SearchResultItemState searchResultItem, User currentUser)The default center content of a search result item. UnitSearchResultItemTrailingContent(RowScope $self, ItemState.SearchResultItemState searchResultItem)The default trailing content of a search result item. UnitMessageListHeader(Modifier modifier, Channel channel, User currentUser, ConnectionState connectionState, List<User> typingUsers, MessageMode messageMode, Function0<Unit> onBackPressed, Function1<Channel, Unit> onHeaderTitleClick, Function0<Unit> onChannelAvatarClick)The default header of the message list. UnitMessageListHeaderLeadingContent(RowScope $self, Function0<Unit> onBackPressed)The default leading content of the message list header, which is the back button. UnitMessageListHeaderCenterContent(RowScope $self, Modifier modifier, Channel channel, User currentUser, List<User> typingUsers, MessageMode messageMode, Function1<Channel, Unit> onHeaderTitleClick, ConnectionState connectionState)The default center content of the message list header. UnitMessageListHeaderCenterContent(RowScope $self, Modifier modifier, Channel channel, User currentUser, ConnectionState connectionState, List<User> typingUsers, MessageMode messageMode, Function1<Channel, Unit> onClick)The default center content of the message list header. UnitMessageListHeaderTrailingContent(RowScope $self, Channel channel, User currentUser, Function0<Unit> onClick)The default trailing content of the message list header, which is the channel avatar. UnitMessageListBackground()The default background of the message list. UnitMessageListLoadingIndicator(Modifier modifier)The default loading indicator of the message list, when the initial message list is loading. UnitMessageListEmptyContent(Modifier modifier)The default empty content of the message list, when the message list is empty. UnitMessageListHelperContent(BoxScope $self, MessageListState messageListState, MessagesLazyListState messagesLazyListState, Function1<Function0<Unit>, Unit> onScrollToBottomClick)The default helper content of the message list. UnitScrollToBottomButton(Modifier modifier, Boolean visible, Integer count, Function0<Unit> onClick)The default scroll-to-bottom button shown when the user scrolls away from the bottom of the list. UnitMessageListItemContainer(LazyItemScope $self, MessageListItemState messageListItem, ReactionSorting reactionSorting, Function2<Message, Poll, Unit> onPollUpdated, Function3<Message, Poll, Option, Unit> onCastVote, Function3<Message, Poll, Vote, Unit> onRemoveVote, Function3<Message, Poll, PollSelectionType, Unit> selectPoll, Function1<String, Unit> onClosePoll, Function2<Poll, String, Unit> onAddPollOption, Function1<Message, Unit> onLongItemClick, Function1<Message, Unit> onThreadClick, Function1<Message, Unit> onReactionsClick, Function1<GiphyAction, Unit> onGiphyActionClick, Function1<MediaGalleryPreviewResult, Unit> onMediaGalleryPreviewResult, Function1<Message, Unit> onQuotedMessageClick, Function1<User, Unit> onUserAvatarClick, Function2<Message, String, Unit> onMessageLinkClick, Function1<User, Unit> onUserMentionClick, Function3<Message, Poll, String, Unit> onAddAnswer, Function1<Message, Unit> onReply)The default message list item container, which renders each MessageListItemState's subtype. ModifiermessageListItemModifier(LazyItemScope $self)The default message list item modifier for styling. UnitMessageListLoadingMoreItemContent(LazyItemScope $self)The default loading more item of the message list, when the next page of messages is loading. UnitMessageListDateSeparatorItemContent(LazyItemScope $self, DateSeparatorItemState dateSeparatorItem)The default date separator item content of the message list. UnitMessageListUnreadSeparatorItemContent(LazyItemScope $self, UnreadSeparatorItemState unreadSeparatorItem)The default unread separator item content of the message list. UnitMessageListThreadDateSeparatorItemContent(LazyItemScope $self, ThreadDateSeparatorItemState threadDateSeparatorItem)The default thread date separator item content of the message list. UnitMessageListSystemItemContent(LazyItemScope $self, SystemMessageItemState systemMessageItem)The default system message content of the message list. UnitMessageListModeratedItemContent(LazyItemScope $self, ModeratedMessageItemState moderatedMessageItem)The default moderated message content of the message list. UnitMessageListTypingIndicatorItemContent(LazyItemScope $self, TypingItemState typingItem)The default typing indicator content of the message list. UnitMessageListEmptyThreadPlaceholderItemContent(LazyItemScope $self, EmptyThreadPlaceholderItemState emptyThreadPlaceholderItem)The default empty thread placeholder item content of the message list. UnitMessageListStartOfTheChannelItemContent(LazyItemScope $self, StartOfTheChannelItemState startOfTheChannelItem)The default start of the channel item content of the message list. UnitMessageListItemContent(LazyItemScope $self, MessageItemState messageItem, ReactionSorting reactionSorting, Function2<Message, Poll, Unit> onPollUpdated, Function3<Message, Poll, Option, Unit> onCastVote, Function3<Message, Poll, Vote, Unit> onRemoveVote, Function3<Message, Poll, PollSelectionType, Unit> selectPoll, Function1<String, Unit> onClosePoll, Function2<Poll, String, Unit> onAddPollOption, Function1<Message, Unit> onLongItemClick, Function1<Message, Unit> onThreadClick, Function1<Message, Unit> onReactionsClick, Function1<GiphyAction, Unit> onGiphyActionClick, Function1<MediaGalleryPreviewResult, Unit> onMediaGalleryPreviewResult, Function1<Message, Unit> onQuotedMessageClick, Function1<User, Unit> onUserAvatarClick, Function2<Message, String, Unit> onMessageLinkClick, Function1<User, Unit> onUserMentionClick, Function3<Message, Poll, String, Unit> onAddAnswer, Function1<Message, Unit> onReply)The default item content of a regular message. UnitMessageBubble(Modifier modifier, Message message, Color color, Shape shape, BorderStroke border, PaddingValues contentPadding, Function0<Unit> content)The default appearance of the message bubble. UnitMessageFailedIcon(Modifier modifier, Message message)Icon shown at the bottom-end of a Message when it failed to send. UnitMessageItemHeaderContent(ColumnScope $self, MessageItemState messageItem, ReactionSorting reactionSorting, Function1<Message, Unit> onReactionsClick)The default header content of the message item. UnitMessageItemFooterContent(ColumnScope $self, MessageItemState messageItem)The default footer content of the message item. UnitMessageItemLeadingContent(RowScope $self, MessageItemState messageItem, Function0<Unit> onUserAvatarClick)The default leading content of the message item. UnitMessageItemCenterContent(ColumnScope $self, MessageItemState messageItem, Function1<Message, Unit> onLongItemClick, Function2<Message, Poll, Unit> onPollUpdated, Function3<Message, Poll, Option, Unit> onCastVote, Function3<Message, Poll, Vote, Unit> onRemoveVote, Function3<Message, Poll, PollSelectionType, Unit> selectPoll, Function3<Message, Poll, String, Unit> onAddAnswer, Function1<String, Unit> onClosePoll, Function2<Poll, String, Unit> onAddPollOption, Function1<GiphyAction, Unit> onGiphyActionClick, Function1<Message, Unit> onQuotedMessageClick, Function2<Message, String, Unit> onLinkClick, Function1<User, Unit> onUserMentionClick, Function1<MediaGalleryPreviewResult, Unit> onMediaGalleryPreviewResult)The default center content of the message item. UnitMessageItemTrailingContent(RowScope $self, MessageItemState messageItem)The default trailing content of the message item. UnitMessageReactionList(MessageReactionListParams params)The default list of reactions displayed above the message bubble and is part of MessageItemHeaderContent. UnitMessageReactionItem(RowScope $self, MessageReactionItemParams params)The default individual reaction item shown inside MessageReactionList. UnitMessageGiphyContent(Message message, User currentUser, Function1<GiphyAction, Unit> onGiphyActionClick)The default Giphy message content. UnitMessageDeletedContent(Modifier modifier)The default content of a deleted message. UnitMessageRegularContent(Message message, User currentUser, Function1<Message, Unit> onLongItemClick, Function1<MediaGalleryPreviewResult, Unit> onMediaGalleryPreviewResult, Function1<Message, Unit> onQuotedMessageClick, Function1<User, Unit> onUserMentionClick, Function2<Message, String, Unit> onLinkClick)The default content of a regular message that can contain attachments and text. UnitMessageTextContent(Message message, User currentUser, Function1<Message, Unit> onLongItemClick, Function2<Message, String, Unit> onLinkClick, Function1<User, Unit> onUserMentionClick)The default message text content. UnitMessageQuotedContent(Modifier modifier, Message message, User currentUser, Message replyMessage, Function1<Message, Unit> onLongItemClick, Function1<Message, Unit> onQuotedMessageClick)The default quoted message content. UnitMessageFooterUploadingContent(Modifier modifier, MessageItemState messageItem)The default uploading content of the message footer. UnitMessageFooterOnlyVisibleToYouContent(MessageItemState messageItem)The default content of the only-visible-to-you footer message. UnitMessageFooterContent(MessageItemState messageItem)The default footer content. UnitMessageFooterStatusIndicator(Modifier modifier, Message message, Boolean isMessageRead, Integer readCount)The default read status indicator in the message footer, weather the message is sent, pending or read. UnitMessageFooterStatusIndicator(MessageFooterStatusIndicatorParams params)UnitMessageComposer(MessageComposerState messageComposerState, Function2<String, List<Attachment>, Unit> onSendMessage, Modifier modifier, Function0<Unit> onAttachmentsClick, Function0<Unit> onCommandsClick, Function1<String, Unit> onValueChange, Function1<Attachment, Unit> onAttachmentRemoved, Function0<Unit> onCancelAction, Function1<LinkPreview, Unit> onLinkPreviewClick, Function1<User, Unit> onMentionSelected, Function1<Command, Unit> onCommandSelected, Function1<Boolean, Unit> onAlsoSendToChannelSelected, AudioRecordingActions recordingActions, Function2<ColumnScope, MessageComposerState, Unit> headerContent, Function2<ColumnScope, MessageComposerState, Unit> footerContent, Function1<List<User>, Unit> mentionPopupContent, Function1<List<Command>, Unit> commandPopupContent, Function2<RowScope, MessageComposerState, Unit> integrations, Function1<MessageComposerState, Unit> label, Function2<RowScope, MessageComposerState, Unit> input, Function2<RowScope, MessageComposerState, Unit> audioRecordingContent, Function1<MessageComposerState, Unit> trailingContent)The default message composer that contains the message input, attachments, commands, recording actions, integrations, and the send button. UnitMessageComposerHeaderContent(ColumnScope $self, MessageComposerState state, Function0<Unit> onCancel, Function1<LinkPreview, Unit> onLinkPreviewClick)The default header content of the message composer. UnitMessageComposerMessageInputOptions(Modifier modifier, MessageAction activeAction, Function0<Unit> onCancel)The default options header for the message input component. UnitMessageComposerLinkPreview(Modifier modifier, LinkPreview linkPreview, Function1<LinkPreview, Unit> onClick)Shows a preview of the link that the user has entered in the message composer. UnitMessageComposerFooterContent(ColumnScope $self, MessageComposerState state, Function1<Boolean, Unit> onAlsoSendToChannelSelected)The default footer content of the message composer. UnitMessageComposerMentionsPopupContent(List<User> mentionSuggestions, Function1<User, Unit> onMentionSelected)The default mentions popup content of the message composer. UnitMessageComposerMentionSuggestionItem(User user, Function1<User, Unit> onMentionSelected)The default mention suggestion item of the message composer. UnitMessageComposerMentionSuggestionItemLeadingContent(RowScope $self, User user)The default leading content of the mention suggestion item of the message composer. UnitMessageComposerMentionSuggestionItemCenterContent(RowScope $self, User user)The default center content of the mention suggestion item of the message composer. UnitMessageComposerMentionSuggestionItemTrailingContent(RowScope $self, User user)The default trailing content of the mention suggestion item of the message composer. UnitMessageComposerCommandsPopupContent(List<Command> commandSuggestions, Function1<Command, Unit> onCommandSelected)The default instant commands popup content of the message composer. UnitMessageComposerCommandSuggestionItem(Command command, Function1<Command, Unit> onCommandSelected)The default command suggestion item of the message composer. UnitMessageComposerCommandSuggestionItemLeadingContent(RowScope $self, Command command)The default leading content of the command suggestion item of the message composer. UnitMessageComposerCommandSuggestionItemCenterContent(RowScope $self, Modifier modifier, Command command)The default center content of the command suggestion item of the message composer. UnitMessageComposerIntegrations(RowScope $self, MessageComposerState state, Function0<Unit> onAttachmentsClick, Function0<Unit> onCommandsClick)The default integrations of the message composer. UnitMessageComposerAttachmentsButton(RowScope $self, Boolean enabled, Function0<Unit> onClick)The default attachments button of the message composer. UnitMessageComposerCommandsButton(RowScope $self, Boolean hasCommandSuggestions, Boolean enabled, Function0<Unit> onClick)The default commands button of the message composer. UnitMessageComposerLabel(MessageComposerState state)The default label of the message composer. UnitMessageComposerInput(RowScope $self, MessageComposerState state, Function1<String, Unit> onInputChanged, Function1<Attachment, Unit> onAttachmentRemoved, Function1<MessageComposerState, Unit> label)The default input content of the message composer. UnitMessageComposerQuotedMessage(Modifier modifier, MessageComposerState state, Message quotedMessage)The default appearance of a quoted message in the message composer. UnitMessageComposerTrailingContent(MessageComposerState state, Function2<String, List<Attachment>, Unit> onSendClick, AudioRecordingActions recordingActions)The default trailing content of the message composer. UnitMessageComposerCoolDownIndicator(Modifier modifier, Integer coolDownTime)The default cooldown indicator of the message composer. UnitMessageComposerSendButton(Boolean enabled, Boolean isInputValid, Function0<Unit> onClick)The default "Send" button of the message composer. UnitMessageComposerAudioRecordButton(RecordingState state, AudioRecordingActions recordingActions)The default "Audio record (voice message)" button of the message composer. UnitMessageComposerAudioRecordingContent(RowScope $self, MessageComposerState state, AudioRecordingActions recordingActions)Default composable used for displaying audio recording information while audio recording is in progress. UnitAvatar(Modifier modifier, String imageUrl, String initials, Shape shape, TextStyle textStyle, Painter placeholderPainter, String contentDescription, DpOffset initialsAvatarOffset, Function0<Unit> onClick)The default avatar, which renders an image from the provided image URL. UnitAvatar(Modifier modifier, String imageUrl, String initials, Shape shape, TextStyle textStyle, Painter placeholderPainter, Painter errorPlaceholderPainter, String contentDescription, DpOffset initialsAvatarOffset, Function0<Unit> onClick)The default avatar, which renders an image from the provided image URL. UnitFallbackAvatar(String imageUrl, String initials, Modifier modifier, Shape shape, TextStyle textStyle, DpOffset avatarOffset, Function0<Unit> onClick)The default fallback avatar, which renders initials in a circle. UnitUserAvatar(Modifier modifier, User user, TextStyle textStyle, Boolean showOnlineIndicator, Function1<BoxScope, Unit> onlineIndicator, Function0<Unit> onClick)The default user avatar content. UnitGroupAvatar(Modifier modifier, List<User> users, Shape shape, TextStyle textStyle, Function0<Unit> onClick)The default group avatar, which renders a matrix of user images or initials. UnitChannelAvatar(Modifier modifier, Channel channel, User currentUser, Function0<Unit> onClick)The default avatar for a channel. UnitChannelMenu(Modifier modifier, Channel selectedChannel, Boolean isMuted, User currentUser, Function1<ChannelAction, Unit> onChannelOptionClick, Function0<Unit> onDismiss)Factory method for creating the full content of the SelectedChannelMenu. UnitChannelMenuHeaderContent(Modifier modifier, Channel selectedChannel, User currentUser)Factory method for creating the header content of the SelectedChannelMenu. UnitChannelMenuCenterContent(Modifier modifier, Function1<ChannelAction, Unit> onChannelOptionClick, List<ChannelOptionState> channelOptions)Factory method for creating the center content of the SelectedChannelMenu. UnitChannelMenuOptions(Modifier modifier, Function1<ChannelAction, Unit> onChannelOptionClick, List<ChannelOptionState> channelOptions)Factory method for creating the options content of the SelectedChannelMenu. UnitChannelOptionsItem(Modifier modifier, ChannelOptionState option, Function0<Unit> onClick)Factory method for creating the footer content of the SelectedChannelMenu. UnitChannelOptionsItemLeadingIcon(Modifier modifier, ChannelOptionState option)Factory method for creating the leading icon of the Channel options menu item. UnitMessageMenu(Modifier modifier, Message message, List<MessageOptionItemState> messageOptions, Set<String> ownCapabilities, Function1<MessageAction, Unit> onMessageAction, Function0<Unit> onShowMore, Function0<Unit> onDismiss)Factory method for creating the full content of the SelectedMessageMenu. UnitMessageMenuCenterContent(Modifier modifier, Message message, List<MessageOptionItemState> messageOptions, Function1<MessageAction, Unit> onMessageAction, Set<String> ownCapabilities)Factory method for creating the center content of the SelectedMessageMenu. UnitMessageMenuHeaderContent(Modifier modifier, Message message, List<MessageOptionItemState> messageOptions, Function1<MessageAction, Unit> onMessageAction, Set<String> ownCapabilities, Function0<Unit> onShowMore, Map<String, ReactionIcon> reactionTypes, Integer showMoreReactionsIcon)Factory method for creating the header content of the SelectedMessageMenu. UnitMessageMenuOptions(Modifier modifier, Message message, List<MessageOptionItemState> options, Function1<MessageOptionItemState, Unit> onMessageOptionSelected)Shows the default message options. UnitMessageMenuOptionsItem(Modifier modifier, MessageOptionItemState option, Function1<MessageOptionItemState, Unit> onMessageOptionSelected)Factory method for creating the options content of the SelectedMessageMenu. UnitMessageMenuOptionsItemLeadingContent(Modifier modifier, MessageOptionItemState option)Factory method for creating the leading icon of the Message options menu item. UnitReactionsMenu(Modifier modifier, User currentUser, Message message, Function1<MessageAction, Unit> onMessageAction, Function0<Unit> onShowMoreReactionsSelected, Set<String> ownCapabilities, Function0<Unit> onDismiss)Factory method for creating the full content of the SelectedReactionsMenu. UnitReactionsMenuHeaderContent(Modifier modifier, Message message, Map<String, ReactionIcon> reactionTypes, Function1<MessageAction, Unit> onMessageAction, Function0<Unit> onShowMoreReactionsSelected, Integer showMoreReactionsIcon)Factory method for creating the header content of the SelectedReactionsMenu. UnitReactionsMenuCenterContent(Modifier modifier, List<UserReactionItemState> userReactions)Factory method for creating the center content of the reactions menu. UnitReactionMenuOptions(Modifier modifier, Message message, Map<String, ReactionIcon> reactionTypes, Function1<MessageAction, Unit> onMessageAction, Function0<Unit> onShowMoreReactionsSelected, Integer showMoreReactionsIcon)Factory method for the reaction options in the menu. UnitReactionMenuOptionItem(Modifier modifier, ReactionOptionItemState option, Function1<ReactionOptionItemState, Unit> onReactionOptionSelected)Factory method for creating the header content of the SelectedReactionsMenu. UnitReactionMenuShowMore(Modifier modifier, Function0<Unit> onShowMoreReactionsSelected, Integer showMoreReactionsIcon)Factory method for creating the reactions menu more option. UnitExtendedReactionsMenuOptions(Modifier modifier, Message message, Map<String, ReactionIcon> reactionTypes, Function1<MessageAction, Unit> onMessageAction)Factory method for creating the center content of the reactions menu. UnitExtendedReactionMenuOptionItem(Modifier modifier, ReactionOptionItemState option, Function1<ReactionOptionItemState, Unit> onReactionOptionSelected)Factory method for creating the header content of the SelectedReactionsMenu. UnitMessageReactionPicker(Modifier modifier, Message message, Function1<MessageAction, Unit> onMessageAction, Function0<Unit> onDismiss)Factory method for creating the reactions menu more option. UnitMessageReactionPickerHeaderContent(Modifier modifier, Message message, Function1<MessageAction, Unit> onMessageAction, Function0<Unit> onDismiss)Factory method for creating the header content of the reaction picker. UnitMessageReactionPickerCenterContent(Modifier modifier, Message message, Function1<MessageAction, Unit> onMessageAction, Map<String, ReactionIcon> reactionTypes, Function0<Unit> onDismiss)Factory method for creating the center content of the reaction picker. UnitMenuOptionItem(Modifier modifier, Function0<Unit> onClick, Function1<RowScope, Unit> leadingIcon, String title, Color titleColor, TextStyle style, Dp itemHeight, Alignment.Vertical verticalAlignment, Arrangement.Horizontal horizontalArrangement)Factory method for creating a generic menu option item. UnitThreadListUnreadThreadsBanner(Integer unreadThreads, Function0<Unit> onClick)The default "Unread threads" banner. UnitThreadListItem(Thread thread, User currentUser, Function1<Thread, Unit> onThreadClick)The default thread list item. UnitThreadListItemTitle(Thread thread, Channel channel, User currentUser)Default representation of the thread title. UnitThreadListItemReplyToContent(RowScope $self, Thread thread)Default representation of the parent message preview in a thread. UnitThreadListItemUnreadCountContent(RowScope $self, Integer unreadCount)Default representation of the unread count badge. UnitThreadListItemLatestReplyContent(Thread thread, User currentUser)Default representation of the latest reply content in a thread. UnitThreadListEmptyContent(Modifier modifier)The default empty placeholder that is displayed when there are no threads. UnitThreadListLoadingContent(Modifier modifier)The default loading content that is displayed during the initial loading of the threads. UnitThreadListLoadingMoreContent()The default content shown on the bottom of the list during the loading of more threads. UnitPinnedMessageListItem(Message message, User currentUser, Function1<Message, Unit> onClick)The default content of the pinned message list item. UnitPinnedMessageListItemLeadingContent(RowScope $self, Message message, User currentUser)The default loading content of the pinned message list. UnitPinnedMessageListItemCenterContent(RowScope $self, Message message, User currentUser)The default loading content of the pinned message list. UnitPinnedMessageListItemTrailingContent(RowScope $self, Message message)The default loading content of the pinned message list. UnitPinnedMessageListItemDivider()The default divider appended after each pinned message. UnitPinnedMessageListEmptyContent(Modifier modifier)The default empty placeholder that is displayed when there are no pinned messages. UnitPinnedMessageListLoadingContent(Modifier modifier)The default loading content that is displayed during the initial loading of the pinned messages. UnitPinnedMessageListLoadingMoreContent()The default content shown on the bottom of the list during the loading of more pinned messages. UnitAttachmentsPickerSendButton(Boolean hasPickedAttachments, Function0<Unit> onClick)The default 'Send' button in the attachments picker. UnitSwipeToReplyContent(RowScope $self)The default content shown when swiping to reply to a message. UnitMentionListItem(LazyItemScope $self, MessageResult mention, Modifier modifier, User currentUser, Function1<Message, Unit> onClick)The default content of a mention list item. UnitMentionListLoadingIndicator(BoxScope $self, Modifier modifier)The default loading indicator that is displayed during the initial loading of the mention list. UnitMentionListEmptyContent(BoxScope $self, Modifier modifier)The default empty placeholder that is displayed when the mention list is empty. UnitMentionListLoadingItem(LazyItemScope $self, Modifier modifier)The default loading indicator that is displayed on the bottom of the list when there are more mentions loading. UnitMentionListPullToRefreshIndicator(BoxScope $self, Modifier modifier, PullToRefreshState pullToRefreshState, Boolean isRefreshing)The default pull-to-refresh indicator for the mention list. UnitFileAttachmentPreviewContent(Modifier modifier, List<Attachment> attachments, Function1<Attachment, Unit> onAttachmentRemoved)Factory method for creating the preview content of file attachments. UnitFileAttachmentContent(Modifier modifier, AttachmentState attachmentState, Function1<Attachment, Boolean> showFileSize, Function2<List<AttachmentPreviewHandler>, Attachment, Unit> onItemClick)Factory method for creating the content of a file attachment. UnitFileAttachmentItem(Modifier modifier, Attachment attachment, Boolean isMine, Function1<Attachment, Boolean> showFileSize)Factory method for creating a file attachment item. UnitFileUploadContent(AttachmentState attachmentState, Modifier modifier, Function2<Attachment, List<AttachmentPreviewHandler>, Unit> onItemClick)The default file upload content used for displaying uploading attachments. UnitFileUploadItem(Attachment attachment, Modifier modifier)Factory method for creating a file upload item that shows an uploading attachment with progress. UnitDirectChannelInfoTopBar(ChannelHeaderViewState headerState, LazyListState listState, Function0<Unit> onNavigationIconClick)Factory method for creating the top bar of the channel info screen. UnitDirectChannelInfoAvatarContainer(User user)Factory method for creating the avatar container in the direct channel info screen. UnitGroupChannelInfoTopBar(ChannelHeaderViewState headerState, ChannelInfoViewState infoState, LazyListState listState, Function0<Unit> onNavigationIconClick, Function0<Unit> onAddMembersClick)Factory method for creating the top bar of the group channel info screen. UnitGroupChannelInfoAddMembersButton(Function0<Unit> onClick)Factory method for creating the "Add members" button of the group channel info screen. UnitChannelInfoSeparatorItem(LazyItemScope $self)Factory method for creating the channel info separator item. UnitChannelInfoOptionItem(LazyItemScope $self, ChannelInfoViewState.Content.Option option, Boolean isGroupChannel, Function1<ChannelInfoViewAction, Unit> onViewAction)Factory method for creating the channel info option item used in direct and group channel info screens. UnitGroupChannelInfoMemberItem(LazyItemScope $self, User currentUser, Member member, Boolean isOwner, Function0<Unit> onClick)Factory method for creating the member item in the group channel info screen. UnitGroupChannelInfoExpandMembersItem(LazyItemScope $self, Integer collapsedCount, Function0<Unit> onClick)Factory method for creating the expand members item in the group channel info screen. UnitChannelInfoScreenModal(ChannelInfoViewEvent.Modal modal, Boolean isGroupChannel, Function1<ChannelInfoViewAction, Unit> onViewAction, Function1<ChannelInfoMemberViewEvent, Unit> onMemberViewEvent, Function0<Unit> onDismiss)Factory method for creating the channel info screen modal. UnitChannelInfoMemberInfoModalSheetTopBar(Member member)Factory method for creating the top bar of the member info modal sheet in the group channel info screen. UnitChannelInfoMemberOptionItem(LazyItemScope $self, ChannelInfoMemberViewState.Content.Option option, Function1<ChannelInfoMemberViewAction, Unit> onViewAction)Factory method for creating the channel info member option item. UnitChannelFilesAttachmentsTopBar(LazyListState listState, Function0<Unit> onNavigationIconClick)Factory method for creating the top bar of the channel files attachments screen. UnitChannelFilesAttachmentsLoadingIndicator(Modifier modifier)Factory method for creating the loading indicator of the channel files attachments screen. UnitChannelFilesAttachmentsEmptyContent(BoxScope $self, Modifier modifier)Factory method for creating the empty content of the channel files attachments screen. UnitChannelFilesAttachmentsErrorContent(BoxScope $self, Modifier modifier)UnitChannelFilesAttachmentsHeaderItem(LazyItemScope $self, Modifier modifier, String label)Factory method for creating the channel files attachments header item. UnitChannelFilesAttachmentsItem(LazyItemScope $self, Modifier modifier, Integer index, ChannelAttachmentsViewState.Content.Item item, User currentUser, Function0<Unit> onClick)Factory method for creating the channel files attachments item. UnitChannelFilesAttachmentsItemDivider(LazyItemScope $self, Modifier modifier, Integer index)Factory method for creating a divider between channel files attachments items. UnitChannelFilesAttachmentsLoadingItem(LazyItemScope $self, Modifier modifier)Factory method for creating the loading item in the channel files attachments list. UnitChannelMediaAttachmentsTopBar(LazyGridState gridState, Function0<Unit> onNavigationIconClick)Factory method for creating the top bar of the channel media attachments screen. UnitChannelMediaAttachmentsLoadingIndicator(Modifier modifier)Factory method for creating the loading indicator of the channel media attachments screen. UnitChannelMediaAttachmentsEmptyContent(BoxScope $self, Modifier modifier)Factory method for creating the empty content of the channel media attachments screen. UnitChannelMediaAttachmentsErrorContent(BoxScope $self, Modifier modifier)UnitChannelMediaAttachmentsFloatingHeader(BoxScope $self, Modifier modifier, String label)Factory method for creating the channel media attachments floating header. UnitChannelMediaAttachmentsItem(LazyGridItemScope $self, Modifier modifier, Integer index, ChannelAttachmentsViewState.Content.Item item, Function0<Unit> onClick)Factory method for creating the channel media attachments item. UnitChannelMediaAttachmentsLoadingItem(LazyGridItemScope $self, Modifier modifier)Factory method for creating the loading item in the channel media attachments list. UnitChannelMediaAttachmentsPreviewTopBar(ChannelAttachmentsViewState.Content.Item item, Function0<Unit> onNavigationIconClick)Factory method for creating the top bar of the channel media attachments preview screen. UnitChannelMediaAttachmentsPreviewTopBarTitle(ChannelAttachmentsViewState.Content.Item item)Factory method for creating the title of the channel media attachments preview top bar. UnitChannelMediaAttachmentsPreviewBottomBar(String text)Factory method for creating the bottom bar of the channel media attachments preview screen. UnitChannelMediaAttachmentsPreviewBottomBar(ChannelMediaAttachmentsPreviewBottomBarParams params)Factory method for creating the bottom bar of the channel media attachments preview screen. -
-
Method Detail
-
ChannelListHeader
@Composable() Unit ChannelListHeader(Modifier modifier, String title, User currentUser, ConnectionState connectionState, Function1<User, Unit> onAvatarClick, Function0<Unit> onHeaderActionClick)
The default header shown above the channel list. Usually contains the current user's avatar, a title or the connected status, and an action button.
-
ChannelListHeaderLeadingContent
@Composable() Unit ChannelListHeaderLeadingContent(RowScope $self, User currentUser, Function1<User, Unit> onAvatarClick)
The default leading content of the channel list header. Usually the avatar of the current user if it's available.
-
ChannelListHeaderCenterContent
@Composable() Unit ChannelListHeaderCenterContent(RowScope $self, ConnectionState connectionState, String title)
The default center content of the channel list header. Usually shows the title if connectionState is ConnectionState.Connected, a
Disconnectedtext if connectionState is offline, or NetworkLoadingIndicator otherwise.
-
ChannelListHeaderTrailingContent
@Composable() Unit ChannelListHeaderTrailingContent(RowScope $self, Function0<Unit> onHeaderActionClick)
The default trailing content of the channel list header. Usually an action button.
-
ChannelListLoadingIndicator
@Composable() Unit ChannelListLoadingIndicator(Modifier modifier)
The default loading indicator of the channel list, when the initial data is loading.
-
ChannelListEmptyContent
@Composable() Unit ChannelListEmptyContent(Modifier modifier)
The default empty content of the channel list.
-
ChannelListItemContent
@Composable() Unit ChannelListItemContent(LazyItemScope $self, ItemState.ChannelItemState channelItem, User currentUser, Function1<Channel, Unit> onChannelClick, Function1<Channel, Unit> onChannelLongClick)
The default channel list item content.
-
ChannelListHelperContent
@Composable() Unit ChannelListHelperContent(BoxScope $self)
The default helper content of the channel list. It's empty by default and can be used to implement a scroll to top feature.
-
ChannelListLoadingMoreItemContent
@Composable() Unit ChannelListLoadingMoreItemContent(LazyItemScope $self)
The default loading more item, when the next page of the channel list is loading.
-
ChannelListDividerItem
@Composable() Unit ChannelListDividerItem(LazyItemScope $self)
The default divider between channel items.
-
ChannelItemLeadingContent
@Composable() Unit ChannelItemLeadingContent(RowScope $self, ItemState.ChannelItemState channelItem, User currentUser)
The default leading content of the channel item. Usually the avatar that holds an image of the channel or its members.
-
ChannelItemCenterContent
@Composable() Unit ChannelItemCenterContent(RowScope $self, ItemState.ChannelItemState channelItem, User currentUser)
The default center content of the channel item. Usually the name of the channel and the last message.
-
ChannelItemTrailingContent
@Composable() Unit ChannelItemTrailingContent(RowScope $self, ItemState.ChannelItemState channelItem, User currentUser)
The default trailing content of the channel item. Usually information about the last message such as its read state, timestamp, and the number of unread messages.
-
ChannelItemUnreadCountIndicator
@Composable() Unit ChannelItemUnreadCountIndicator(Integer unreadCount, Modifier modifier)
The default unread count indicator in the channel item.
-
ChannelItemReadStatusIndicator
@Composable() Unit ChannelItemReadStatusIndicator(Channel channel, Message message, User currentUser, Modifier modifier)
The default read status indicator in the channel item, weather the last message is sent, pending or read.
-
ChannelListSearchInput
@Composable() Unit ChannelListSearchInput(Modifier modifier, String query, Function0<Unit> onSearchStarted, Function1<String, Unit> onValueChange)
The default search input of the channel list.
- Parameters:
modifier- Modifier for styling.query- Current query string.onSearchStarted- Action invoked when the search starts.onValueChange- Action invoked when the query value changes.
-
SearchInputLeadingIcon
@Composable() Unit SearchInputLeadingIcon(RowScope $self)
The default leading icon of the search input.
Used by ChannelListSearchInput.
-
SearchInputLabel
@Composable() Unit SearchInputLabel()
The default label of the search input.
Used by ChannelListSearchInput.
-
SearchInputClearButton
@Composable() Unit SearchInputClearButton(Function0<Unit> onClick)
The default clear button of the search input.
Used by ChannelListSearchInput.
-
ChannelListEmptySearchContent
@Composable() Unit ChannelListEmptySearchContent(Modifier modifier, String searchQuery)
The default empty search content of the channel list, when there are no matching search results.
-
SearchResultItemContent
@Composable() Unit SearchResultItemContent(LazyItemScope $self, ItemState.SearchResultItemState searchResultItem, User currentUser, Function1<Message, Unit> onSearchResultClick)
The default search result item of the channel list.
-
SearchResultItemLeadingContent
@Composable() Unit SearchResultItemLeadingContent(RowScope $self, ItemState.SearchResultItemState searchResultItem, User currentUser)
The default leading content of a search result item. Shows the avatar of the user who sent the message.
Used by SearchResultItemContent.
- Parameters:
searchResultItem- The search result item.currentUser- The currently logged in user.
-
SearchResultItemCenterContent
@Composable() Unit SearchResultItemCenterContent(RowScope $self, ItemState.SearchResultItemState searchResultItem, User currentUser)
The default center content of a search result item. Shows information about the message and by who and where it was sent.
Used by SearchResultItemContent.
- Parameters:
searchResultItem- The state of the search result item.currentUser- The currently logged in user.
-
SearchResultItemTrailingContent
@Composable() Unit SearchResultItemTrailingContent(RowScope $self, ItemState.SearchResultItemState searchResultItem)
The default trailing content of a search result item. Shows the message timestamp.
Used by SearchResultItemContent.
- Parameters:
searchResultItem- The state of the search result item.
-
MessageListHeader
@Composable() Unit MessageListHeader(Modifier modifier, Channel channel, User currentUser, ConnectionState connectionState, List<User> typingUsers, MessageMode messageMode, Function0<Unit> onBackPressed, Function1<Channel, Unit> onHeaderTitleClick, Function0<Unit> onChannelAvatarClick)
The default header of the message list. Usually a back button as a leading content, the channel title in the top center, the channel information or the connection status in the bottom center, and the channel avatar as the trailing content.
-
MessageListHeaderLeadingContent
@Composable() Unit MessageListHeaderLeadingContent(RowScope $self, Function0<Unit> onBackPressed)
The default leading content of the message list header, which is the back button.
-
MessageListHeaderCenterContent
@Deprecated(message = Use the new version of MessageListHeaderCenterContent with a nullable onClick., replaceWith = @ReplaceWith(imports = {}, expression = MessageListHeaderCenterContent( modifier = modifier, channel = channel, currentUser = currentUser, connectionState = connectionState, typingUsers = typingUsers, messageMode = messageMode, onClick = onHeaderTitleClick, )), level = DeprecationLevel.WARNING)@Composable() Unit MessageListHeaderCenterContent(RowScope $self, Modifier modifier, Channel channel, User currentUser, List<User> typingUsers, MessageMode messageMode, Function1<Channel, Unit> onHeaderTitleClick, ConnectionState connectionState)
The default center content of the message list header. Usually shows the channel title in the top and the channel information or the connection status in the bottom.
-
MessageListHeaderCenterContent
@Composable() Unit MessageListHeaderCenterContent(RowScope $self, Modifier modifier, Channel channel, User currentUser, ConnectionState connectionState, List<User> typingUsers, MessageMode messageMode, Function1<Channel, Unit> onClick)
The default center content of the message list header. Usually shows the channel title in the top and the channel information or the connection status in the bottom.
-
MessageListHeaderTrailingContent
@Composable() Unit MessageListHeaderTrailingContent(RowScope $self, Channel channel, User currentUser, Function0<Unit> onClick)
The default trailing content of the message list header, which is the channel avatar.
-
MessageListBackground
@Composable() Unit MessageListBackground()
The default background of the message list.
-
MessageListLoadingIndicator
@Composable() Unit MessageListLoadingIndicator(Modifier modifier)
The default loading indicator of the message list, when the initial message list is loading.
-
MessageListEmptyContent
@Composable() Unit MessageListEmptyContent(Modifier modifier)
The default empty content of the message list, when the message list is empty.
-
MessageListHelperContent
@Composable() Unit MessageListHelperContent(BoxScope $self, MessageListState messageListState, MessagesLazyListState messagesLazyListState, Function1<Function0<Unit>, Unit> onScrollToBottomClick)
The default helper content of the message list. It handles the scroll-to-bottom and scroll-to-focused message features.
-
ScrollToBottomButton
@Composable() Unit ScrollToBottomButton(Modifier modifier, Boolean visible, Integer count, Function0<Unit> onClick)
The default scroll-to-bottom button shown when the user scrolls away from the bottom of the list.
-
MessageListItemContainer
@Composable() Unit MessageListItemContainer(LazyItemScope $self, MessageListItemState messageListItem, ReactionSorting reactionSorting, Function2<Message, Poll, Unit> onPollUpdated, Function3<Message, Poll, Option, Unit> onCastVote, Function3<Message, Poll, Vote, Unit> onRemoveVote, Function3<Message, Poll, PollSelectionType, Unit> selectPoll, Function1<String, Unit> onClosePoll, Function2<Poll, String, Unit> onAddPollOption, Function1<Message, Unit> onLongItemClick, Function1<Message, Unit> onThreadClick, Function1<Message, Unit> onReactionsClick, Function1<GiphyAction, Unit> onGiphyActionClick, Function1<MediaGalleryPreviewResult, Unit> onMediaGalleryPreviewResult, Function1<Message, Unit> onQuotedMessageClick, Function1<User, Unit> onUserAvatarClick, Function2<Message, String, Unit> onMessageLinkClick, Function1<User, Unit> onUserMentionClick, Function3<Message, Poll, String, Unit> onAddAnswer, Function1<Message, Unit> onReply)
The default message list item container, which renders each MessageListItemState's subtype.
-
messageListItemModifier
@Composable() Modifier messageListItemModifier(LazyItemScope $self)
The default message list item modifier for styling.
Uses
Modifier.animateItemfor fade in/out and placement transitions. The placement animation is disabled while the IME is animating so items don't slide during the keyboard open/close window; it resumes for normal list changes (insertions, deletions, height changes).
-
MessageListLoadingMoreItemContent
@Composable() Unit MessageListLoadingMoreItemContent(LazyItemScope $self)
The default loading more item of the message list, when the next page of messages is loading.
-
MessageListDateSeparatorItemContent
@Composable() Unit MessageListDateSeparatorItemContent(LazyItemScope $self, DateSeparatorItemState dateSeparatorItem)
The default date separator item content of the message list.
-
MessageListUnreadSeparatorItemContent
@Composable() Unit MessageListUnreadSeparatorItemContent(LazyItemScope $self, UnreadSeparatorItemState unreadSeparatorItem)
The default unread separator item content of the message list.
-
MessageListThreadDateSeparatorItemContent
@Composable() Unit MessageListThreadDateSeparatorItemContent(LazyItemScope $self, ThreadDateSeparatorItemState threadDateSeparatorItem)
The default thread date separator item content of the message list.
-
MessageListSystemItemContent
@Composable() Unit MessageListSystemItemContent(LazyItemScope $self, SystemMessageItemState systemMessageItem)
The default system message content of the message list.
-
MessageListModeratedItemContent
@Composable() Unit MessageListModeratedItemContent(LazyItemScope $self, ModeratedMessageItemState moderatedMessageItem)
The default moderated message content of the message list.
-
MessageListTypingIndicatorItemContent
@Composable() Unit MessageListTypingIndicatorItemContent(LazyItemScope $self, TypingItemState typingItem)
The default typing indicator content of the message list.
-
MessageListEmptyThreadPlaceholderItemContent
@Composable() Unit MessageListEmptyThreadPlaceholderItemContent(LazyItemScope $self, EmptyThreadPlaceholderItemState emptyThreadPlaceholderItem)
The default empty thread placeholder item content of the message list.
-
MessageListStartOfTheChannelItemContent
@Composable() Unit MessageListStartOfTheChannelItemContent(LazyItemScope $self, StartOfTheChannelItemState startOfTheChannelItem)
The default start of the channel item content of the message list.
-
MessageListItemContent
@Composable() Unit MessageListItemContent(LazyItemScope $self, MessageItemState messageItem, ReactionSorting reactionSorting, Function2<Message, Poll, Unit> onPollUpdated, Function3<Message, Poll, Option, Unit> onCastVote, Function3<Message, Poll, Vote, Unit> onRemoveVote, Function3<Message, Poll, PollSelectionType, Unit> selectPoll, Function1<String, Unit> onClosePoll, Function2<Poll, String, Unit> onAddPollOption, Function1<Message, Unit> onLongItemClick, Function1<Message, Unit> onThreadClick, Function1<Message, Unit> onReactionsClick, Function1<GiphyAction, Unit> onGiphyActionClick, Function1<MediaGalleryPreviewResult, Unit> onMediaGalleryPreviewResult, Function1<Message, Unit> onQuotedMessageClick, Function1<User, Unit> onUserAvatarClick, Function2<Message, String, Unit> onMessageLinkClick, Function1<User, Unit> onUserMentionClick, Function3<Message, Poll, String, Unit> onAddAnswer, Function1<Message, Unit> onReply)
The default item content of a regular message.
-
MessageBubble
@Composable() Unit MessageBubble(Modifier modifier, Message message, Color color, Shape shape, BorderStroke border, PaddingValues contentPadding, Function0<Unit> content)
The default appearance of the message bubble.
- Parameters:
modifier- Prepared Modifier for styling.message- The Message to be rendered inside the bubble.color- The color of the message bubble.shape- The shape of the message bubble.border- The border of the message bubble.contentPadding- The padding of the message bubble.content- The content shown inside the message bubble.
-
MessageFailedIcon
@Composable() Unit MessageFailedIcon(Modifier modifier, Message message)
Icon shown at the bottom-end of a Message when it failed to send.
- Parameters:
modifier- Prepared Modifier for styling.message- The Message that failed to send.
-
MessageItemHeaderContent
@Composable() Unit MessageItemHeaderContent(ColumnScope $self, MessageItemState messageItem, ReactionSorting reactionSorting, Function1<Message, Unit> onReactionsClick)
The default header content of the message item. Usually shown if the message is pinned and a list of reactions for the message.
-
MessageItemFooterContent
@Composable() Unit MessageItemFooterContent(ColumnScope $self, MessageItemState messageItem)
The default footer content of the message item. Usually showing some of the following UI elements: upload status, thread participants, message timestamp.
-
MessageItemLeadingContent
@Composable() Unit MessageItemLeadingContent(RowScope $self, MessageItemState messageItem, Function0<Unit> onUserAvatarClick)
The default leading content of the message item. Usually the avatar of the user if the message doesn't belong to the current user.
-
MessageItemCenterContent
@Composable() Unit MessageItemCenterContent(ColumnScope $self, MessageItemState messageItem, Function1<Message, Unit> onLongItemClick, Function2<Message, Poll, Unit> onPollUpdated, Function3<Message, Poll, Option, Unit> onCastVote, Function3<Message, Poll, Vote, Unit> onRemoveVote, Function3<Message, Poll, PollSelectionType, Unit> selectPoll, Function3<Message, Poll, String, Unit> onAddAnswer, Function1<String, Unit> onClosePoll, Function2<Poll, String, Unit> onAddPollOption, Function1<GiphyAction, Unit> onGiphyActionClick, Function1<Message, Unit> onQuotedMessageClick, Function2<Message, String, Unit> onLinkClick, Function1<User, Unit> onUserMentionClick, Function1<MediaGalleryPreviewResult, Unit> onMediaGalleryPreviewResult)
The default center content of the message item. Usually a message bubble with attachments or emoji stickers if the message contains only emoji.
-
MessageItemTrailingContent
@Composable() Unit MessageItemTrailingContent(RowScope $self, MessageItemState messageItem)
The default trailing content of the message item. Usually an extra spacing at the end of the message item if the author is the current user.
-
MessageReactionList
@Composable() Unit MessageReactionList(MessageReactionListParams params)
The default list of reactions displayed above the message bubble and is part of MessageItemHeaderContent.
-
MessageReactionItem
@Composable() Unit MessageReactionItem(RowScope $self, MessageReactionItemParams params)
The default individual reaction item shown inside MessageReactionList.
-
MessageGiphyContent
@Composable() Unit MessageGiphyContent(Message message, User currentUser, Function1<GiphyAction, Unit> onGiphyActionClick)
The default Giphy message content.
-
MessageDeletedContent
@Composable() Unit MessageDeletedContent(Modifier modifier)
The default content of a deleted message.
-
MessageRegularContent
@Composable() Unit MessageRegularContent(Message message, User currentUser, Function1<Message, Unit> onLongItemClick, Function1<MediaGalleryPreviewResult, Unit> onMediaGalleryPreviewResult, Function1<Message, Unit> onQuotedMessageClick, Function1<User, Unit> onUserMentionClick, Function2<Message, String, Unit> onLinkClick)
The default content of a regular message that can contain attachments and text.
-
MessageTextContent
@Composable() Unit MessageTextContent(Message message, User currentUser, Function1<Message, Unit> onLongItemClick, Function2<Message, String, Unit> onLinkClick, Function1<User, Unit> onUserMentionClick)
The default message text content. Usually with extra styling and padding for the chat bubble.
-
MessageQuotedContent
@Composable() Unit MessageQuotedContent(Modifier modifier, Message message, User currentUser, Message replyMessage, Function1<Message, Unit> onLongItemClick, Function1<Message, Unit> onQuotedMessageClick)
The default quoted message content. Usually shows only the sender avatar, text and a single attachment preview.
-
MessageFooterUploadingContent
@Composable() Unit MessageFooterUploadingContent(Modifier modifier, MessageItemState messageItem)
The default uploading content of the message footer. Usually shows how many items have been uploaded and the total number of items.
-
MessageFooterOnlyVisibleToYouContent
@Composable() Unit MessageFooterOnlyVisibleToYouContent(MessageItemState messageItem)
The default content of the only-visible-to-you footer message.
-
MessageFooterContent
@Composable() Unit MessageFooterContent(MessageItemState messageItem)
The default footer content. Usually contains either MessageThreadFooter or the default footer, which holds the sender name and the timestamp.
-
MessageFooterStatusIndicator
@Deprecated(message = Use the new version of MessageFooterStatusIndicator that takes MessageFooterStatusIndicatorParams., replaceWith = @ReplaceWith(imports = {}, expression = MessageFooterStatusIndicator( params = MessageFooterStatusIndicatorParams( modifier = modifier, messageItem = messageItem, ), )), level = DeprecationLevel.WARNING)@Composable() Unit MessageFooterStatusIndicator(Modifier modifier, Message message, Boolean isMessageRead, Integer readCount)
The default read status indicator in the message footer, weather the message is sent, pending or read.
-
MessageFooterStatusIndicator
@Composable() Unit MessageFooterStatusIndicator(MessageFooterStatusIndicatorParams params)
-
MessageComposer
@Composable() Unit MessageComposer(MessageComposerState messageComposerState, Function2<String, List<Attachment>, Unit> onSendMessage, Modifier modifier, Function0<Unit> onAttachmentsClick, Function0<Unit> onCommandsClick, Function1<String, Unit> onValueChange, Function1<Attachment, Unit> onAttachmentRemoved, Function0<Unit> onCancelAction, Function1<LinkPreview, Unit> onLinkPreviewClick, Function1<User, Unit> onMentionSelected, Function1<Command, Unit> onCommandSelected, Function1<Boolean, Unit> onAlsoSendToChannelSelected, AudioRecordingActions recordingActions, Function2<ColumnScope, MessageComposerState, Unit> headerContent, Function2<ColumnScope, MessageComposerState, Unit> footerContent, Function1<List<User>, Unit> mentionPopupContent, Function1<List<Command>, Unit> commandPopupContent, Function2<RowScope, MessageComposerState, Unit> integrations, Function1<MessageComposerState, Unit> label, Function2<RowScope, MessageComposerState, Unit> input, Function2<RowScope, MessageComposerState, Unit> audioRecordingContent, Function1<MessageComposerState, Unit> trailingContent)
The default message composer that contains the message input, attachments, commands, recording actions, integrations, and the send button.
-
MessageComposerHeaderContent
@Composable() Unit MessageComposerHeaderContent(ColumnScope $self, MessageComposerState state, Function0<Unit> onCancel, Function1<LinkPreview, Unit> onLinkPreviewClick)
The default header content of the message composer. Shown on top of the composer and contains additional info/context, and is shown during editing/replying to a message, or when there is a link pasted in the composer.
- Parameters:
state- The current state of the message composer.onCancel- The action to perform when the cancel button is clicked.onLinkPreviewClick- The action to perform when the link preview is clicked.
-
MessageComposerMessageInputOptions
@Composable() Unit MessageComposerMessageInputOptions(Modifier modifier, MessageAction activeAction, Function0<Unit> onCancel)
The default options header for the message input component. It is based on the currently active message action - io.getstream.chat.android.ui.common.state.messages.Reply or io.getstream.chat.android.ui.common.state.messages.Edit. It shows a heading based on the action and a cancel button to cancel the action.
Used as part of MessageComposerHeaderContent.
- Parameters:
modifier- The modifier to apply to the composable.activeAction- The currently active message action.onCancel- The action to perform when the cancel button is clicked.
-
MessageComposerLinkPreview
@Composable() Unit MessageComposerLinkPreview(Modifier modifier, LinkPreview linkPreview, Function1<LinkPreview, Unit> onClick)
Shows a preview of the link that the user has entered in the message composer. Shows the link image preview, the title of the link and its description.
Used as part of MessageComposerHeaderContent.
- Parameters:
modifier- The modifier to apply to the composable.linkPreview- The link preview to show.onClick- The action to perform when the link preview is clicked.
-
MessageComposerFooterContent
@Composable() Unit MessageComposerFooterContent(ColumnScope $self, MessageComposerState state, Function1<Boolean, Unit> onAlsoSendToChannelSelected)
The default footer content of the message composer. When replying to a thread, it provides the checkbox to also send the message to the channel.
- Parameters:
state- The current state of the message composer.onAlsoSendToChannelSelected- The action to perform when the "Also send to channel" checkbox is selected.
-
MessageComposerMentionsPopupContent
@Composable() Unit MessageComposerMentionsPopupContent(List<User> mentionSuggestions, Function1<User, Unit> onMentionSelected)
The default mentions popup content of the message composer. Shown when the user types '@' in the composer, and there are available users that can be mentioned.
- Parameters:
mentionSuggestions- The list of mention suggestions to show.onMentionSelected- The action to perform when a mention is selected.
-
MessageComposerMentionSuggestionItem
@Composable() Unit MessageComposerMentionSuggestionItem(User user, Function1<User, Unit> onMentionSelected)
The default mention suggestion item of the message composer.
Used in MessageComposerMentionsPopupContent.
- Parameters:
user- The user for which the suggestion is rendered.onMentionSelected- The action to perform when the mention is selected.
-
MessageComposerMentionSuggestionItemLeadingContent
@Composable() Unit MessageComposerMentionSuggestionItemLeadingContent(RowScope $self, User user)
The default leading content of the mention suggestion item of the message composer.
Used as part of MessageComposerMentionSuggestionItem.
- Parameters:
user- The user for which the leading content is rendered.
-
MessageComposerMentionSuggestionItemCenterContent
@Composable() Unit MessageComposerMentionSuggestionItemCenterContent(RowScope $self, User user)
The default center content of the mention suggestion item of the message composer.
Used as part of MessageComposerMentionSuggestionItem.
- Parameters:
user- The user for which the center content is rendered.
-
MessageComposerMentionSuggestionItemTrailingContent
@Composable() Unit MessageComposerMentionSuggestionItemTrailingContent(RowScope $self, User user)
The default trailing content of the mention suggestion item of the message composer.
Used as part of MessageComposerMentionSuggestionItem.
- Parameters:
user- The user for which the trailing content is rendered.
-
MessageComposerCommandsPopupContent
@Composable() Unit MessageComposerCommandsPopupContent(List<Command> commandSuggestions, Function1<Command, Unit> onCommandSelected)
The default instant commands popup content of the message composer. Shown when the user types '/' in the composer, and there are available commands that can be used, or when the user click the "Commands" button.
- Parameters:
commandSuggestions- The list of command suggestions to show.onCommandSelected- The action to perform when a command is selected.
-
MessageComposerCommandSuggestionItem
@Composable() Unit MessageComposerCommandSuggestionItem(Command command, Function1<Command, Unit> onCommandSelected)
The default command suggestion item of the message composer.
Used in MessageComposerCommandsPopupContent.
- Parameters:
command- The command for which the suggestion is rendered.onCommandSelected- The action to perform when the command is selected.
-
MessageComposerCommandSuggestionItemLeadingContent
@Composable() Unit MessageComposerCommandSuggestionItemLeadingContent(RowScope $self, Command command)
The default leading content of the command suggestion item of the message composer.
Used as part of MessageComposerCommandSuggestionItem.
- Parameters:
command- The command for which the leading content is rendered.
-
MessageComposerCommandSuggestionItemCenterContent
@Composable() Unit MessageComposerCommandSuggestionItemCenterContent(RowScope $self, Modifier modifier, Command command)
The default center content of the command suggestion item of the message composer.
Used as part of MessageComposerCommandSuggestionItem.
- Parameters:
modifier- The modifier to apply to the composable.command- The command for which the center content is rendered.
-
MessageComposerIntegrations
@Composable() Unit MessageComposerIntegrations(RowScope $self, MessageComposerState state, Function0<Unit> onAttachmentsClick, Function0<Unit> onCommandsClick)
The default integrations of the message composer. Provides the "Attachments" and "Commands" buttons shown before the composer.
- Parameters:
state- The current state of the message composer.onAttachmentsClick- The action to perform when the "Attachments" button is clicked.onCommandsClick- The action to perform when the "Commands" button is clicked.
-
MessageComposerAttachmentsButton
@Composable() Unit MessageComposerAttachmentsButton(RowScope $self, Boolean enabled, Function0<Unit> onClick)
The default attachments button of the message composer.
Used as part of MessageComposerIntegrations.
- Parameters:
enabled- Whether the button is enabled.onClick- The action to perform when the button is clicked.
-
MessageComposerCommandsButton
@Composable() Unit MessageComposerCommandsButton(RowScope $self, Boolean hasCommandSuggestions, Boolean enabled, Function0<Unit> onClick)
The default commands button of the message composer.
Used as part of MessageComposerIntegrations.
- Parameters:
hasCommandSuggestions- Whether there are command suggestions available.enabled- Whether the button is enabled.onClick- The action to perform when the button is clicked.
-
MessageComposerLabel
@Composable() Unit MessageComposerLabel(MessageComposerState state)
The default label of the message composer.
Used by MessageComposerInput.
- Parameters:
state- The current state of the message composer.
-
MessageComposerInput
@Composable() Unit MessageComposerInput(RowScope $self, MessageComposerState state, Function1<String, Unit> onInputChanged, Function1<Attachment, Unit> onAttachmentRemoved, Function1<MessageComposerState, Unit> label)
The default input content of the message composer.
- Parameters:
state- The current state of the message composer.onInputChanged- The action to perform when the input changes.onAttachmentRemoved- The action to perform when an attachment is removed.label- The label to show in the composer.
-
MessageComposerQuotedMessage
@Composable() Unit MessageComposerQuotedMessage(Modifier modifier, MessageComposerState state, Message quotedMessage)
The default appearance of a quoted message in the message composer. Shown when the user quotes (replies to) a message in the composer.
Used as part of MessageComposerInput.
- Parameters:
modifier- The modifier to apply to the composable.state- The current state of the message composer.quotedMessage- The message that is being quoted (replied to).
-
MessageComposerTrailingContent
@Composable() Unit MessageComposerTrailingContent(MessageComposerState state, Function2<String, List<Attachment>, Unit> onSendClick, AudioRecordingActions recordingActions)
The default trailing content of the message composer. Contains the "Send" button, and "Audio record" button (if enabled).
- Parameters:
state- The current state of the message composer.onSendClick- The action to perform when the "Send" button is clicked.recordingActions- The actions to control the audio recording.
-
MessageComposerCoolDownIndicator
@Composable() Unit MessageComposerCoolDownIndicator(Modifier modifier, Integer coolDownTime)
The default cooldown indicator of the message composer. Shown when the user is prevented from sending messages due to a cooldown.
Used as part of MessageComposerTrailingContent.
- Parameters:
modifier- The modifier to apply to the composable.coolDownTime- The remaining time until the user can send a message.
-
MessageComposerSendButton
@Composable() Unit MessageComposerSendButton(Boolean enabled, Boolean isInputValid, Function0<Unit> onClick)
The default "Send" button of the message composer.
Used as part of MessageComposerTrailingContent.
- Parameters:
enabled- Whether the button is enabled.isInputValid- Whether the current input in the message composer is valid.onClick- The action to perform when the button is clicked.
-
MessageComposerAudioRecordButton
@Composable() Unit MessageComposerAudioRecordButton(RecordingState state, AudioRecordingActions recordingActions)
The default "Audio record (voice message)" button of the message composer.
Used as part of MessageComposerTrailingContent.
- Parameters:
state- The current state of the recording process.recordingActions- The actions to control the audio recording.
-
MessageComposerAudioRecordingContent
@Composable() Unit MessageComposerAudioRecordingContent(RowScope $self, MessageComposerState state, AudioRecordingActions recordingActions)
Default composable used for displaying audio recording information while audio recording is in progress.
- Parameters:
state- The current state of the message composer.recordingActions- The actions to control the audio recording.
-
Avatar
@Deprecated(message = Use the new Avatar function instead., level = DeprecationLevel.WARNING, replaceWith = @ReplaceWith(imports = {}, expression = Avatar( modifier = modifier, imageUrl = imageUrl, initials = initials, shape = shape, textStyle = textStyle, placeholderPainter = placeholderPainter, errorPlaceholderPainter = errorPlaceholderPainter, contentDescription = contentDescription, initialsAvatarOffset = initialsAvatarOffset, onClick = onClick, )))@Composable() Unit Avatar(Modifier modifier, String imageUrl, String initials, Shape shape, TextStyle textStyle, Painter placeholderPainter, String contentDescription, DpOffset initialsAvatarOffset, Function0<Unit> onClick)
The default avatar, which renders an image from the provided image URL. In case the image URL is empty or there is an error loading the image, it falls back to an image with initials.
-
Avatar
@Composable() Unit Avatar(Modifier modifier, String imageUrl, String initials, Shape shape, TextStyle textStyle, Painter placeholderPainter, Painter errorPlaceholderPainter, String contentDescription, DpOffset initialsAvatarOffset, Function0<Unit> onClick)
The default avatar, which renders an image from the provided image URL. In case the image URL is empty or there is an error loading the image, it falls back to an image with initials.
-
FallbackAvatar
@Composable() Unit FallbackAvatar(String imageUrl, String initials, Modifier modifier, Shape shape, TextStyle textStyle, DpOffset avatarOffset, Function0<Unit> onClick)
The default fallback avatar, which renders initials in a circle. It is used when the image URL is empty or there is an error loading the image.
-
UserAvatar
@Composable() Unit UserAvatar(Modifier modifier, User user, TextStyle textStyle, Boolean showOnlineIndicator, Function1<BoxScope, Unit> onlineIndicator, Function0<Unit> onClick)
The default user avatar content. It renders the User avatar that's shown on the messages screen or in headers of direct messages. If showOnlineIndicator is
trueand the user is online, it uses Avatar to shows an image or their initials.
-
GroupAvatar
@Composable() Unit GroupAvatar(Modifier modifier, List<User> users, Shape shape, TextStyle textStyle, Function0<Unit> onClick)
The default group avatar, which renders a matrix of user images or initials.
-
ChannelAvatar
@Composable() Unit ChannelAvatar(Modifier modifier, Channel channel, User currentUser, Function0<Unit> onClick)
The default avatar for a channel. It renders the Channel avatar that's shown when browsing channels or when you open the messages screen. Based on the state of the Channel and the number of members, it might use Avatar, UserAvatar, or GroupAvatar to show different types of images.
-
ChannelMenu
@Composable() Unit ChannelMenu(Modifier modifier, Channel selectedChannel, Boolean isMuted, User currentUser, Function1<ChannelAction, Unit> onChannelOptionClick, Function0<Unit> onDismiss)
Factory method for creating the full content of the SelectedChannelMenu.
- Parameters:
modifier- The modifier for the menu.selectedChannel- The selected channel.isMuted- Whether the channel is muted.currentUser- The current user.onChannelOptionClick- Callback for when a channel option is clicked.onDismiss- Callback for when the menu is dismissed.
-
ChannelMenuHeaderContent
@Composable() Unit ChannelMenuHeaderContent(Modifier modifier, Channel selectedChannel, User currentUser)
Factory method for creating the header content of the SelectedChannelMenu.
- Parameters:
selectedChannel- The selected channel.currentUser- The current user.
-
ChannelMenuCenterContent
@Composable() Unit ChannelMenuCenterContent(Modifier modifier, Function1<ChannelAction, Unit> onChannelOptionClick, List<ChannelOptionState> channelOptions)
Factory method for creating the center content of the SelectedChannelMenu.
- Parameters:
onChannelOptionClick- Callback for when a channel option is clicked.channelOptions- List of channel options.
-
ChannelMenuOptions
@Composable() Unit ChannelMenuOptions(Modifier modifier, Function1<ChannelAction, Unit> onChannelOptionClick, List<ChannelOptionState> channelOptions)
Factory method for creating the options content of the SelectedChannelMenu.
- Parameters:
onChannelOptionClick- Callback for when a channel option is clicked.channelOptions- List of channel options.
-
ChannelOptionsItem
@Composable() Unit ChannelOptionsItem(Modifier modifier, ChannelOptionState option, Function0<Unit> onClick)
Factory method for creating the footer content of the SelectedChannelMenu.
- Parameters:
modifier- The modifier for the footer.
-
ChannelOptionsItemLeadingIcon
@Composable() Unit ChannelOptionsItemLeadingIcon(Modifier modifier, ChannelOptionState option)
Factory method for creating the leading icon of the Channel options menu item.
- Parameters:
option- The channel option state.
-
MessageMenu
@Composable() Unit MessageMenu(Modifier modifier, Message message, List<MessageOptionItemState> messageOptions, Set<String> ownCapabilities, Function1<MessageAction, Unit> onMessageAction, Function0<Unit> onShowMore, Function0<Unit> onDismiss)
Factory method for creating the full content of the SelectedMessageMenu. This is the menu that appears when a message is long-pressed.
- Parameters:
modifier- The modifier for the menu.message- The selected message.messageOptions- List of message options.ownCapabilities- The capabilities of the current user.onMessageAction- Callback for when a message action is clicked.onDismiss- Callback for when the menu is dismissed.
-
MessageMenuCenterContent
@Composable() Unit MessageMenuCenterContent(Modifier modifier, Message message, List<MessageOptionItemState> messageOptions, Function1<MessageAction, Unit> onMessageAction, Set<String> ownCapabilities)
Factory method for creating the center content of the SelectedMessageMenu.
- Parameters:
modifier- The modifier for the center content.message- The selected message.messageOptions- List of message options.ownCapabilities- The capabilities of the current user.
-
MessageMenuHeaderContent
@Composable() Unit MessageMenuHeaderContent(Modifier modifier, Message message, List<MessageOptionItemState> messageOptions, Function1<MessageAction, Unit> onMessageAction, Set<String> ownCapabilities, Function0<Unit> onShowMore, Map<String, ReactionIcon> reactionTypes, Integer showMoreReactionsIcon)
Factory method for creating the header content of the SelectedMessageMenu.
- Parameters:
message- The selected message.messageOptions- List of message options.onMessageAction- Callback for when a message action is clicked.ownCapabilities- The capabilities of the current user.onShowMore- Callback for when the show more reactions option is clicked.reactionTypes- The reaction types.showMoreReactionsIcon- The icon to show for the "Show more reactions" option.
-
MessageMenuOptions
@Composable() Unit MessageMenuOptions(Modifier modifier, Message message, List<MessageOptionItemState> options, Function1<MessageOptionItemState, Unit> onMessageOptionSelected)
Shows the default message options.
- Parameters:
modifier- The modifier for the message options.options- The list of message options.
-
MessageMenuOptionsItem
@Composable() Unit MessageMenuOptionsItem(Modifier modifier, MessageOptionItemState option, Function1<MessageOptionItemState, Unit> onMessageOptionSelected)
Factory method for creating the options content of the SelectedMessageMenu.
-
MessageMenuOptionsItemLeadingContent
@Composable() Unit MessageMenuOptionsItemLeadingContent(Modifier modifier, MessageOptionItemState option)
Factory method for creating the leading icon of the Message options menu item. This is the icon that appears on the left side of the message option.
- Parameters:
option- The message option state.
-
ReactionsMenu
@Composable() Unit ReactionsMenu(Modifier modifier, User currentUser, Message message, Function1<MessageAction, Unit> onMessageAction, Function0<Unit> onShowMoreReactionsSelected, Set<String> ownCapabilities, Function0<Unit> onDismiss)
Factory method for creating the full content of the SelectedReactionsMenu.
- Parameters:
modifier- The modifier for the menu.currentUser- The current user.message- The selected message.onMessageAction- Callback for when a message action is clicked.ownCapabilities- The capabilities of the current user.onDismiss- Callback for when the menu is dismissed.
-
ReactionsMenuHeaderContent
@Composable() Unit ReactionsMenuHeaderContent(Modifier modifier, Message message, Map<String, ReactionIcon> reactionTypes, Function1<MessageAction, Unit> onMessageAction, Function0<Unit> onShowMoreReactionsSelected, Integer showMoreReactionsIcon)
Factory method for creating the header content of the SelectedReactionsMenu.
- Parameters:
message- The selected message.reactionTypes- The reaction types.onMessageAction- Callback for when a message action is clicked.onShowMoreReactionsSelected- Callback for when the show more reactions option is clicked.
-
ReactionsMenuCenterContent
@Composable() Unit ReactionsMenuCenterContent(Modifier modifier, List<UserReactionItemState> userReactions)
Factory method for creating the center content of the reactions menu.
- Parameters:
modifier- The modifier for the center content.userReactions- The user reactions.
-
ReactionMenuOptions
@Composable() Unit ReactionMenuOptions(Modifier modifier, Message message, Map<String, ReactionIcon> reactionTypes, Function1<MessageAction, Unit> onMessageAction, Function0<Unit> onShowMoreReactionsSelected, Integer showMoreReactionsIcon)
Factory method for the reaction options in the menu.
- Parameters:
message- The selected message.reactionTypes- The reaction types.onMessageAction- Callback for when a message action is clicked.onShowMoreReactionsSelected- Callback for when the show more reactions option is clicked.
-
ReactionMenuOptionItem
@Composable() Unit ReactionMenuOptionItem(Modifier modifier, ReactionOptionItemState option, Function1<ReactionOptionItemState, Unit> onReactionOptionSelected)
Factory method for creating the header content of the SelectedReactionsMenu.
- Parameters:
modifier- The modifier for the header.option- the reaction option.onReactionOptionSelected- Callback for when a reaction option is clicked.
-
ReactionMenuShowMore
@Composable() Unit ReactionMenuShowMore(Modifier modifier, Function0<Unit> onShowMoreReactionsSelected, Integer showMoreReactionsIcon)
Factory method for creating the reactions menu more option.
- Parameters:
onShowMoreReactionsSelected- Callback for when the show more reactions option is clicked.showMoreReactionsIcon- The icon for the show more reactions option.
-
ExtendedReactionsMenuOptions
@Composable() Unit ExtendedReactionsMenuOptions(Modifier modifier, Message message, Map<String, ReactionIcon> reactionTypes, Function1<MessageAction, Unit> onMessageAction)
Factory method for creating the center content of the reactions menu.
- Parameters:
modifier- The modifier for the center content.message- The selected message.
-
ExtendedReactionMenuOptionItem
@Composable() Unit ExtendedReactionMenuOptionItem(Modifier modifier, ReactionOptionItemState option, Function1<ReactionOptionItemState, Unit> onReactionOptionSelected)
Factory method for creating the header content of the SelectedReactionsMenu.
- Parameters:
modifier- The modifier for the header.option- the reaction option.onReactionOptionSelected- Callback for when a reaction option is clicked.
-
MessageReactionPicker
@Composable() Unit MessageReactionPicker(Modifier modifier, Message message, Function1<MessageAction, Unit> onMessageAction, Function0<Unit> onDismiss)
Factory method for creating the reactions menu more option.
- Parameters:
modifier- The modifiermessage- The selected message.onMessageAction- Callback for when a message action is clicked.onDismiss- Callback for when the menu is dismissed.
-
MessageReactionPickerHeaderContent
@Composable() Unit MessageReactionPickerHeaderContent(Modifier modifier, Message message, Function1<MessageAction, Unit> onMessageAction, Function0<Unit> onDismiss)
Factory method for creating the header content of the reaction picker.
@param modifier The modifier
- Parameters:
message- The selected message.onMessageAction- Callback for when a message action is clicked.onDismiss- Callback for when the menu is dismissed.
-
MessageReactionPickerCenterContent
@Composable() Unit MessageReactionPickerCenterContent(Modifier modifier, Message message, Function1<MessageAction, Unit> onMessageAction, Map<String, ReactionIcon> reactionTypes, Function0<Unit> onDismiss)
Factory method for creating the center content of the reaction picker.
- Parameters:
modifier- The modifiermessage- The selected message.onMessageAction- Callback for when a message action is clicked.reactionTypes- The reaction types.onDismiss- Callback for when the menu is dismissed.
-
MenuOptionItem
@Composable() Unit MenuOptionItem(Modifier modifier, Function0<Unit> onClick, Function1<RowScope, Unit> leadingIcon, String title, Color titleColor, TextStyle style, Dp itemHeight, Alignment.Vertical verticalAlignment, Arrangement.Horizontal horizontalArrangement)
Factory method for creating a generic menu option item.
- Parameters:
modifier- The modifier for the menu item.onClick- Callback for when the menu item is clicked.leadingIcon- The leading icon of the menu item.title- The title of the menu item.titleColor- The color of the title.
-
ThreadListUnreadThreadsBanner
@Composable() Unit ThreadListUnreadThreadsBanner(Integer unreadThreads, Function0<Unit> onClick)
The default "Unread threads" banner. Shows the number of unread threads in the "ThreadList".
- Parameters:
unreadThreads- The number of unread threads.onClick- Action invoked when the user clicks on the banner.
-
ThreadListItem
@Composable() Unit ThreadListItem(Thread thread, User currentUser, Function1<Thread, Unit> onThreadClick)
The default thread list item. Shows information about the Thread title, parent message, last reply and number of unread replies.
- Parameters:
thread- The thread to display.currentUser- The current user.onThreadClick- Action invoked when the user clicks on the thread.
-
ThreadListItemTitle
@Composable() Unit ThreadListItemTitle(Thread thread, Channel channel, User currentUser)
Default representation of the thread title.
Used in the ThreadListItem to display the title of the thread.
- Parameters:
thread- The thread to display.channel- The channel the thread belongs to.currentUser- The current user.
-
ThreadListItemReplyToContent
@Composable() Unit ThreadListItemReplyToContent(RowScope $self, Thread thread)
Default representation of the parent message preview in a thread.
Used in the ThreadListItem to display the parent message of the thread.
- Parameters:
thread- The thread to display.
-
ThreadListItemUnreadCountContent
@Composable() Unit ThreadListItemUnreadCountContent(RowScope $self, Integer unreadCount)
Default representation of the unread count badge. Not shown if unreadCount == 0.
Used in the ThreadListItem to display the number of unread replies in the thread.
- Parameters:
unreadCount- The number of unread thread replies.
-
ThreadListItemLatestReplyContent
@Composable() Unit ThreadListItemLatestReplyContent(Thread thread, User currentUser)
Default representation of the latest reply content in a thread. Shows a preview of the last message in the thread.
Used in the ThreadListItem to display the latest reply in the thread.
- Parameters:
thread- The thread to display.currentUser- The currently logged-in user.
-
ThreadListEmptyContent
@Composable() Unit ThreadListEmptyContent(Modifier modifier)
The default empty placeholder that is displayed when there are no threads.
- Parameters:
modifier- Modifier for styling.
-
ThreadListLoadingContent
@Composable() Unit ThreadListLoadingContent(Modifier modifier)
The default loading content that is displayed during the initial loading of the threads.
- Parameters:
modifier- Modifier for styling.
-
ThreadListLoadingMoreContent
@Composable() Unit ThreadListLoadingMoreContent()
The default content shown on the bottom of the list during the loading of more threads.
-
PinnedMessageListItem
@Composable() Unit PinnedMessageListItem(Message message, User currentUser, Function1<Message, Unit> onClick)
The default content of the pinned message list item.
- Parameters:
message- The pinned message to display.currentUser- The current user.onClick- Action invoked when the user clicks on the pinned message.
-
PinnedMessageListItemLeadingContent
@Composable() Unit PinnedMessageListItemLeadingContent(RowScope $self, Message message, User currentUser)
The default loading content of the pinned message list. Shows an avatar of the user who sent the pinned message.
Used in the PinnedMessageListItem.
- Parameters:
message- The pinned message to display.currentUser- The currently logged-in user.
-
PinnedMessageListItemCenterContent
@Composable() Unit PinnedMessageListItemCenterContent(RowScope $self, Message message, User currentUser)
The default loading content of the pinned message list. Shows the message sender name and the message content.
Used in the PinnedMessageListItem.
- Parameters:
message- The pinned message to display.currentUser- The current user.
-
PinnedMessageListItemTrailingContent
@Composable() Unit PinnedMessageListItemTrailingContent(RowScope $self, Message message)
The default loading content of the pinned message list. Shows the message timestamp.
Used in the PinnedMessageListItem.
- Parameters:
message- The pinned message to display.
-
PinnedMessageListItemDivider
@Composable() Unit PinnedMessageListItemDivider()
The default divider appended after each pinned message.
-
PinnedMessageListEmptyContent
@Composable() Unit PinnedMessageListEmptyContent(Modifier modifier)
The default empty placeholder that is displayed when there are no pinned messages.
- Parameters:
modifier- Modifier for styling.
-
PinnedMessageListLoadingContent
@Composable() Unit PinnedMessageListLoadingContent(Modifier modifier)
The default loading content that is displayed during the initial loading of the pinned messages.
- Parameters:
modifier- Modifier for styling.
-
PinnedMessageListLoadingMoreContent
@Composable() Unit PinnedMessageListLoadingMoreContent()
The default content shown on the bottom of the list during the loading of more pinned messages.
-
AttachmentsPickerSendButton
@Composable() Unit AttachmentsPickerSendButton(Boolean hasPickedAttachments, Function0<Unit> onClick)
The default 'Send' button in the attachments picker. Shown as ">" icon in the attachments picker header, enabled when there is at least one selected attachment.
- Parameters:
hasPickedAttachments- If there are any attachments picked.onClick- The click handler for the button.
-
SwipeToReplyContent
@Composable() Unit SwipeToReplyContent(RowScope $self)
The default content shown when swiping to reply to a message.
-
MentionListItem
@Composable() Unit MentionListItem(LazyItemScope $self, MessageResult mention, Modifier modifier, User currentUser, Function1<Message, Unit> onClick)
The default content of a mention list item.
-
MentionListLoadingIndicator
@Composable() Unit MentionListLoadingIndicator(BoxScope $self, Modifier modifier)
The default loading indicator that is displayed during the initial loading of the mention list.
- Parameters:
modifier- Modifier for styling.
-
MentionListEmptyContent
@Composable() Unit MentionListEmptyContent(BoxScope $self, Modifier modifier)
The default empty placeholder that is displayed when the mention list is empty.
- Parameters:
modifier- Modifier for styling.
-
MentionListLoadingItem
@Composable() Unit MentionListLoadingItem(LazyItemScope $self, Modifier modifier)
The default loading indicator that is displayed on the bottom of the list when there are more mentions loading.
-
MentionListPullToRefreshIndicator
@Composable() Unit MentionListPullToRefreshIndicator(BoxScope $self, Modifier modifier, PullToRefreshState pullToRefreshState, Boolean isRefreshing)
The default pull-to-refresh indicator for the mention list.
- Parameters:
modifier- Modifier for styling.pullToRefreshState- The state of the pull-to-refresh.isRefreshing- Whether the mention list is currently refreshing.
-
FileAttachmentPreviewContent
@Composable() Unit FileAttachmentPreviewContent(Modifier modifier, List<Attachment> attachments, Function1<Attachment, Unit> onAttachmentRemoved)
Factory method for creating the preview content of file attachments.
- Parameters:
modifier- Modifier for styling.attachments- List of file attachments to preview.onAttachmentRemoved- Lambda invoked when an attachment is removed.
-
FileAttachmentContent
@Composable() Unit FileAttachmentContent(Modifier modifier, AttachmentState attachmentState, Function1<Attachment, Boolean> showFileSize, Function2<List<AttachmentPreviewHandler>, Attachment, Unit> onItemClick)
Factory method for creating the content of a file attachment.
- Parameters:
modifier- Modifier for styling the composable.attachmentState- The state of the attachment, containing information about the file.showFileSize- A lambda function that determines whether the file size should be displayed.onItemClick- A lambda function invoked when the file attachment is clicked, providing a list of AttachmentPreviewHandler and the clicked Attachment.
-
FileAttachmentItem
@Composable() Unit FileAttachmentItem(Modifier modifier, Attachment attachment, Boolean isMine, Function1<Attachment, Boolean> showFileSize)
Factory method for creating a file attachment item.
- Parameters:
modifier- Modifier for styling.attachment- The file attachment to show.isMine- Whether the message is sent by the current user or not.showFileSize- Whether to show the file size or not.
-
FileUploadContent
@Composable() Unit FileUploadContent(AttachmentState attachmentState, Modifier modifier, Function2<Attachment, List<AttachmentPreviewHandler>, Unit> onItemClick)
The default file upload content used for displaying uploading attachments.
- Parameters:
attachmentState- The state of the attachment.modifier- Modifier for styling.onItemClick- Lambda called when an item gets clicked.
-
FileUploadItem
@Composable() Unit FileUploadItem(Attachment attachment, Modifier modifier)
Factory method for creating a file upload item that shows an uploading attachment with progress.
- Parameters:
attachment- The attachment that's being uploaded.modifier- Modifier for styling.
-
DirectChannelInfoTopBar
@Composable() Unit DirectChannelInfoTopBar(ChannelHeaderViewState headerState, LazyListState listState, Function0<Unit> onNavigationIconClick)
Factory method for creating the top bar of the channel info screen.
- Parameters:
headerState- The state of the channel header.listState- The state of the lazy list.onNavigationIconClick- Callback invoked when the navigation icon is clicked.
-
DirectChannelInfoAvatarContainer
@Composable() Unit DirectChannelInfoAvatarContainer(User user)
Factory method for creating the avatar container in the direct channel info screen.
- Parameters:
user- The user whose avatar is displayed.
-
GroupChannelInfoTopBar
@Composable() Unit GroupChannelInfoTopBar(ChannelHeaderViewState headerState, ChannelInfoViewState infoState, LazyListState listState, Function0<Unit> onNavigationIconClick, Function0<Unit> onAddMembersClick)
Factory method for creating the top bar of the group channel info screen.
- Parameters:
headerState- The state of the channel header.infoState- The state of the channel info.listState- The state of the lazy list.onNavigationIconClick- Callback invoked when the navigation icon is clicked.onAddMembersClick- Callback invoked when the "Add members" button is clicked.
-
GroupChannelInfoAddMembersButton
@Composable() Unit GroupChannelInfoAddMembersButton(Function0<Unit> onClick)
Factory method for creating the "Add members" button of the group channel info screen.
- Parameters:
onClick- Callback invoked when button is clicked.
-
ChannelInfoSeparatorItem
@Composable() Unit ChannelInfoSeparatorItem(LazyItemScope $self)
Factory method for creating the channel info separator item. This is used to visually separate different sections in the channel info screens.
-
ChannelInfoOptionItem
@Composable() Unit ChannelInfoOptionItem(LazyItemScope $self, ChannelInfoViewState.Content.Option option, Boolean isGroupChannel, Function1<ChannelInfoViewAction, Unit> onViewAction)
Factory method for creating the channel info option item used in direct and group channel info screens.
- Parameters:
option- The channel info option to display.isGroupChannel- Whether the channel is a group channel.onViewAction- Callback invoked when a view action is triggered.
-
GroupChannelInfoMemberItem
@Composable() Unit GroupChannelInfoMemberItem(LazyItemScope $self, User currentUser, Member member, Boolean isOwner, Function0<Unit> onClick)
Factory method for creating the member item in the group channel info screen.
- Parameters:
currentUser- The currently logged-in user.member- The member to display.isOwner- Whether the member is the owner of the channel.onClick- Callback invoked when the user clicks on the member item.
-
GroupChannelInfoExpandMembersItem
@Composable() Unit GroupChannelInfoExpandMembersItem(LazyItemScope $self, Integer collapsedCount, Function0<Unit> onClick)
Factory method for creating the expand members item in the group channel info screen.
- Parameters:
collapsedCount- The number of members that are currently collapsed.onClick- Callback invoked when the user clicks to expand the member list.
-
ChannelInfoScreenModal
@Composable() Unit ChannelInfoScreenModal(ChannelInfoViewEvent.Modal modal, Boolean isGroupChannel, Function1<ChannelInfoViewAction, Unit> onViewAction, Function1<ChannelInfoMemberViewEvent, Unit> onMemberViewEvent, Function0<Unit> onDismiss)
Factory method for creating the channel info screen modal.
- Parameters:
modal- Which modal to display.isGroupChannel- Whether the channel is a group channel.onViewAction- Callback invoked when a view action is triggered.onMemberViewEvent- Callback invoked when a member view event is triggered.
-
ChannelInfoMemberInfoModalSheetTopBar
@Composable() Unit ChannelInfoMemberInfoModalSheetTopBar(Member member)
Factory method for creating the top bar of the member info modal sheet in the group channel info screen.
- Parameters:
member- The member to display in the top bar.
-
ChannelInfoMemberOptionItem
@Composable() Unit ChannelInfoMemberOptionItem(LazyItemScope $self, ChannelInfoMemberViewState.Content.Option option, Function1<ChannelInfoMemberViewAction, Unit> onViewAction)
Factory method for creating the channel info member option item.
- Parameters:
option- The channel info member option to display.onViewAction- Callback invoked when a view action is triggered.
-
ChannelFilesAttachmentsTopBar
@Composable() Unit ChannelFilesAttachmentsTopBar(LazyListState listState, Function0<Unit> onNavigationIconClick)
Factory method for creating the top bar of the channel files attachments screen.
- Parameters:
listState- The state of the lazy list.onNavigationIconClick- Callback invoked when the navigation icon is clicked.
-
ChannelFilesAttachmentsLoadingIndicator
@Composable() Unit ChannelFilesAttachmentsLoadingIndicator(Modifier modifier)
Factory method for creating the loading indicator of the channel files attachments screen.
-
ChannelFilesAttachmentsEmptyContent
@Composable() Unit ChannelFilesAttachmentsEmptyContent(BoxScope $self, Modifier modifier)
Factory method for creating the empty content of the channel files attachments screen.
-
ChannelFilesAttachmentsErrorContent
@Composable() Unit ChannelFilesAttachmentsErrorContent(BoxScope $self, Modifier modifier)
-
ChannelFilesAttachmentsHeaderItem
@Composable() Unit ChannelFilesAttachmentsHeaderItem(LazyItemScope $self, Modifier modifier, String label)
Factory method for creating the channel files attachments header item. This is typically used to display the title of a group of attachments.
- Parameters:
modifier- The modifier for styling the header item.label- The label for the header item.
-
ChannelFilesAttachmentsItem
@Composable() Unit ChannelFilesAttachmentsItem(LazyItemScope $self, Modifier modifier, Integer index, ChannelAttachmentsViewState.Content.Item item, User currentUser, Function0<Unit> onClick)
Factory method for creating the channel files attachments item.
- Parameters:
modifier- The modifier for styling the item.index- The index of the item in the list.item- The channel file attachment item to display.currentUser- The currently logged-in user.onClick- Callback invoked when the item is clicked.
-
ChannelFilesAttachmentsItemDivider
@Composable() Unit ChannelFilesAttachmentsItemDivider(LazyItemScope $self, Modifier modifier, Integer index)
Factory method for creating a divider between channel files attachments items.
- Parameters:
modifier- The modifier for styling the divider.index- The index of the item in the list.
-
ChannelFilesAttachmentsLoadingItem
@Composable() Unit ChannelFilesAttachmentsLoadingItem(LazyItemScope $self, Modifier modifier)
Factory method for creating the loading item in the channel files attachments list.
This is typically shown at the end of the list when more items are being loaded.
-
ChannelMediaAttachmentsTopBar
@Composable() Unit ChannelMediaAttachmentsTopBar(LazyGridState gridState, Function0<Unit> onNavigationIconClick)
Factory method for creating the top bar of the channel media attachments screen.
- Parameters:
gridState- The state of the lazy grid.onNavigationIconClick- Callback invoked when the navigation icon is clicked.
-
ChannelMediaAttachmentsLoadingIndicator
@Composable() Unit ChannelMediaAttachmentsLoadingIndicator(Modifier modifier)
Factory method for creating the loading indicator of the channel media attachments screen.
-
ChannelMediaAttachmentsEmptyContent
@Composable() Unit ChannelMediaAttachmentsEmptyContent(BoxScope $self, Modifier modifier)
Factory method for creating the empty content of the channel media attachments screen.
-
ChannelMediaAttachmentsErrorContent
@Composable() Unit ChannelMediaAttachmentsErrorContent(BoxScope $self, Modifier modifier)
-
ChannelMediaAttachmentsFloatingHeader
@Composable() Unit ChannelMediaAttachmentsFloatingHeader(BoxScope $self, Modifier modifier, String label)
Factory method for creating the channel media attachments floating header. This is typically used to display the title of a group of attachments.
- Parameters:
modifier- The modifier for styling the floating header.label- The label for the floating item.
-
ChannelMediaAttachmentsItem
@Composable() Unit ChannelMediaAttachmentsItem(LazyGridItemScope $self, Modifier modifier, Integer index, ChannelAttachmentsViewState.Content.Item item, Function0<Unit> onClick)
Factory method for creating the channel media attachments item.
- Parameters:
modifier- The modifier for styling the item.index- The index of the item in the list.item- The channel file attachment item to display.onClick- Callback invoked when the item is clicked.
-
ChannelMediaAttachmentsLoadingItem
@Composable() Unit ChannelMediaAttachmentsLoadingItem(LazyGridItemScope $self, Modifier modifier)
Factory method for creating the loading item in the channel media attachments list.
This is typically shown at the end of the list when more items are being loaded.
-
ChannelMediaAttachmentsPreviewTopBar
@Composable() Unit ChannelMediaAttachmentsPreviewTopBar(ChannelAttachmentsViewState.Content.Item item, Function0<Unit> onNavigationIconClick)
Factory method for creating the top bar of the channel media attachments preview screen.
- Parameters:
item- The item to display in the top bar.onNavigationIconClick- Callback invoked when the navigation icon is clicked.
-
ChannelMediaAttachmentsPreviewTopBarTitle
@Composable() Unit ChannelMediaAttachmentsPreviewTopBarTitle(ChannelAttachmentsViewState.Content.Item item)
Factory method for creating the title of the channel media attachments preview top bar. This displays the message sender's name and the time when the message was sent.
- Parameters:
item- The item containing the message to display in the top bar.
-
ChannelMediaAttachmentsPreviewBottomBar
@Deprecated(message = Use ChannelMediaAttachmentsPreviewBottomBar(params: ChannelMediaAttachmentsPreviewBottomBarParams) instead., replaceWith = @ReplaceWith(imports = {}, expression = ChannelMediaAttachmentsPreviewBottomBar(ChannelMediaAttachmentsPreviewBottomBarParams(centerContent = { Text(text) }))))@Composable() Unit ChannelMediaAttachmentsPreviewBottomBar(String text)
Factory method for creating the bottom bar of the channel media attachments preview screen.
- Parameters:
text- The text to display in the bottom bar.
-
ChannelMediaAttachmentsPreviewBottomBar
@Composable() Unit ChannelMediaAttachmentsPreviewBottomBar(ChannelMediaAttachmentsPreviewBottomBarParams params)
Factory method for creating the bottom bar of the channel media attachments preview screen.
-
-
-
-