Property Changes

Migration guide for property changes between UI Kit versions for iOS

This document outlines the property changes between v4 and v5 of the CometChat UI Kit for iOS. Use this guide to update your implementation when migrating to the latest version.

---

Conversations

New Properties

Name	Type	Description
hideNavigationBar	Bool	Hides or shows the navigation bar in the conversations screen.
hideSearch	Bool	Hides the search bar in the conversations screen.
hideLoadingState	Bool	Hides the loading state indicator.
hideDeleteConversationOption	Bool	Hides the option to delete a conversation.
hideGroupType	Bool	Hides the group type indicator (private/public).
backgroundDrawable	UIImage	Sets a background image for the conversation screen.
separatorColor	UIColor	Sets the color of separators in the conversation list.
separatorWidth	CGFloat	Sets the width of separators in the conversation list.
errorTextColor	UIColor	Sets the color of error messages in the conversation UI.
lastMessageTextColor	UIColor	Sets the color of the last message text in the conversation list.
typingIndicatorColor	UIColor	Sets the color of the typing indicator in the conversation UI.
lastMessageAppearance	UIFont	Customizes the appearance of the last message text in the list.
threadIndicatorAppearance	UIFont	Customizes the appearance of thread indicators in the list.
dateTimeFormatter.time	Closure	Formats a timestamp as a standard time (e.g., “12:30 PM”).
dateTimeFormatter.today	Closure	Formats messages sent today.
dateTimeFormatter.yesterday	Closure	Formats yesterday’s messages.
dateTimeFormatter.lastweek	Closure	Formats messages within the last week.
dateTimeFormatter.otherDay	Closure	Formats dates older than last week.
dateTimeFormatter.minute	Closure	Formats “a minute ago”.
dateTimeFormatter.minutes	Closure	Formats “x minutes ago”.
dateTimeFormatter.hour	Closure	Formats “an hour ago”.
dateTimeFormatter.hours	Closure	Formats “x hours ago”.
set(OnItemLongClick:)	Method	Triggered when you long press on a ListItem of the Conversations component.
set(onEmpty:)	Method	Triggered when the conversations list is empty.

Renamed Properties

v4 Name	v5 Name	Type	Description
hide(error: Bool)	hideErrorView	Bool	Hides the error state view.
show(backButton: Bool)	hideBackButton	Bool	Controls visibility of the back button (logic inverted).
hide(receipt: Bool)	hideReceipts	Bool	Hides message read/delivery receipts.
disable(userPresence: Bool)	hideUserStatus	Bool	Hides the online/offline status of users.
setOnItemClick	set(OnItemClick:)	Method	Triggered when clicking on a ListItem.
setOnBack	set(onBack:)	Method	Override action when back button is pressed.
setOnSelection	set(onSelection:)	Method	Triggered upon completion of selection.
setOnError	set(onError:)	Method	Override action when an error occurs.

Removed Properties

Name	Type	Description
hide(separator: Bool)	Bool	Controlled visibility of separators (replaced by style properties).
disable(typing: Bool)	Bool	Toggled visibility of typing indicator.
setDatePattern	Method	Set custom date pattern (replaced by dateTimeFormatter object).
protectedGroupIcon	UIImage	Icon shown for password protected groups.
sentIcon	UIImage	Receipt icon shown when message status is sent.
deliveredIcon	UIImage	Receipt icon shown when message status is delivered.
readIcon	UIImage	Receipt icon shown when message status is read.

---

Users

New Properties

