Skip to main content

Conversations

New Properties

NameTypeDescription
scrollControllerScrollController?Controller to handle scrolling behavior in the conversations list.
datePaddingEdgeInsets?Provides padding for the date component.
dateHeightdouble?Provides height for the date component.
dateBackgroundIsTransparentbool?Controls the background transparency of the date component.
dateWidthdouble?Provides width for the date component.
badgeWidthdouble?Provides width for the badge component.
badgeHeightdouble?Provides height for the badge component.
badgePaddingEdgeInsetsGeometry?Provides padding for the badge component.
statusIndicatorWidthdouble?Provides width for the status indicator.
statusIndicatorHeightdouble?Provides height for the status indicator.
statusIndicatorBorderRadiusBorderRadiusGeometry?Provides border radius for the status indicator.
avatarMarginEdgeInsetsGeometry?Provides margin for the avatar component.
avatarPaddingEdgeInsetsGeometry?Provides padding for the avatar component.
avatarWidthdouble?Provides width for the avatar component.
avatarHeightdouble?Provides height for the avatar component.
deleteConversationOptionVisibilityboolControls visibility of delete conversation option (default: true).
groupTypeVisibilityboolControls visibility of group type icon (default: true).
setOptionsFunction?Sets custom options for conversation long press actions.
addOptionsFunction?Adds additional options to conversation long press actions.
loadingStateViewWidgetBuilder?Custom widget for loading state view.
leadingViewFunction?Custom widget for leading view of conversation items.
titleViewFunction?Custom widget for title view of conversation items.
controllerTagString?Tag for controller management.
onLoadOnLoad< Conversation >?Callback when conversations are loading.
onEmptyOnEmpty?Callback when conversation list is empty.
submitIconWidget?Custom submit icon for selection mode.
dateTimeFormatterCallbackDateTimeFormatterCallback?Callback for custom date and time formatting.

Renamed Properties

V4 NameV5 NameTypeDescription
conversationsStyleconversationsStyleConversationsStyle → CometChatConversationsStyleStyle configuration (type changed from ConversationsStyle to CometChatConversationsStyle).
tailViewtrailingViewFunction?Custom widget for trailing view of conversation items (renamed from tailView to trailingView).
disableUsersPresenceusersStatusVisibilityboolControls user status visibility (inverted logic: disableUsersPresence=false becomes usersStatusVisibility=true).
hideReceipt/disableReceiptreceiptsVisibilityboolControls receipt visibility (inverted logic: hideReceipt=false becomes receiptsVisibility=true).

Removed Properties

NameTypeDescription
themeCometChatTheme?Theme configuration for the conversations component.
errorStateTextString?Custom text for error state display.
emptyStateTextString?Custom text for empty state display.
stateCallBackFunction?Callback for state changes in the conversations component.
loadingStateTextString?Custom text for loading state display.
optionsFunction?Options configuration for conversation items.
avatarStyleAvatarStyle?Style configuration for avatar components.
statusIndicatorStyleStatusIndicatorStyle?Style configuration for status indicators.
badgeStyleBadgeStyle?Style configuration for badge components.
receiptStyleReceiptStyle?Style configuration for receipt indicators.
hideSeparatorboolControls visibility of separators between conversation items.
dateStyleDateStyle?Style configuration for date components.
disableTypingbool?Controls typing indicator functionality.
deleteConversationDialogStyleConfirmDialogStyle?Style configuration for delete conversation confirmation dialog.
disableMentionsbool?Controls mention functionality in conversations.

Users

New Properties

NameTypeDescription
scrollControllerScrollController?Sets controller for scrolling behavior in the users list.
heightdouble?Provides height to the widget.
widthdouble?Provides width to the widget.
stickyHeaderVisibilityboolHide alphabets used to separate users (default: false).
searchKeywordString?Used to set searchKeyword to fetch initial list with.
onLoadOnLoad< User >?Callback triggered when list is fetched and loaded.
onEmptyOnEmpty?Callback triggered when the list is empty.
setOptionsFunction?Sets list of actions available on the long press of list item.
addOptionsFunction?Adds into the current list of actions available on the long press of list item.
trailingViewWidget? Function(BuildContext, User)?Custom widget for trailing view of each user item.
leadingViewWidget? Function(BuildContext, User)?Custom widget for leading view of each user item.
titleViewWidget? Function(BuildContext, User)?Custom widget for title view of each user item.

Renamed Properties

V4 NameV5 NameTypeDescription
controllerscrollControllerScrollController?Scroll controller for the list (renamed from controller to scrollController).
disableUsersPresenceusersStatusVisibilitybool → boolControls user status visibility (inverted logic: disableUsersPresence=false becomes usersStatusVisibility=true).
hideSectionSeparatorstickyHeaderVisibilitybool → boolControls section separator visibility (inverted logic: hideSectionSeparator=false becomes stickyHeaderVisibility=true).

Removed Properties

NameTypeDescription
themeCometChatTheme?Theme configuration for the users component.
errorStateTextString?Custom text for error state display.
emptyStateTextString?Custom text for empty state display.
stateCallBackFunction?Callback to access controller functions from parent.
hideErrorbool?Toggle visibility of error dialog.
listItemStyleListItemStyle?Style configuration for individual list items.
optionsFunction?Options configuration for user items.
avatarStyleAvatarStyle?Style configuration for avatar components.
statusIndicatorStyleStatusIndicatorStyle?Style configuration for status indicators.
hideSeparatorbool?Toggle visibility of separator between items.
hideSectionSeparatorbool?Toggle visibility of section separators.
selectionIconWidget?Custom selection icon widget.

Groups

New Properties

NameTypeDescription
scrollControllerScrollController?Sets controller for scrolling behavior in the groups list.
heightdouble?Provides height to the widget.
widthdouble?Provides width to the widget.
searchKeywordString?Used to set searchKeyword to fetch initial list with.
onLoadOnLoad< Group >?Callback triggered when list is fetched and loaded.
onEmptyOnEmpty?Callback triggered when the list is empty.
groupTypeVisibilityboolHide the group type icon which is visible on the group icon (default: true).
setOptionsFunction?Sets list of actions available on the long press of list item.
addOptionsFunction?Adds into the current list of actions available on the long press of list item.
trailingViewWidget? Function(BuildContext, Group)?Custom widget for trailing view of each group item.
leadingViewWidget? Function(BuildContext, Group)?Custom widget for leading view of each group item.
titleViewWidget? Function(BuildContext, Group)?Custom widget for title view of each group item.

Renamed Properties

V4 NameV5 NameTypeDescription
controllerscrollControllerScrollController?Scroll controller for the list (renamed from controller to scrollController).

Removed Properties

NameTypeDescription
themeCometChatTheme?Theme configuration for the groups component.
errorStateTextString?Custom text for error state display.
emptyStateTextString?Custom text for empty state display.
listItemStyleListItemStyle?Style configuration for individual list items.
optionsFunction?Options configuration for group items.
avatarStyleAvatarStyle?Style configuration for avatar components.
statusIndicatorStyleStatusIndicatorStyle?Style configuration for status indicators.
hideSeparatorboolToggle visibility of separator between items.
selectionIconWidget?Custom selection icon widget.

Group Members

New Properties

NameTypeDescription
heightdouble?Provides height to the widget.
widthdouble?Provides width to the widget.
controllerTagString?Tag to access the widget’s GetXController.
searchKeywordString?Used to set searchKeyword to fetch initial list with.
onLoadOnLoad< GroupMember >?Callback triggered when list is fetched and loaded.
onEmptyOnEmpty?Callback triggered when the list is empty.
leadingViewWidget? Function(BuildContext, GroupMember)?Custom widget for leading view of each group member item.
titleViewWidget? Function(BuildContext, GroupMember)?Custom widget for title view of each group member item.
usersStatusVisibilityboolHide status indicator of user which is visible on user avatar (default: true).
hideKickMemberOptionbool?Defines whether a member can be kicked or not.
hideBanMemberOptionbool?Defines whether a member can be banned or not.
hideScopeChangeOptionbool?Defines whether a member’s scope can be changed or not.
setOptionsFunction?Sets list of actions available on the long press of list item.
addOptionsFunction?Adds into the current list of actions available on the long press of list item.