Name	Type	Description
set(options:)	(User) -> [CometChatUserOption]	Defines custom options for each user.
add(options:)	[CometChatUserOption]	Dynamically adds options to users.
set(leadingView:)	(User) -> UIView	Custom leading view for each user in the fetched list.
set(titleView:)	(User) -> UIView	Custom title view for each user in the fetched list.
set(trailView:)	(User) -> UIView	Custom trailing view for each user in the fetched list.
set(onEmpty:)	() -> Void	Triggered when the users list is empty.
hideErrorView	Bool	Hides the error state view.
hideNavigationBar	Bool	Hides or shows the navigation bar.
hideBackButton	Bool	Hides the back button.
hideLoadingState	Bool	Hides the loading state indicator.
hideUserStatus	Bool	Hides the online/offline status of users.
hideSectionHeader	Bool	Hides the section header indicating initials of users.
hideSearch	Bool	Hides the search bar.
set(searchKeyword:)	String	Sets a search keyword for filtering users.
set(userRequestBuilder:)	UsersRequest.UsersRequestBuilder	Sets a custom request builder for fetching users.
set(searchRequestBuilder:)	UsersRequest.UsersRequestBuilder	Sets a custom request builder for searching users.
listItemSelectedImage	UIImage	Image shown when a list item is selected.
listItemDeSelectedImage	UIImage	Image shown when a list item is deselected.
searchIconTintColor	UIColor	Tint color for the search icon.
searchBarStyle	UISearchBar.Style	Style of the search bar.
searchTintColor	UIColor?	Tint color for the search bar elements.
searchBarTintColor	UIColor?	Background color for the search bar (excluding text input).
searchBarPlaceholderTextColor	UIColor?	Color of the placeholder text in the search bar.
searchBarPlaceholderTextFont	UIFont?	Font of the placeholder text in the search bar.
searchBarTextColor	UIColor?	Color of the entered text in the search bar.
searchBarTextFont	UIFont?	Font of the entered text in the search bar.
searchBarBackgroundColor	UIColor?	Background color of the search bar’s text input area.
searchBarCancelIconTintColor	UIColor?	Tint color for the cancel button in the search bar.
searchBarCrossIconTintColor	UIColor?	Tint color for the clear (cross) button in the search bar.
backgroundColor	UIColor	Background color for the entire screen or view.
borderWidth	CGFloat	Border width for the search bar or container.
borderColor	UIColor	Color of the border.
cornerRadius	CometChatCornerStyle	Corner radius for search bar or other elements.
titleColor	UIColor	Text color for title elements.
titleFont	UIFont	Font for title text.
largeTitleColor	UIColor	Text color for large titles.
largeTitleFont	UIFont?	Font for large titles.
navigationBarTintColor	UIColor	Tint color for the navigation bar background.
navigationBarItemsTintColor	UIColor	Tint color for navigation bar items.
errorTitleTextFont	UIFont	Font for the error title.
errorTitleTextColor	UIColor	Text color for the error title.
errorSubTitleFont	UIFont	Font for the subtitle of error messages.
errorSubTitleTextColor	UIColor	Text color for the subtitle of error messages.
retryButtonTextColor	UIColor	Text color for the retry button.
retryButtonTextFont	UIFont	Font for the retry button text.
retryButtonBackgroundColor	UIColor	Background color for the retry button.
retryButtonBorderColor	UIColor	Border color for the retry button.
retryButtonBorderWidth	CGFloat	Border width for the retry button.
retryButtonCornerRadius	CometChatCornerStyle?	Corner radius for the retry button.
emptyTitleTextFont	UIFont	Font for the empty state title.
emptyTitleTextColor	UIColor	Text color for the empty state title.
emptySubTitleFont	UIFont	Font for the subtitle in the empty state.
emptySubTitleTextColor	UIColor	Text color for the subtitle in the empty state.
tableViewSeparator	UIColor	Color for the table view separator.
listItemTitleTextColor	UIColor	Text color for list item titles.
listItemTitleFont	UIFont	Font for list item titles.
listItemSubTitleTextColor	UIColor	Text color for list item subtitles.
listItemSubTitleFont	UIFont	Font for list item subtitles.
listItemBackground	UIColor	Background color for individual list items.
listItemBorderWidth	CGFloat	Border width for individual list items.
listItemBorderColor	UIColor	Border color for individual list items.
listItemCornerRadius	CometChatCornerStyle	Corner radius for list items.
listItemSelectionImageTint	UIColor	Tint color for selection indicator in list items.
listItemSelectedBackground	UIColor	Background color for selected list items.
listItemDeSelectedImageTint	UIColor	Tint color for the deselected state image.
headerTitleColor	UIColor	Text color for section header titles.
headerTitleFont	UIFont	Font for section header titles.

Renamed Properties

Name	Type	Description	Old Name
set(listItemView:)	(User) -> UIView	Custom list item view for each user in the list.	setListItemView
set(subtitleView:)	(User) -> UIView	Custom subtitle view for each user in the fetched list.	setSubtitleView
set(emptyView:)	UIView	Custom empty state view when the user list is empty.	setEmptyStateView
set(errorView:)	UIView	Custom error state view when an error occurs while fetching users.	setErrorStateView
set(onItemClick:)	(User) -> Void	Triggered when you click on a ListItem.	setOnItemClick
set(onItemLongClick:)	(User) -> Void	Triggered when you long press on a ListItem.	setOnItemLongClick
set(onBack:)	() -> Void	Triggered when the back button is pressed.	setOnBack
set(onSelection:)	([User]) -> Void	Triggered on every selection when selection mode is set.	setOnSelection
set(onError:)	(CometChatException) -> Void	Triggered when an error occurs.	setOnError

Removed Properties

Name	Type	Description
set(loadingStateView:)	UIActivityIndicatorView.Style	Set size of loading view icon while fetching users.
hide(errorText:)	Bool	Hide error text on fetching users.
show(backButton:)	Bool	Toggle visibility for back button.
set(searchIcon:)	UIImage?	Set search icon in the search field.
hide(search:)	Bool	Toggle visibility for search box.
hide(separator:)	Bool	Hide the divider separating user items.
disable(userPresence:)	Bool	Control visibility of user online indicator.
set(emptyStateText:)	String	Set custom text when fetching users returns an empty list.
set(errorStateText:)	String	Set custom text when an error occurs fetching users.
set(searchPlaceholder:)	String	Set search placeholder text.
set(title:mode:)	String, UINavigationItem.LargeTitleDisplayMode	Set title with display mode.
setOnLoad	([User]) -> Void	Triggered when a user list is fully fetched and displayed.

---

Groups

New Properties

Name	Type	Description
set(onSelection:)	Closure	Triggered when selection mode is set. Returns the list of selected groups.
set(onEmpty:)	Closure	Triggered when the groups list is empty.
setOnLoad	Closure	Triggered when a group list is fully fetched and displayed.
listItemSelectedImage	UIImage	Check box image when a list item is selected.
listItemDeSelectedImage	UIImage	Check box image when a list item is deselected.
searchIconTintColor	UIColor	Tint color for the search icon.
searchBarStyle	UISearchBarStyle	Style of the search bar.
searchTintColor	UIColor	Tint color for the search bar.
searchBarTintColor	UIColor	Background color of the search bar.
searchBarPlaceholderTextColor	UIColor	Placeholder text color for the search bar.
searchBarPlaceholderTextFont	UIFont	Font for the placeholder text in the search bar.
searchBarTextColor	UIColor	Color of the text entered in the search bar.
searchBarTextFont	UIFont	Font for the text in the search bar.
searchBarBackgroundColor	UIColor	Background color of the search bar.
searchBarCancelIconTintColor	UIColor	Tint color for the cancel icon in the search bar.
searchBarCrossIconTintColor	UIColor	Tint color for the cross icon in the search bar.
backgroundColor	UIColor	Background color of the overall view.
borderWidth	CGFloat	Width of the border around the view.
borderColor	UIColor	Color of the border around the view.
cornerRadius	CometChatCornerStyle	Corner radius settings for the view.
titleColor	UIColor	Color for the title text.
titleFont	UIFont	Font for the title text.
largeTitleColor	UIColor	Color for the large title text.
largeTitleFont	UIFont	Font for the large title text.
navigationBarTintColor	UIColor	Background color of the navigation bar.
navigationBarItemsTintColor	UIColor	Tint color for items in the navigation bar.
errorTitleTextFont	UIFont	Font for the error title text.
errorTitleTextColor	UIColor	Color of the error title text.
errorSubTitleFont	UIFont	Font for the error subtitle text.
errorSubTitleTextColor	UIColor	Color of the error subtitle text.
retryButtonTextColor	UIColor	Color for the retry button text.
retryButtonTextFont	UIFont	Font for the retry button text.
retryButtonBackgroundColor	UIColor	Background color for the retry button.
retryButtonBorderColor	UIColor	Border color for the retry button.
retryButtonBorderWidth	CGFloat	Width of the border around the retry button.
retryButtonCornerRadius	CometChatCornerStyle	Corner radius settings for the retry button.
emptyTitleTextFont	UIFont	Font for the empty state title text.
emptyTitleTextColor	UIColor	Color of the empty state title text.
emptySubTitleFont	UIFont	Font for the empty state subtitle text.
emptySubTitleTextColor	UIColor	Color of the empty state subtitle text.
tableViewSeparator	UIColor	Color of the table view separator.
listItemTitleTextColor	UIColor	Color of the title text in list items.
listItemTitleFont	UIFont	Font for the title text in list items.
listItemSubTitleTextColor	UIColor	Color of the subtitle text in list items.
listItemSubTitleFont	UIFont	Font for the subtitle text in list items.
listItemBackground	UIColor	Background color for list items.
listItemSelectedBackground	UIColor	Background color for selected list items.
listItemBorderWidth	CGFloat	Width of the border around list items.
listItemBorderColor	UIColor	Color of the border around list items.
listItemCornerRadius	CometChatCornerStyle	Corner radius settings for list items.
listItemSelectionImageTint	UIColor	Tint color for the selection image in list items.
listItemDeSelectedImageTint	UIColor	Tint color for the deselected image in list items.
passwordGroupImageTintColor	UIColor	Tint color for the password group image.
passwordGroupImageBackgroundColor	UIColor	Background color for the password group image.
privateGroupImageTintColor	UIColor	Tint color for the private group image.
privateGroupImageBackgroundColor	UIColor	Background color for the private group image.
privateGroupIcon	UIImage	Image for a private group icon.
protectedGroupIcon	UIImage	Image for a protected group icon.
set(groupsRequestBuilder:)	GroupsRequest.GroupsRequestBuilder	Sets the request builder for fetching groups.
set(searchRequestBuilder:)	GroupsRequest.GroupsRequestBuilder	Sets the request builder for searching groups.
set(searchKeyword:)	String	Sets the search keyword to filter groups.
hideErrorView	Bool	Hides the error state view.
hideNavigationBar	Bool	Hides or shows the navigation bar.
hideSearch	Bool	Hides the search bar.
hideBackButton	Bool	Hides the back button.
hideLoadingState	Bool	Hides the loading state indicator.
hideReceipts	Bool	Hides message read/delivery receipts.
hideDeleteConversationOption	Bool	Hides the option to delete a conversation.
hideUserStatus	Bool	Hides the online/offline status of users.
hideGroupType	Bool	Hides the group type (private/public).
set(options:)	(Group?) -> [CometChatGroupOption]	Defines custom options for each group.
add(options:)	(Group?) -> [CometChatGroupOption]	Dynamically adds options to groups.
set(leadingView:)	(Group?) -> UIView	Modifies the leading view of a group cell.
set(titleView:)	(Group?) -> UIView	Customizes the title view of a group cell.
set(trailView:)	(Group?) -> UIView	Modifies the trailing view of a group cell.

Renamed Properties

Name	Type	Description	Old Name
set(onItemClick:)	Closure	Triggered when you click on a ListItem.	SetOnItemClick
set(OnItemLongClick:)	Closure	Triggered when you long press on a ListItem.	SetOnItemLongClick
set(onError:)	Closure	Triggered when an error occurs.	SetOnError
set(onBack:)	Closure	Triggered when the back button is pressed.	SetOnBack
SetListItemView	(Group?) -> UIView	Assigns a custom ListItem to the Groups Component.	setListItemView
SetSubTitleView	(Group?) -> UIView	Customizes the subtitle view for each group item.	setSubtitleView

Removed Properties

No properties were removed in v5. All v4 properties have been retained (with some renamed) and additional functionality has been added.

---

Group Members

New Properties