Renamed Properties

V4 NameV5 NameTypeDescription
groupMemberStylestyleGroupMembersStyle → CometChatGroupMembersStyleStyle configuration (type changed from GroupMembersStyle to CometChatGroupMembersStyle).
tailViewtrailingViewFunction → FunctionCustom widget for trailing view (renamed from tailView to trailingView).
disableUsersPresenceusersStatusVisibilitybool → boolControls user status visibility (inverted logic: disableUsersPresence=false becomes usersStatusVisibility=true).

Removed Properties

NameTypeDescription
themeCometChatTheme?Theme configuration for the group members component.
titleString?Sets title for the list.
errorStateTextString?Text to be displayed when error occurs.
emptyStateTextString?Text to be displayed when the list is empty.
listItemStyleListItemStyle?Style configuration for individual list items.
avatarStyleAvatarStyle?Style configuration for avatar components.
statusIndicatorStyleStatusIndicatorStyle?Style configuration for status indicator.
groupScopeStyleGroupScopeStyle?Styling properties for group scope (integrated into main style).

Message Header

New Properties

NameTypeDescription
trailingViewList< Widget >? Function(User?, Group?, BuildContext)?Custom widgets for trailing view in the message header.
heightdouble?Sets height for the message header component.
paddingEdgeInsetsGeometry?Sets padding for the message header component.
hideVideoCallButtonbool?Controls visibility of video call button in the header.
hideVoiceCallButtonbool?Controls visibility of voice call button in the header.
titleViewWidget? Function(Group?, User?, BuildContext)?Custom widget for title view in the message header.
leadingStateViewWidget? Function(Group?, User?, BuildContext)?Custom widget for leading state view in the message header.
auxiliaryButtonViewWidget? Function(Group?, User?, BuildContext)?Custom widget for auxiliary button view in the message header.
usersStatusVisibilityboolControls visibility of user status indicator (default: true).
dateTimeFormatterCallbackDateTimeFormatterCallback?Callback for custom date and time formatting.

Renamed Properties

V4 NameV5 NameTypeDescription
hideBackButtonshowBackButtonbool → boolControls back button visibility (inverted logic: hideBackButton=false becomes showBackButton=true).
disableUserPresenceusersStatusVisibilitybool → boolControls user presence visibility (inverted logic: disableUserPresence=false becomes usersStatusVisibility=true).
appBarOptionstrailingViewFunction → FunctionCustom widgets for header options (renamed from appBarOptions to trailingView).

Removed Properties

NameTypeDescription
themeCometChatTheme?Theme configuration for the message header component.
avatarStyleAvatarStyle?Style configuration for avatar in the header.
statusIndicatorStyleStatusIndicatorStyle?Style configuration for status indicator in the header.
privateGroupIconWidget?Custom icon for private groups in the header.
protectedGroupIconWidget?Custom icon for protected groups in the header.
disableTypingboolControls typing indicator functionality in the header.

Message List

New Properties