Name	Type	Description
retryButtonTextColor	UIColor	Sets the text color for the retry button.
retryButtonTextFont	UIFont	Sets the text font for the retry button.
retryButtonBackgroundColor	UIColor	Sets the background color for the retry button.
retryButtonBorderColor	UIColor	Sets the border color for the retry button.
retryButtonBorderWidth	CGFloat	Sets the border width for the retry button.
retryButtonCornerRadius	CometChatCornerStyle	Sets the corner radius for the retry button.
listItemSelectedBackground	UIColor	Sets the background color for selected list items.
listItemDeSelectedImageTint	UIColor	Sets the tint color for deselected list item images.
listItemSelectionImageTint	UIColor	Sets the tint color for selected list item images.
listItemSelectedImage	UIImage	Sets the image for selected list items.
listItemDeSelectedImage	UIImage	Sets the image for deselected list items.
largeTitleColor	UIColor?	Sets the color for the large title text.
navigationBarTintColor	UIColor?	Sets the tint color for the navigation bar.
navigationBarItemsTintColor	UIColor?	Sets the tint color for navigation bar items.
errorTitleTextFont	UIFont	Sets the font for the error title text.
errorTitleTextColor	UIColor	Sets the color for the error title text.
errorSubTitleFont	UIFont	Sets the font for the error subtitle text.
errorSubTitleTextColor	UIColor	Sets the color for the error subtitle text.
emptyTitleTextFont	UIFont	Sets the font for the empty state title text.
emptyTitleTextColor	UIColor	Sets the color for the empty state title text.
emptySubTitleFont	UIFont	Sets the font for the empty state subtitle text.
emptySubTitleTextColor	UIColor	Sets the color for the empty state subtitle text.
tableViewSeparator	UIColor	Sets the color for the table view separator.
listItemTitleTextColor	UIColor	Sets the text color for list item titles.
listItemTitleFont	UIFont	Sets the font for list item titles.
listItemSubTitleTextColor	UIColor	Sets the text color for list item subtitles.
listItemSubTitleFont	UIFont	Sets the font for list item subtitles.
listItemBackground	UIColor	Sets the background color for list items.
listItemBorderWidth	CGFloat	Sets the border width for list items.
listItemBorderColor	UIColor	Sets the border color for list items.
listItemCornerRadius	CometChatCornerStyle	Sets the corner radius for list items.
messageTypeImageTint	UIColor	Sets the tint color for message type icons.
passwordGroupImageTintColor	UIColor	Sets the tint color for password group icons.
passwordGroupImageBackgroundColor	UIColor	Sets the background color for password group icons.
privateGroupImageTintColor	UIColor	Sets the tint color for private group icons.
privateGroupImageBackgroundColor	UIColor	Sets the background color for private group icons.
backgroundColor	UIColor	Sets the background color for the component.
set(groupMembersRequestBuilder:)	GroupMembersRequest.GroupMembersRequestBuilder	Sets the request builder for fetching group members.
set(searchRequestBuilder:)	GroupMembersRequest.GroupMembersRequestBuilder	Sets the request builder for searching group members.
set(searchKeyword:)	String	Sets the search keyword to filter group members.
hideError	Bool	Hides the error state view.
hideUserStatus	Bool	Hides the online/offline status of users.
hideNavigationBar	Bool	Hides or shows the navigation bar.
hideLoadingState	Bool	Hides the loading state indicator.
hideBackIcon	Bool	Hides the back button/icon.
hideKickMemberOption	Bool	Hides the option to kick a member from the group.
hideBanMemberOption	Bool	Hides the option to ban a member from the group.
hideScopeChangeOption	Bool	Hides the option to change a member’s scope (role).
hideSearch	Bool	Hides the search bar.
set(onSelection:)	([GroupMember]) -> Void	Triggers on every selection and returns the list of selected group members.
set(onEmpty:)	() -> Void	Triggers when the groups list is empty.
set(onLoad:)	([GroupMember]) -> Void	Triggers when group members list is fully fetched and displayed.
set(onItemClick:)	(GroupMember, IndexPath) -> Void	Triggered when you click on a ListItem.
set(onItemLongClick:)	(GroupMember, IndexPath) -> Void	Triggered when you long press on a ListItem.
set(onError:)	(CometChatException) -> Void	Triggered when an error occurs.
set(onBack:)	() -> Void	Triggered when back button is pressed.
set(leadingView:)	(GroupMember?) -> UIView	Sets a custom leading view for group member cells.
set(titleView:)	(GroupMember?) -> UIView	Sets a custom title view for group member cells.
set(loadingView:)	UIView	Sets a custom loading view displayed while data is being fetched.
set(errorView:)	UIView	Sets a custom error view that appears when an error occurs.
set(emptyView:)	UIView	Sets a custom empty state view when no group members are available.
setListItemView	(GroupMember?) -> UIView	Assigns a custom ListItem to the GroupMembers component.
setSubtitleView	(GroupMember?) -> UIView	Sets a custom subtitle view for each GroupMembers item.
setTailView	(GroupMember?) -> UIView	Sets a custom tail view for group member cells.
setOptions	[CometChatGroupMemberOption]	Sets custom options for swipe actions.
set(menus:)	UIView	Sets custom menus to add more options.

Renamed Properties

Name	Type	Description	Old Name
backgroundColor	UIColor	Sets the background color for the component.	background
hideUserStatus	Bool	Hides/disables the online/offline status of users.	disable(userPresence:)
hideSearch	Bool	Hides the search bar.	hide(search:)
set(onItemClick:)	(GroupMember, IndexPath) -> Void	Triggered when you click on a ListItem.	setOnItemClick
set(onItemLongClick:)	(GroupMember, IndexPath) -> Void	Triggered when you long press on a ListItem.	setOnItemLongClick
set(onError:)	(CometChatException) -> Void	Triggered when an error occurs.	setOnError
set(onBack:)	() -> Void	Triggered when back button is pressed.	setOnBack

Removed Properties

Name	Type	Description
backIconTint	UIColor	Back button tint color.
searchIconTint	UIColor	Search icon tint color.
searchTextFont	UIFont	Search text font.
searchTextColor	UIColor	Search text color.
searchCancelButtonTint	UIColor	Search cancel icon tint.
searchPlaceholderFont	UIFont	Search placeholder font.
searchPlaceholderColor	UIColor	Search placeholder color.
addButtonTint	UIColor	Add button color.
addButtonFont	UIFont	Add button font.
avatarStyle	AvatarStyle	Styles for the avatar component.
statusIndicatorStyle	CSSProperties	Styles for the status indicator component.
listItemStyle	ListItemStyle	Styles for the default list item view.
groupScopeStyle	ChangeScopeStyle	Styles for the change scope component.
groupMembersStyle	GroupMembersStyle	Styles for this component.
set(title:mode:)	String, UINavigationItem.LargeTitleDisplayMode	Custom title for the component.
set(backButtonTitle:)	String?	Custom text for the back button.
set(searchPlaceholder:)	String	Custom placeholder text for search field.
show(backButton:)	Bool	Whether to show the back button.
set(errorStateText:)	String	Custom error state text.
set(backButtonIcon:)	UIImage	Custom back button icon.
set(passwordPlaceholderText:)	String	Custom placeholder text for password.
hide(continueButton:)	Bool	Whether to hide the continue button.
set(searchIcon:)	UIImage	Icon for the search bar.
set(searchClearIcon:)	UIImage	Clear icon for the search bar.
set(searchBarHeight:)	CGFloat	Height for the search bar.
selectionMode(mode:)	SelectionMode	Enables selection mode (.single, .multiple).
hide(separator:)	Bool	Hide/unhide the separator.
clearList()	-	Clears the users locally.
update(groupMember:)	GroupMember	Updates member object locally.
remove(groupMember:)	GroupMember	Removes member object locally.
size()	-	Returns the count of members displayed.
title	String	Title of the component.
searchPlaceholder	String	Text displayed when search input has no value.
fetchTimeOut	any	Timeout reference for fetching users.
userPresencePlacement	UserPresencePlacement	Placement of user presence information.
backButtonIconURL	String	Image URL for the back button.
showBackButton	Bool	Show back button.
closeButtonIconURL	String	Image URL for the close button.
dropDownIconURL	String	Image URL for the change scope component’s arrowIconURL prop.
emptyStateText	String	Text to display in the default empty view.
errorStateText	String	Text to display in the default error view.
loadingIconURL	String	Image URL for the default loading view.
hideSeparator	Bool	Hide the separator at the bottom of the default list item view.
titleAlignment	TitleAlignment	Alignment of the title text.
searchIconURL	String	Image URL for the search icon.
fetchingUsers	Bool	Flag to indicate whether users are currently being fetched.
onClose	() -> Void	Function to call when the close button is clicked.
headerView	UIView	Custom header view which will replace the title.

---

Message Header

New Properties

Name	Type	Description
titleTextColor	UIColor	Text color of the header title.
titleTextFont	UIFont	Font style of the header title.
subtitleTextColor	UIColor	Text color of the subtitle in the header.
subtitleTextFont	UIFont	Font style of the subtitle in the header.
backButtonImageTintColor	UIColor	Tint color of the back button image in the header.
privateGroupBadgeImageTintColor	UIColor	Tint color of the private group badge in the header.
passwordProtectedGroupBadgeImageTintColor	UIColor	Tint color of the password-protected group badge in the header.
privateGroupImageBackgroundColor	UIColor	Background color of the private group badge.
passwordGroupImageBackgroundColor	UIColor	Background color of the password-protected group badge.
groupImageBackgroundColor	UIColor	Background color for group icons in the header.
avatarStyle	AvatarStyle	Customizes the appearance of the avatar in the header.
backgroundColor	UIColor	Background color of the header.
cornerRadius	CometChatCornerStyle	Corner radius of the header.
borderWidth	CGFloat	Border width of the header.
borderColor	UIColor	Border color of the header.
backButtonIcon	UIImage	Custom icon for the back button.
privateGroupIcon	UIImage	Custom icon for private groups.
protectedGroupIcon	UIImage	Custom icon for password-protected groups.
backgroundImage	UIImage	Background image for the header.
hideBackButton	Bool	Hides the back button of message header.
hideUserStatus	Bool	Hides or shows the user status (online/offline/last active at).
hideVideoCallButton	Bool	Hides the video call button.
hideVoiceCallButton	Bool	Hides the voice call button.
set(onBack:)	() -> Void	Triggered when back button is pressed.
set(onError:)	(CometChatException) -> Void	Triggered when an error occurs.
set(listItemView:)	(User?, Group?) -> UIView	Assigns a custom ListItem to the message header component.
set(leadingView:)	(User?, Group?) -> UIView	Sets a custom leading view for message header.
set(titleView:)	(User?, Group?) -> UIView	Sets a custom title view for message header.
set(trailView:)	(User?, Group?) -> UIView	Sets a custom trailing view for message header.
set(subtitleView:)	(User?, Group?) -> UIView	Sets a custom subtitle view for message header.
dateTimeFormatter	CometChatDateTimeFormatter	Supports full customization of how date and time are displayed.

Renamed Properties

Name	Type	Description	Old Name
backgroundColor	UIColor	Background color for the component.	background
backButtonImageTintColor	UIColor	Tint color of the back button image in the header.	backIconTint
hideBackButton	Bool	Hides the back button of message header.	hide(backButton:)
hideUserStatus	Bool	Hides or shows the user status.	set(disableUsersPresence:)
set(menus:)	(User?, Group?) -> UIView	Sets custom menus to add more options.	setMenus
set(subtitleView:)	(User?, Group?) -> UIView	Sets a custom subtitle view for message header.	setSubtitleView