NameTypeDescription
styleCometChatMessageListStyle?Sets style for message list (replaces messageListStyle).
receiptsVisibilityboolControls visibility of read receipts (default: true).
avatarVisibilityboolToggle visibility for avatar (default: true, renamed from showAvatar).
paddingEdgeInsetsGeometry?Sets padding for the message list.
marginEdgeInsetsGeometry?Sets margin for the message list.
widthdouble?Sets width for the message list.
heightdouble?Sets height for the message list.
reactionsRequestBuilderReactionsRequestBuilder?Used to fetch the reactions of a particular message.
onLoadOnLoad< BaseMessage >?Callback triggered when list is fetched and loaded.
onEmptyOnEmpty?Callback triggered when the list is empty.
onReactionClickFunction(String?, BaseMessage)?Override the click of a reaction pill.
onReactionLongPressFunction(String?, BaseMessage)?Override when user long presses on a reaction pill.
onReactionListItemClickFunction(String?, BaseMessage?)?Override when a reaction list item is clicked.
hideStickyDateboolHide the sticky date separator.
hideReplyInThreadOptionboolDefines whether Reply In Thread option should be visible.
hideTranslateMessageOptionboolDefines whether Translate Message option should be visible.
hideEditMessageOptionboolDefines whether Edit Message option should be visible.
hideDeleteMessageOptionboolDefines whether Delete Message option should be visible.
hideReactionOptionboolDefines whether Reaction option should be visible.
hideMessagePrivatelyOptionboolDefines whether Message Privately option should be visible.
hideCopyMessageOptionboolDefines whether Copy Message option should be visible.
hideMessageInfoOptionboolDefines whether Message Info option should be visible.
hideGroupActionMessagesboolDefines whether action messages in groups should be visible.
enableConversationStartersboolControls conversation starter generation in new conversations.
enableSmartRepliesboolControls smart replies generation in chat.
hideShareMessageOptionboolDefines whether Share Message option should be visible.
smartRepliesDelayDurationintMilliseconds delay after which Smart Replies are triggered.
smartRepliesKeywordsList< String >Keywords that trigger Smart Replies.
addTemplateList< CometChatMessageTemplate >?Add custom message templates to existing templates.
dateTimeFormatterCallbackDateTimeFormatterCallback?Callback for custom date and time formatting.
hideModerationViewboolDefines whether moderation view should be hidden.
hideDateSeparatorboolHide the date separator (default: false).

Renamed Properties

V4 NameV5 NameTypeDescription
messageListStylestyleMessageListStyle → CometChatMessageListStyleStyle configuration (type changed).
controllerscrollControllerScrollController?Scroll controller for the list.
showAvataravatarVisibilitybool → boolToggle visibility for avatar.
disableReceipt/hideReceiptreceiptsVisibilitybool → boolControls receipt visibility (inverted logic).
addReactionIconTapaddMoreReactionTapFunction → FunctionCallback for adding more reactions.
dateSeparatorPatterndateSeparatorPatternFunction(DateTime) → Function(DateTime)Signature clarified with parameter name.

Removed Properties

NameTypeDescription
hideErrorbool?Toggle visibility of error dialog.
themeCometChatTheme?Theme configuration for the message list.
avatarStyleAvatarStyle?Style configuration for avatar (integrated into main style).
scrollToBottomOnNewMessagesbool?Auto-scroll to bottom on new messages.
newMessageIndicatorTextString?Custom text for new message indicator.
timestampAlignmentTimeAlignmentAlignment for message timestamps.
messageInformationConfigurationMessageInformationConfiguration?Configuration for message information.
reactionListConfigurationReactionListConfiguration?Configuration for reaction list.
reactionsConfigurationReactionsConfiguration?Configuration for reactions.
reactionsStyleReactionsStyle?Style configuration for reactions.
emojiKeyboardStyleEmojiKeyboardStyle?Style configuration for emoji keyboard.
disableReceiptbool?(Deprecated) Controls visibility of read receipts.
hideReceiptbool?Controls visibility of read receipts (replaced by receiptsVisibility).

Message Composer

New Properties

NameTypeDescription
paddingEdgeInsetsGeometry?Provides padding to the message composer.
messageInputPaddingEdgeInsetsGeometry?Sets the padding to the message input field.
recorderStartButtonIconWidget?Defines the icon of the start button for voice recording.
recorderPauseButtonIconWidget?Defines the icon of the pause button for voice recording.
recorderDeleteButtonIconWidget?Defines the icon of the delete button for voice recording.
recorderStopButtonIconWidget?Defines the icon of the stop button for voice recording.
recorderSendButtonIconWidget?Defines the icon of the send button for voice recording.
hideSendButtonbool?Controls visibility of send button.
hideAttachmentButtonbool?Controls visibility of attachment button.
hideStickersButtonbool?Controls visibility of sticker button.
hideImageAttachmentOptionbool?Controls visibility of image attachment option.
hideVideoAttachmentOptionbool?Controls visibility of video attachment option.
hideAudioAttachmentOptionbool?Controls visibility of audio attachment option.
hideFileAttachmentOptionbool?Controls visibility of file attachment option.
hidePollsOptionbool?Controls visibility of poll option.
hideCollaborativeDocumentOptionbool?Controls visibility of collaborative document option.
hideCollaborativeWhiteboardOptionbool?Controls visibility of collaborative whiteboard option.
hideTakePhotoOptionbool?Controls visibility of take photo option.
sendButtonIconWidget?Custom send button icon.

Renamed Properties

V4 NameV5 NameTypeDescription
hideVoiceRecordinghideVoiceRecordingButtonbool? → bool?Renamed for clarity (hideVoiceRecording to hideVoiceRecordingButton).

Removed Properties

NameTypeDescription
themeCometChatTheme?Theme configuration for the message composer.
hideLiveReactionboolControls live reaction functionality (feature removed).
liveReactionIconWidget?Custom live reaction icon (feature removed).
liveReactionIconURLString?Path for live reaction icon (feature removed).
recordIconWidget?Icon for recording start (replaced by recorderStartButtonIcon).
playIconWidget?Icon for playing recording (integrated into recorder).
deleteIconWidget?Icon for deleting recording (replaced by recorderDeleteButtonIcon).
stopIconWidget?Icon for stopping recording (replaced by recorderStopButtonIcon).
submitIconWidget?Icon for submitting recording (replaced by recorderSendButtonIcon).
pauseIconWidget?Icon for pausing recording (replaced by recorderPauseButtonIcon).
mediaRecorderStyleMediaRecorderStyle?Style for media recorder (integrated into main style).

Incoming Call

New Properties

NameTypeDescription
callSettingsBuilderCallSettingsBuilder?Used to set the call settings for the incoming call.
heightdouble?Sets the height of the incoming call widget.
widthdouble?Sets the width of the incoming call widget.
callIconWidget?Custom call icon for the incoming call display.
titleViewWidget? Function(BuildContext, Call)?Custom widget for title view in the incoming call.
subTitleViewWidget? Function(BuildContext, Call)?Custom widget for subtitle view in the incoming call.
leadingViewWidget? Function(BuildContext, Call)?Custom widget for leading view in the incoming call.
itemViewWidget? Function(BuildContext, Call)?Custom widget for complete item view in the incoming call.
trailingViewWidget? Function(BuildContext, Call)?Custom widget for trailing view in the incoming call.

Removed Properties

NameTypeDescription
themeCometChatTheme?Theme configuration for the incoming call component.
subtitleString?Custom subtitle text (replaced by subTitleView function).
declineButtonIconUrlString?Custom decline button icon URL.
declineButtonIconUrlPackageString?Package name for decline button icon.
cardStyleCardStyle?Style configuration for the card layout.
declineButtonStyleButtonStyle?Style configuration for decline button.
acceptButtonIconUrlString?Custom accept button icon URL.
acceptButtonIconUrlPackageString?Package name for accept button icon.
acceptButtonStyleButtonStyle?Style configuration for accept button.
avatarStyleAvatarStyle?Style configuration for avatar (integrated into main style).
ongoingCallConfigurationOngoingCallConfiguration?Configuration for ongoing call settings.

Outgoing Call

New Properties

NameTypeDescription
callSettingsBuilderCallSettingsBuilder?Used to set the call settings for the outgoing call.
heightdouble?Sets the height of the outgoing call widget.
widthdouble?Sets the width of the outgoing call widget.
avatarViewWidget? Function(BuildContext, Call)?Custom widget for avatar view in the outgoing call.
titleViewWidget? Function(BuildContext, Call)?Custom widget for title view in the outgoing call.
cancelledViewWidget? Function(BuildContext, Call)?Custom widget for cancelled/decline button view in the outgoing call.

Renamed Properties

V4 NameV5 NameTypeDescription
subtitlesubtitleViewString? → Widget? Function(BuildContext, Call)?Subtitle changed from static text to custom widget function.
declineButtonIconUrldeclineButtonIconString? → Widget?Decline button icon changed from URL-based to Widget-based.
onDeclineonCancelledFunction(BuildContext, Call)? → Function(BuildContext, Call)?Callback renamed from onDecline to onCancelled for clarity.

Removed Properties