Removed Properties

Name	Type	Description
typingIndicatorTextFont	UIFont	Typing indicator text font.
typingIndicatorTextColor	UIColor	Typing indicator text color.
detailIconTint	UIColor	Tint color for detail icon.
onlineStatusColor	UIColor	Online status color.
privateGroupIconBackgroundColor	UIColor	Private group background color (replaced by privateGroupImageBackgroundColor).
protectedGroupIconBackgroundColor	UIColor	Protected group background color (replaced by passwordGroupImageBackgroundColor).
set(protectedGroupIcon:)	UIImage	Custom protected group icon.
set(privateGroupIcon:)	UIImage	Custom private group icon.
disable(typing:)	Bool	Enable/disable typing indicators.

---

Message List

New Properties

Name	Type	Description
hideAvatar	Bool	Hides the avatar of the sender.
hideGroupActionMessages	Bool	Hides group action messages (like join/leave notifications).
hideReplyInThreadOption	Bool	Hides the reply in thread option.
hideTranslateMessageOption	Bool	Hides the message translation option.
hideEditMessageOption	Bool	Hides the edit message option.
hideDeleteMessageOption	Bool	Hides the delete message option.
hideReactionOption	Bool	Hides the reaction option on messages.
hideMessagePrivatelyOption	Bool	Hides the option to message privately.
hideCopyMessageOption	Bool	Hides the option to copy a message.
hideMessageInfoOption	Bool	Hides the message info option.
hideHeaderView	Bool	Hides the header view of the message list.
hideFooterView	Bool	Hides the footer view of the message list.
hideDateSeparator	Bool	Hides the date separator between messages.
scrollToBottomOnNewMessages	Bool	Scrolls to the bottom when new messages arrive.
hideReceipts	Bool	Hides the message read receipts (ticks).
disableSoundForMessages	Bool	Disables the sound when a new message arrives.
hideEmptyView	Bool	Hides the empty state view when no messages are available.
hideErrorView	Bool	Hides the error view when an error occurs.
hideLoadingView	Bool	Hides the loading view when fetching messages.
hideNewMessageIndicator	Bool	Hides the “new message” indicator.
backgroundColor	UIColor	Background color with dynamic support for light and dark mode.
borderWidth	CGFloat	Border width for the component.
borderColor	UIColor	Border color for the component.
cornerRadius	CometChatCornerStyle	Corner radius for the component.
shimmerGradientColor1	UIColor	First color of the shimmer gradient.
shimmerGradientColor2	UIColor	Second color of the shimmer gradient.
emptyStateTitleColor	UIColor	Text color for the title in the empty state.
emptyStateTitleFont	UIFont	Font for the title in the empty state.
emptyStateSubtitleColor	UIColor	Text color for the subtitle in the empty state.
emptyStateSubtitleFont	UIFont	Font for the subtitle in the empty state.
errorStateTitleColor	UIColor	Text color for the title in the error state.
errorStateTitleFont	UIFont	Font for the title in the error state.
errorStateSubtitleColor	UIColor	Text color for the subtitle in the error state.
errorStateSubtitleFont	UIFont	Font for the subtitle in the error state.
threadedMessageImage	UIImage	Icon image for threaded messages.
errorImage	UIImage	Icon image for error state.
emptyImage	UIImage	Icon image for empty state.
newMessageIndicatorImage	UIImage	Icon image for new message indicator.
backgroundImage	UIImage	Background image for the component.
scrollToBottom(isAnimated:)	Bool	Scrolls to the bottom of the message list.
set(messageAlignment:)	MessageListAlignment	Sets the alignment of messages in the list.
set(smartRepliesKeywords:)	[String]	Sets keywords for smart replies.
set(smartRepliesDelayDuration:)	Int	Sets the delay duration for smart replies.
set(user:parentMessage:)	User, BaseMessage?	Sets the user and an optional parent message.
set(group:parentMessage:)	Group, BaseMessage?	Sets the group and an optional parent message.
set(messagesRequestBuilder:)	MessagesRequest.MessageRequestBuilder	Sets the message request builder.
set(reactionsRequestBuilder:)	ReactionsRequest.ReactionsRequestBuilder	Sets the reactions request builder.
set(parentMessageId:)	Int	Sets the parent message ID.
set(onThreadRepliesClick:)	(BaseMessage, CometChatMessageTemplate) -> Void	Triggered when you click on the thread indicator.
set(onReactionClick:)	(CometChat.ReactionCount, BaseMessage) -> Void	Triggered when you click on a reaction.
set(onReactionListItemClick:)	(CometChat.Reaction, BaseMessage) -> Void	Triggered when you click on the list item of CometChatReactionList.
set(onError:)	(CometChatException) -> Void	Triggered when an error occurs.
set(onEmpty:)	() -> Void	Triggers when the message list is empty.
set(onLoad:)	([BaseMessage]) -> Void	Triggers when message list is fully fetched and displayed.
set(headerView:)	UIView	Sets a custom header view for message list.
set(footerView:)	UIView	Sets a custom footer view for message list.
set(dateSeparatorPattern:)	(Int?) -> String	Sets the date separator pattern using a closure.
set(datePattern:)	(Int?) -> String	Sets the date pattern using a closure.
set(timePattern:)	(Int?) -> String	Sets the time pattern using a closure.
set(textFormatter:)	[CometChatTextFormatter]	Sets the list of text formatters.
set(loadingView:)	UIView	Sets a custom loading view.
set(errorView:)	UIView	Sets a custom error view.
set(emptyView:)	UIView	Sets a custom empty state view.
set(templates:)	[CometChatMessageTemplate]	Sets message templates to MessageList.
dateTimeFormatter	CometChatDateTimeFormatter	Supports full customization of how date and time are displayed.
set(controller:)	UIViewController	Sets the controller (mandatory for proper configuration).