NameTypeDescription
themeCometChatTheme?Theme configuration for the outgoing call component.
subtitleString?Custom subtitle text (replaced by subtitleView function).
declineButtonTextString?Custom decline button text.
declineButtonIconUrlString?Custom decline button icon URL (replaced by declineButtonIcon widget).
declineButtonIconUrlPackageString?Package name for decline button icon.
cardStyleCardStyle?Style configuration for the card layout.
buttonStyleButtonStyle?Style configuration for decline button.
avatarStyleAvatarStyle?Style configuration for avatar (integrated into main style).
ongoingCallConfigurationOngoingCallConfiguration?Configuration for ongoing call settings.

Call Buttons

New Properties

NameTypeDescription
callSettingsBuilderCallSettingsBuilder Function(User?, Group?, bool?)?Used to configure the meet settings builder for call initialization.

Renamed Properties

V4 NameV5 NameTypeDescription
hideVoiceCallhideVoiceCallButtonbool? → bool?Renamed for clarity (hideVoiceCall to hideVoiceCallButton).
hideVideoCallhideVideoCallButtonbool? → bool?Renamed for clarity (hideVideoCall to hideVideoCallButton).

Removed Properties

NameTypeDescription
voiceCallIconTextString?Text label for the voice call icon.
voiceCallIconHoverTextString?Hover text for the voice call icon.
videoCallIconTextString?Text label for the video call icon.
videoCallIconHoverTextString?Hover text for the video call icon.
onVoiceCallClickFunction(BuildContext, User?, Group?)?Custom callback for voice call button click.
onVideoCallClickFunction(BuildContext, User?, Group?)?Custom callback for video call button click.
ongoingCallConfigurationOngoingCallConfiguration?Configuration for ongoing call settings.

Call Logs

New Properties

NameTypeDescription
hideAppbarboolToggle visibility for app bar (default: false).
appBarOptionsList< Widget >?List of options to be visible in app bar.
onCallLogIconClickedFunction(CallLog)?Callback triggered on clicking of the call log icon (audio/video icon).
onItemLongPressFunction(CallLog)?Callback triggered on long pressing of the call log item.
onLoadOnLoad< CallLog >?Callback triggered when list is fetched and loaded.
onEmptyOnEmpty?Callback triggered when the list is empty.
setOptionsFunction?Sets list of actions available on the long press of list item.
addOptionsFunction?Adds into the current list of actions available on the long press of list item.
leadingStateViewWidget? Function(BuildContext, CallLog)?Custom widget for leading view of each call log item.
titleViewWidget? Function(BuildContext, CallLog)?Custom widget for title view of each call log item.
audioCallIconWidget?Custom audio call icon.
videoCallIconWidget?Custom video call icon.
incomingCallIconWidget?Custom incoming call icon.
outgoingCallIconWidget?Custom outgoing call icon.
missedCallIconWidget?Custom missed call icon.

Renamed Properties

V4 NameV5 NameTypeDescription
tailViewtrailingViewFunction → FunctionCustom widget for trailing view (renamed from tailView to trailingView).

Removed Properties

NameTypeDescription
titleString?Title of the call log list component.
emptyStateTextString?Text to be displayed when the state is empty.
errorStateTextString?Text to be displayed when error occurs.
loadingIconUrlString?URL to be displayed when loading.
avatarStyleAvatarStyle?Style configuration for avatar (integrated into main style).
themeCometChatTheme?Theme configuration for the call logs component.
hideSeparatorbool?Toggle visibility of separator.
onInfoIconClickFunction(CallLog)?Callback triggered on clicking of the info icon.
infoIconUrlString?Custom info icon URL.
listItemStyleListItemStyle?Style configuration for individual list items.
incomingAudioCallIconString?Custom incoming audio call icon URL (replaced by incomingCallIcon widget).
incomingVideoCallIconString?Custom incoming video call icon URL (replaced by incomingCallIcon widget).
outgoingAudioCallIconString?Custom outgoing audio call icon URL (replaced by outgoingCallIcon widget).
outgoingVideoCallIconString?Custom outgoing video call icon URL (replaced by outgoingCallIcon widget).
missedAudioCallIconString?Custom missed audio call icon URL (replaced by missedCallIcon widget).
missedVideoCallIconString?Custom missed video call icon URL (replaced by missedCallIcon widget).
I