Renamed Properties

Name	Type	Description	Old Name
hideReceipts	Bool	Hides the message read receipts.	hide(receipt:)
hideAvatar	Bool	Shows/hides the avatar of the sender.	show(avatar:)
backgroundColor	UIColor	Background color for the component.	background
set(messageAlignment:)	MessageListAlignment	Sets the alignment of messages in the list.	alignment

Removed Properties

Name	Type	Description
loadingIconTint	UIColor	Loading icon tint.
emptyTextFont	UIFont	Empty state text font.
errorTextFont	UIFont	Error text font.
emptyTextColor	UIColor	Empty state text color.
errorTextColor	UIColor	Error state text color.
nameTextColor	UIColor	Sender/receiver name text color on a message bubble.
nameTextFont	UIFont	Sender/receiver name text appearance on a message bubble.
timestampTextColor	UIColor	Time stamp text color.
threadReplySeperatorColor	UIColor	Thread reply separator color.
threadReplyTextColor	UIColor	Thread reply text color.
threadReplyTextFont	UIFont	Thread reply text appearance.
hide(error:)	Bool	Hide the error view.
messageInformationConfiguration	MessageInformationConfiguration	Configuration for message information component.
reactionsConfiguration	ReactionsConfiguration	Configuration for reactions component.
setDateSeparatorPattern	(Int?) -> String	Modify the date pattern of the message list date separator.
setDatePattern	(Int?) -> String	Modify the date pattern.
setHeaderView	UIView	Set custom header view (now set(headerView:)).
setFooterView	UIView	Set custom footer view (now set(footerView:)).
setTextFormatters	[CometChatTextFormatter]	Set text formatters (now set(textFormatter:)).
setMentionsFormatters	[CometChatTextFormatter]	Set mentions formatters (merged into set(textFormatter:)).
setErrorStateView	UIView	Set custom error view (now set(errorView:)).
setEmptyStateView	UIView	Set custom empty state view (now set(emptyView:)).
setOnThreadRepliesClick	Closure	Callback for thread replies click (now set(onThreadRepliesClick:)).

---

Message Composer

New Properties

Name	Type	Description
placeHolderTextFont	UIFont	Font for the placeholder text in the input field.
placeHolderTextColor	UIColor	Color for the placeholder text in the input field.
textFiledColor	UIColor	Text color for the input field.
textFiledFont	UIFont	Font for the input field text.
backgroundColor	UIColor	Background color with dynamic support for light and dark mode.
cornerRadius	CometChatCornerStyle	Corner radius for the composer.
borderWidth	CGFloat	Border width for the composer.
borderColor	UIColor	Border color for the composer.
sendButtonImage	UIImage	Icon for the send button.
sendButtonImageTint	UIColor	Tint color for the send button image.
activeSendButtonImageBackgroundColor	UIColor	Background color for the send button when active.
inactiveSendButtonImageBackgroundColor	UIColor	Background color for the send button when inactive.
composeBoxBackgroundColor	UIColor	Background color for the compose box.
composeBoxBorderColor	UIColor	Border color for the compose box.
composeBoxBorderWidth	CGFloat	Border width for the compose box.
composerBoxCornerRadius	CometChatCornerStyle	Corner radius for the compose box.
composerSeparatorColor	UIColor	Color for the separator in the compose box.
attachmentImage	UIImage	Icon for the attachment button.
attachmentImageTint	UIColor	Tint color for the attachment image.
voiceRecordingImage	UIImage	Icon for the voice recording button.
voiceRecordingImageTint	UIColor	Tint color for the voice recording image.
aiImage	UIImage	Icon for the AI button.
aiImageTint	UIColor	Tint color for the AI image.
stickerImage	UIImage	Icon for the sticker button.
stickerTint	UIColor	Tint color for the sticker image.
editPreviewTitleTextFont	UIFont	Font for the title in the edit preview.
editPreviewMessageTextFont	UIFont	Font for the message text in the edit preview.
editPreviewTitleTextColor	UIColor	Text color for the title in the edit preview.
editPreviewMessageTextColor	UIColor	Text color for the message in the edit preview.
editPreviewBackgroundColor	UIColor	Background color for the edit preview.
editPreviewCornerRadius	CometChatCornerStyle	Corner radius for the edit preview.
editPreviewBorderColor	UIColor	Border color for the edit preview.
editPreviewBorderWidth	CGFloat	Border width for the edit preview.
editPreviewCloseIcon	UIImage	Icon for closing the edit preview.
editPreviewCloseIconTint	UIColor	Tint color for the close icon in the edit preview.
infoIcon	UIImage	Icon for the info button.
infoIconTint	UIColor	Tint color for the info icon.
infoTextColor	UIColor	Text color for the info text.
infoTextFont	UIFont	Font for the info text.
infoSeparatorColor	UIColor	Color for the separator in the info section.
infoBackgroundColor	UIColor	Background color for the info section.
infoCornerRadius	CometChatCornerStyle	Corner radius for the info section.
infoBorderColor	UIColor	Border color for the info section.
infoBorderWidth	CGFloat	Border width for the info section.
setInitialComposerText	String	Sets the initial text in the composer when it loads.
disableTypingEvents	Bool	Disables sending typing indicators when the user types.
disableMentions	Bool	Disables the mention feature in the composer.
hideImageAttachmentOption	Bool	Hides the option to attach images.
hideVideoAttachmentOption	Bool	Hides the option to attach videos.
hideAudioAttachmentOption	Bool	Hides the option to attach audio files.
hideFileAttachmentOption	Bool	Hides the option to attach files.
hidePollsOption	Bool	Hides the option to create polls.
hideCollaborativeDocumentOption	Bool	Hides the option for collaborative documents.
hideCollaborativeWhiteboardOption	Bool	Hides the option for collaborative whiteboards.
hideAttachmentButton	Bool	Hides the attachment button in the composer.
hideVoiceRecordingButton	Bool	Hides the voice recording button.
hideStickersButton	Bool	Hides the stickers button.
hideSendButton	Bool	Hides the send button.
set(user:)	User	Sets the user for direct messaging.
set(group:)	Group	Sets the group for group messaging.
set(parentMessageId:)	Int	Sets the parent message ID for replying in a thread.
set(maxLine:)	Int	Sets the maximum number of lines for the composer input.
set(customSoundForMessages:)	URL?	Sets a custom sound for sending messages.
disableSoundForMessages	Bool	Disables sound while sending messages.
set(onSendButtonClick:)	(BaseMessage) -> Void	Override the action triggered upon pressing the send button.
set(onTextChanged:)	(String) -> Void	Activated when the user starts typing in message composer.
set(onError:)	(CometChatException) -> Void	Triggered when an error occurs.
set(attachmentOptions:)	(User?, Group?, UIViewController?) -> [CometChatMessageComposerAction]	Sets a list of custom MessageComposerActions.
set(sendButtonView:)	(User?, Group?) -> UIView	Sets a custom send button for the MessageComposer Component.
set(headerView:)	(User?, Group?) -> UIView	Sets a custom header view for the MessageComposer Component.
set(footerView:)	(User?, Group?) -> UIView	Sets a custom footer view for the MessageComposer Component.
set(textFormatter:)	[CometChatTextFormatter]	Assigns the list of text formatters.
set(controller:)	UIViewController	Sets the controller (mandatory for proper configuration).
mediaRecorderStyle	MediaRecorderStyle	Customizes the media recording styling.
aiOptionsStyle	AIOptionsStyle	Customizes the AI options styling.

Renamed Properties

Name	Type	Description	Old Name
backgroundColor	UIColor	Background color for the component.	background
hideVoiceRecordingButton	Bool	Hides the voice recording button.	hide(voiceRecording:)
disableTypingEvents	Bool	Disables sending typing indicators.	disable(disableTypingEvents:)
disableSoundForMessages	Bool	Disables sound while sending messages.	disable(disableSoundForMessages:)
set(textFormatter:)	[CometChatTextFormatter]	Assigns the list of text formatters.	setMentionsFormatters

Removed Properties

Name	Type	Description
inputBackground	UIColor	Input background color of message composer.
textFont	UIFont	Input text font of message composer.
inputBoxPlaceholderFont	UIFont	Placeholder text font for message composer input field.
attachmentIconTint	UIColor	Attachment icon tint color.
sendIconTint	UIColor	Send button icon tint color.
separatorTint	UIColor	Separator color for message composer.
inputBorderWidth	CGFloat	Border width for message composer input view.
inputBorderColor	UIColor	Border color for message composer input view.
actionSheetTitleColor	UIColor	Title color for action sheet of message composer.
actionSheetTitleFont	UIFont	Title font for action sheet of message composer.
actionSheetLayoutModelIconTint	UIColor	Action sheet layout mode icon tint color.
actionSheetCancelButtonIconTint	UIColor	Action sheet cancel button icon tint color.
actionSheetCancelButtonIconFont	UIFont	Action sheet cancel button icon font color.
actionSheetSeparatorTint	UIColor	Separator color for action sheet items.
actionSheetBackground	UIColor	Background color of action sheet.
voiceRecordingIconTint	UIColor	Voice recorder icon tint color.
aiIconTint	UIColor	AI icon tint color.
set(background:)	UIColor	Background color for message composer.
set(placeholderText:)	String	Message composer’s placeholder text.
set(maxLines:)	Int	Limit for lines of text in input field.
set(auxiliaryButtonAlignment:)	AuxiliaryButtonAlignment	Position for auxiliary buttons view.
set(customSoundForMessage:)	URL	Custom sounds for outgoing messages.
set(liveReactionIconURL:)	UIImage	Custom live reaction icon.
set(disableMentions:)	Bool	Enables/Disables user mentions in message composer input field.
set(infoIcon:)	UIImage	Image for info icon (now part of style).
set(attachmentIcon:)	UIImage	Image for attachment button on message composer.
set(aiAuxiliaryIcon:)	UIImage	Image for AI auxiliary button.
setOnSendButtonClick	Closure	Custom actions for send button click.
hide(liveReaction:)	Bool	Toggles visibility for live reaction component.
hide(footerView:)	Bool	Toggles visibility for footer view of message composer.
hide(headerView:)	Bool	Toggles visibility for header view of message composer.
hide(sendButton:)	Bool	Toggles visibility for send button.
setAttachmentOptions	Closure	List of custom MessageComposerActions.
setAuxilaryButtonView	Closure	Custom auxiliary button view.
setSecondaryButtonView	Closure	Custom secondary button view.
setSendButtonView	Closure	Custom send button view.