Property Changes - CometChat Docs

Quick Reference for AI Agents & Developers

Scope: All component property changes from v4 → v5
Components covered: Conversations, MessageList, MessageComposer, MessageHeader, Users, Groups, GroupMembers, CallButtons, CallLogs, IncomingCall, OutgoingCall, OngoingCall
Related: Upgrading From V4 · Components Overview · Getting Started

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	Used to set a background image for the conversation screen.
separatorColor	UIColor	Used to set the color of separators in the conversation list.
separatorWidth	CGFloat	Used to set the width of separators in the conversation list.
errorTextColor	UIColor	Used to set the color of error messages in the conversation UI.
lastMessageTextColor	UIColor	Used to set the color of the last message text in the conversation list.
typingIndicatorColor	UIColor	Used to set the color of the typing indicator in the conversation UI.
lastMessageAppearance	UIFont	Used to customize the appearance of the last message text in the list.
threadIndicatorAppearance	UIFont	Used to customize the appearance of thread indicators in the list.
dateTimeFormatter.time	Closure	Called to format a timestamp as a standard time (e.g., “12:30 PM”).
dateTimeFormatter.today	Closure	Called when rendering messages sent today.
dateTimeFormatter.yesterday	Closure	Called for yesterday’s messages.
dateTimeFormatter.lastweek	Closure	Called for messages within the last week.
dateTimeFormatter.otherDay	Closure	Called for dates older than last week.
dateTimeFormatter.minute	Closure	Called when referring to “a minute ago”.
dateTimeFormatter.minutes	Closure	Called for “x minutes ago”.
dateTimeFormatter.hour	Closure	Called for “an hour ago”.
dateTimeFormatter.hours	Closure	Called for “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	Used to control visibility of separators in the list view (replaced by style properties).
disable(typing: Bool)	Bool	Used to toggle visibility of typing indicator.
setDatePattern	Method	Method to 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]	Used to define custom options for each user.
add(options:)	[CometChatUserOption]	Used to dynamically add options to users.
set(leadingView:)	(User) -> UIView	Custom leading view to be rendered for each user in the fetched list.
set(titleView:)	(User) -> UIView	Custom title view to be rendered for each user in the fetched list.
set(trailingView:)	(User) -> UIView	Custom trailing view to be rendered 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 for table view 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 in the search bar.
searchBarStyle	UISearchBar.Style	Style of the search bar (e.g., default, prominent).
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 within the list or navigation bar.
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 (buttons, icons).
errorTitleTextFont	UIFont	Font for the error title displayed in UI.
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 in error states.
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 (when no users/items are present).
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 in the list.
headerTitleFont	UIFont	Font for section header titles.

Renamed Properties

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

Removed Properties

Name	Type	Description
set(loadingStateView:)	UIActivityIndicatorView.Style	Used to set size of loading view icon while fetching the list of users.
hide(errorText:)	Bool	Used to hide error text on fetching users.
show(backButton:)	Bool	Used to toggle visibility for back button.
set(searchIcon:)	UIImage?	Used to set search Icon in the search field.
hide(search:)	Bool	Used to toggle visibility for search box.
hide(separator:)	Bool	Used to hide the divider separating the user items.
disable(userPresence:)	Bool	Used to control visibility of user indicator shown if user is online.
set(emptyStateText:)	String	Used to set a custom text response when fetching the users has returned an empty list.
set(errorStateText:)	String	Used to set a custom text response when some error occurs on fetching the list of users.
set(searchPlaceholder:)	String	Used to set search placeholder text.
set(title:mode:)	String, UINavigationItem.LargeTitleDisplayMode	Used to set title in the app with display mode.
setOnLoad	([User]) -> Void	Gets triggered when a user list is fully fetched and displayed on the screen.

Groups

New Properties

Name	Type	Description
set(onSelection:)	Closure	Gets triggered when selection mode is set to multiple or single. Triggers on every selection and returns the list of selected groups.
set(onEmpty:)	Closure	Gets triggered when the groups list is empty in CometChatGroups.
setOnLoad	Closure	Gets triggered when a group list is fully fetched and going to be displayed on the screen. Returns the list of groups to be 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, defaults to the secondary icon color from CometChatTheme.
searchBarStyle	UISearchBarStyle	Style of the search bar, defaulting to the standard style.
searchTintColor	UIColor	Tint color for the search bar, defaults to the primary color from CometChatTheme.
searchBarTintColor	UIColor	Background color of the search bar, defaulting to clear.
searchBarPlaceholderTextColor	UIColor	Placeholder text color for the search bar, defaults to the tertiary text color from CometChatTheme.
searchBarPlaceholderTextFont	UIFont	Font used for the placeholder text in the search bar, defaults to regular body font.
searchBarTextColor	UIColor	Color of the text entered in the search bar, defaults to the primary text color from CometChatTheme.
searchBarTextFont	UIFont	Font used for the text in the search bar, defaults to regular body font.
searchBarBackgroundColor	UIColor	Background color of the search bar, defaults to a specific background color from CometChatTheme.
searchBarCancelIconTintColor	UIColor	Tint color for the cancel icon in the search bar, defaults to the primary color from CometChatTheme.
searchBarCrossIconTintColor	UIColor	Tint color for the cross icon in the search bar, defaults to the secondary icon color from CometChatTheme.
backgroundColor	UIColor	Background color of the overall view, defaults to a specific background color from CometChatTheme.
borderWidth	CGFloat	Width of the border around the view, defaults to 0 (no border).
borderColor	UIColor	Color of the border around the view, defaults to clear.
cornerRadius	CometChatCornerStyle	Corner radius settings for the view, defaults to no corner radius.
titleColor	UIColor	Color for the title text, defaults to the primary text color from CometChatTheme.
titleFont	UIFont	Font used for the title text, defaults to nil (not set).
largeTitleColor	UIColor	Color for the large title text, defaults to the primary text color from CometChatTheme.
largeTitleFont	UIFont	Font used for the large title text, defaults to nil (not set).
navigationBarTintColor	UIColor	Background color of the navigation bar, defaults to a specific background color from CometChatTheme.
navigationBarItemsTintColor	UIColor	Tint color for items in the navigation bar, defaults to the highlight color from CometChatTheme.
errorTitleTextFont	UIFont	Font used for the error title text, defaults to a bold heading 3 font from CometChatTypography.
errorTitleTextColor	UIColor	Color of the error title text, defaults to the primary text color from CometChatTheme.
errorSubTitleFont	UIFont	Font used for the error subtitle text, defaults to regular body font.
errorSubTitleTextColor	UIColor	Color of the error subtitle text, defaults to the secondary text color from CometChatTheme.
retryButtonTextColor	UIColor	Color for the retry button text, defaults to button text color from CometChatTheme.
retryButtonTextFont	UIFont	Font used for the retry button text, defaults to medium button font from CometChatTypography.
retryButtonBackgroundColor	UIColor	Background color for the retry button, defaults to the primary color from CometChatTheme.
retryButtonBorderColor	UIColor	Border color for the retry button, defaults to clear.
retryButtonBorderWidth	CGFloat	Width of the border around the retry button, defaults to 0 (no border).
retryButtonCornerRadius	CometChatCornerStyle	Corner radius settings for the retry button, defaults to a specific corner radius from CometChatSpacing.
emptyTitleTextFont	UIFont	Font used for the empty state title text, defaults to a bold heading 3 font from CometChatTypography.
emptyTitleTextColor	UIColor	Color of the empty state title text, defaults to the primary text color from CometChatTheme.
emptySubTitleFont	UIFont	Font used for the empty state subtitle text, defaults to regular body font.
emptySubTitleTextColor	UIColor	Color of the empty state subtitle text, defaults to the secondary text color from CometChatTheme.
tableViewSeparator	UIColor	Color of the table view separator, defaults to clear.
listItemTitleTextColor	UIColor	Color of the title text in list items, defaults to the primary text color from CometChatTheme.
listItemTitleFont	UIFont	Font used for the title text in list items, defaults to medium heading 4 font from CometChatTypography.
listItemSubTitleTextColor	UIColor	Color of the subtitle text in list items, defaults to the secondary text color from CometChatTheme.
listItemSubTitleFont	UIFont	Font used for the subtitle text in list items, defaults to regular body font.
listItemBackground	UIColor	Background color for list items, defaults to clear.
listItemSelectedBackground	UIColor	Background color for list items if selected, defaults to clear.
listItemBorderWidth	CGFloat	Width of the border around list items, defaults to 0 (no border).
listItemBorderColor	UIColor	Color of the border around list items, defaults to the light border color from CometChatTheme.
listItemCornerRadius	CometChatCornerStyle	Corner radius settings for list items, defaults to no corner radius.
listItemSelectionImageTint	UIColor	Tint color for the selection image in list items, defaults to the highlight color from CometChatTheme.
listItemDeSelectedImageTint	UIColor	Tint color for the deselected image in list items.
passwordGroupImageTintColor	UIColor	Tint color for the password group image, defaults to the background color from CometChatTheme.
passwordGroupImageBackgroundColor	UIColor	Background color for the password group image, defaults to the warning color from CometChatTheme.
privateGroupImageTintColor	UIColor	Tint color for the private group image, defaults to the background color from CometChatTheme.
privateGroupImageBackgroundColor	UIColor	Background color for the private group image, defaults to the success color from CometChatTheme.
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]	Allows you to define custom options for each group. Returns an array of CometChatGroupOption based on the group object.
add(options:)	(Group?) -> [CometChatGroupOption]	Dynamically adds options to groups. Returns additional CometChatGroupOption elements.
set(leadingView:)	(Group?) -> UIView	Allows you to modify the leading view of a group cell.
set(titleView:)	(Group?) -> UIView	Allows you to customize the title view of a group cell.
set(trailingView:)	(Group?) -> UIView	Allows you to modify the trailing view of a group cell.

Renamed Properties

Name	Type	Description	Old Name
set(onItemClick:)	Closure	Triggered when you click on a ListItem of the groups component.	SetOnItemClick
set(OnItemLongClick:)	Closure	Triggered when you long press on a ListItem of the groups component.	SetOnItemLongClick
set(onError:)	Closure	Triggered when an error occurs in CometChatGroups.	SetOnError
set(onBack:)	Closure	Triggered when the back button is pressed in CometChatGroups.	SetOnBack
SetListItemView	(Group?) -> UIView	Assigns a custom ListItem to the Groups Component.	setListItemView
set(subtitle:)	(Group?) -> UIView	Allows you to customize 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:)
hideUserStatus	Bool	Hide user presence. If set to true, the status indicator is not displayed.	disableUsersPresence
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	Sets the back button tint color.
searchIconTint	UIColor	Sets the search icon tint color.
searchTextFont	UIFont	Sets the search text font.
searchTextColor	UIColor	Sets the search text color.
searchCancelButtonTint	UIColor	Sets the search cancel icon tint.
searchPlaceholderFont	UIFont	Sets the search placeholder font.
searchPlaceholderColor	UIColor	Sets the search placeholder color.
addButtonTint	UIColor	Sets add button color.
addButtonFont	UIFont	Sets add button font.
avatarStyle	AvatarStyle	Styles to apply to the avatar component of the default list item view.
statusIndicatorStyle	CSSProperties	Styles to apply to the status indicator component of the default list item view.
listItemStyle	ListItemStyle	Styles to apply to the default list item view.
groupScopeStyle	ChangeScopeStyle	Styles to apply to the change scope component.
groupMembersStyle	GroupMembersStyle	Styles to apply to 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	Sets the icon for the search bar.
set(searchClearIcon:)	UIImage	Sets the clear icon for the search bar.
set(searchBarHeight:)	CGFloat	Set the 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 to be displayed when the search input has no value.
fetchTimeOut	any	Timeout reference for fetching users.
userPresencePlacement	UserPresencePlacement	Placement of user presence information within the user interface.
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 to use in the search bar.
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 as well.

Message Header

New Properties

Name	Type	Description
titleTextColor	UIColor	Used to set the text color of the header title.
titleTextFont	UIFont	Used to set the font style of the header title.
subtitleTextColor	UIColor	Used to set the text color of the subtitle in the header.
subtitleTextFont	UIFont	Used to set the font style of the subtitle in the header.
backButtonImageTintColor	UIColor	Used to set the tint color of the back button image in the header.
privateGroupBadgeImageTintColor	UIColor	Used to set the tint color of the private group badge in the header.
passwordProtectedGroupBadgeImageTintColor	UIColor	Used to set the tint color of the password-protected group badge in the header.
privateGroupImageBackgroundColor	UIColor	Used to set the background color of the private group badge.
passwordGroupImageBackgroundColor	UIColor	Used to set the background color of the password-protected group badge.
groupImageBackgroundColor	UIColor	Used to set the background color for group icons in the header.
avatarStyle	AvatarStyle	Used to customize the appearance of the avatar in the header.
backgroundColor	UIColor	Used to set the background color of the header.
cornerRadius	CometChatCornerStyle	Used to set the corner radius of the header.
borderWidth	CGFloat	Used to set the border width of the header.
borderColor	UIColor	Used to set the border color of the header.
backButtonIcon	UIImage	Used to set a custom icon for the back button.
privateGroupIcon	UIImage	Used to set a custom icon for private groups.
protectedGroupIcon	UIImage	Used to set a custom icon for password-protected groups.
backgroundImage	UIImage	Used to set a background image for the header.
hideBackButton	Bool	Hides the back button of message header.
hideUserStatus	Bool	Hides or shows the user status of user (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	Sets the background color for the component.	background
backButtonImageTintColor	UIColor	Sets the 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 of user.	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	Sets the typing indicator text font.
typingIndicatorTextColor	UIColor	Sets the typing indicator text color.
detailIconTint	UIColor	Sets the tint color for detail icon for message header.
onlineStatusColor	UIColor	Sets the online status color for message header.
privateGroupIconBackgroundColor	UIColor	Sets the private group background color for message header (replaced by privateGroupImageBackgroundColor).
protectedGroupIconBackgroundColor	UIColor	Sets the protected group background color for message header (replaced by passwordGroupImageBackgroundColor).
set(protectedGroupIcon:)	UIImage	Used to set custom protected group icon.
set(privateGroupIcon:)	UIImage	Used to set custom private group icon.
disable(typing:)	Bool	Used to 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 of message bubble.
set(onReactionClick:)	(CometChat.ReactionCount, BaseMessage) -> Void	Triggered when you click on a reaction on a message bubble.
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 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 messages are available.
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	Sets the 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	Used to set loading icon tint.
emptyTextFont	UIFont	Used to set empty state text font.
errorTextFont	UIFont	Used to set error text font.
emptyTextColor	UIColor	Used to set empty state text color.
errorTextColor	UIColor	Used to set error state text color.
nameTextColor	UIColor	Used to set sender/receiver name text color on a message bubble.
nameTextFont	UIFont	Used to set sender/receiver name text appearance on a message bubble.
timestampTextColor	UIColor	Used to set time stamp text color.
threadReplySeperatorColor	UIColor	Used to set thread reply separator color.
threadReplyTextColor	UIColor	Used to set thread reply text color.
threadReplyTextFont	UIFont	Used to set thread reply text appearance.
hide(error:)	Bool	Used to hide the error view.
messageInformationConfiguration	MessageInformationConfiguration	Configuration for message information component.
reactionsConfiguration	ReactionsConfiguration	Configuration for reactions component.
setDateSeparatorPattern	(Int?) -> String	Used to modify the date pattern of the message list date separator.
setDatePattern	(Int?) -> String	Used to modify the date pattern.
setHeaderView	UIView	Used to set custom header view (now set(headerView:)).
setFooterView	UIView	Used to set custom footer view (now set(footerView:)).
setTextFormatters	[CometChatTextFormatter]	Used to set text formatters (now set(textFormatter:)).
setMentionsFormatters	[CometChatTextFormatter]	Used to set mentions formatters (merged into set(textFormatter:)).
setErrorStateView	UIView	Used to set custom error view (now set(errorView:)).
setEmptyStateView	UIView	Used to 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	Gets 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	Sets the background color for the component.	background
hideVoiceRecordingButton	Bool	Hides the voice recording button.	hide(voiceRecording:)
disableTypingEvents	Bool	Disables sending typing indicators when the user types.	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	Sets the input background color of message composer.
textFont	UIFont	Sets the input text font of message composer.
inputBoxPlaceholderFont	UIFont	Sets the placeholder text font for message composer input field.
placeHolderTextColor	UIColor	Sets the placeholder text color for message composer input field (renamed with different casing).
attachmentIconTint	UIColor	Sets the attachment icon tint color.
sendIconTint	UIColor	Sets send button icon tint color.
separatorTint	UIColor	Sets the separator color for message composer.
inputBorderWidth	CGFloat	Sets the border width for message composer input view.
inputBorderColor	UIColor	Sets the border color for message composer input view.
actionSheetTitleColor	UIColor	Sets the title color for action sheet of message composer.
actionSheetTitleFont	UIFont	Sets the title font for action sheet of message composer.
actionSheetLayoutModelIconTint	UIColor	Sets action sheet layout mode icon tint color for message composer.
actionSheetCancelButtonIconTint	UIColor	Sets action sheet cancel button icon tint color for message composer.
actionSheetCancelButtonIconFont	UIFont	Sets the action sheet cancel button icon font color for message composer.
actionSheetSeparatorTint	UIColor	Sets the separator color for action sheet items.
actionSheetBackground	UIColor	Sets the background color of action sheet.
voiceRecordingIconTint	UIColor	Sets the voice recorder icon tint color.
aiIconTint	UIColor	Sets the ai icon tint color.
infoTextColor	UIColor	Sets the text color for info message displayed (now part of style).
infoIconTintColor	UIColor	Sets the tint color for info icon.
infoBackgroundColor	UIColor	Sets the background color for info message view (now part of style).
infoSeparatorColor	UIColor	Sets the separator color for info view (now part of style).
set(background:)	UIColor	Sets background color for message composer.
set(placeholderText:)	String	Sets message composer’s placeholder text.
set(maxLines:)	Int	Sets limit for lines of text to be displayed in input field.
set(auxiliaryButtonAlignment:)	AuxiliaryButtonAlignment	Sets position for auxiliary buttons view.
set(customSoundForMessage:)	URL	Sets custom sounds for outgoing messages.
set(liveReactionIconURL:)	UIImage	Sets custom live reaction icon.
set(disableMentions:)	Bool	Enables/Disables user mentions in message composer input field.
set(infoIcon:)	UIImage	Sets image for info icon (now part of style).
set(attachmentIcon:)	UIImage	Sets image for attachment button on message composer.
set(aiAuxiliaryIcon:)	UIImage	Sets image for ai auxillary button.
setOnSendButtonClick	Closure	Sets 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	Sets a list of custom MessageComposerActions.
setAuxilaryButtonView	Closure	Sets custom auxiliary button view.
setSecondaryButtonView	Closure	Sets custom secondary button view.
setSendButtonView	Closure	Sets custom send button view.

Call Logs

New Properties

Name	Type	Description
listItemTitleTextColor	UIColor	Text color for the list item title.
listItemTitleFont	UIFont	Font for the list item title.
listItemSubTitleTextColor	UIColor	Text color for the list item subtitle.
listItemSubTitleFont	UIFont	Font for the list item subtitle.
listItemBackground	UIColor	Background color for the list item.
listItemSelectedBackground	UIColor	Background color for the selected list item.
listItemBorderWidth	CGFloat	Border width for the list item.
listItemBorderColor	UIColor	Border color for the list item.
listItemCornerRadius	CometChatCornerStyle	Corner radius for the list item.
listItemSelectionImageTint	UIColor	Tint color for the selection image.
listItemDeSelectedImageTint	UIColor	Tint color for the deselected image.
listItemSelectedImage	UIImage	Image for the selected list item.
listItemDeSelectedImage	UIImage	Image for the deselected list item.
backgroundColor	UIColor	Background color.
borderWidth	CGFloat	Border width.
borderColor	UIColor	Border color.
cornerRadius	CometChatCornerStyle	Corner radius.
titleColor	UIColor	Text color for the title.
titleFont	UIFont	Font for the title.
largeTitleColor	UIColor	Text color for large titles.
largeTitleFont	UIFont	Font for large titles.
navigationBarTintColor	UIColor	Background color for the navigation bar.
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 error subtitle.
errorSubTitleTextColor	UIColor	Text color for the error subtitle.
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 empty state subtitle.
emptySubTitleTextColor	UIColor	Text color for the empty state subtitle.
tableViewSeparator	UIColor	Color for the table view separator.
backIcon	UIImage	Icon for the back button.
backIconTint	UIColor	Tint color for the back icon.
incomingCallIcon	UIImage	Icon for incoming calls.
incomingCallIconTint	UIColor	Tint color for the incoming call icon.
outgoingCallIcon	UIImage	Icon for outgoing calls.
outgoingCallIconTint	UIColor	Tint color for the outgoing call icon.
missedCallTitleColor	UIColor	Text color for missed call titles.
missedCallIcon	UIImage	Icon for missed calls.
missedCallIconTint	UIColor	Tint color for the missed call icon.
audioCallIcon	UIImage	Icon for audio calls.
audioCallIconTint	UIColor	Tint color for the audio call icon.
videoCallIcon	UIImage	Icon for video calls.
videoCallIconTint	UIColor	Tint color for the video call icon.
separatorColor	UIColor	Color for separators.
set(callRequestBuilder:)	CallLogsRequest.CallLogsBuilder	Sets the CallLogsBuilder instance for call logs.
hideError	Bool	Hides the error state view.
hideNavigationBar	Bool	Hides the navigation bar.
hideLoadingState	Bool	Hides the loading state view.
hideBackIcon	Bool	Hides the back icon in the navigation bar.
set(onItemClick:)	(CallLog, IndexPath) -> Void	Triggered when you click on a ListItem.
set(onItemLongClick:)	(CallLog, IndexPath) -> Void	Triggered when you long press on a ListItem.
set(onBack:)	() -> Void	Triggered when back button is pressed.
set(onError:)	(CometChatException) -> Void	Triggered when an error occurs.
set(onEmpty:)	() -> Void	Triggers when the call logs list is empty.
set(onLoad:)	([CallLog]) -> Void	Triggers when call logs are successfully loaded.
set(listItemView:)	(CallLog) -> UIView	Assigns a custom ListItem to the CallLogs component.
set(titleView:)	(CallLog) -> UIView	Sets a custom title view for call log cells.
set(leadingView:)	(CallLog) -> UIView	Sets a custom leading view for call log cells.
set(subtitleView:)	(CallLog) -> UIView	Sets a custom subtitle view for call log cells.
set(trailView:)	(CallLog) -> UIView	Sets a custom trailing view for call log cells.
set(emptyView:)	UIView	Sets a custom empty state view.
set(errorView:)	UIView	Sets a custom error view.
set(menus:)	[UIBarButtonItem]	Sets custom menus to add more options.
avatarStyle	AvatarStyle	Customizes the appearance of avatars.

Renamed Properties

Name	Type	Description	Old Name
set(onItemClick:)	(CallLog, IndexPath) -> Void	Triggered when you click on a ListItem.	setOnItemClick
set(onError:)	(CometChatException) -> Void	Triggered when an error occurs.	set(onError:)

Removed Properties

Name	Type	Description
backButtonFont	UIFont	Sets the font for the back button.
backButtonIcon	UIImage	Sets the icon for the back button.
backButtonTint	UIColor	Sets the tint for the back button.
backButtonTitle	String?	Sets the title for the back button.
backButtonTitleColor	UIColor	Sets the title color for the back button.
background	[CGColor]?	Sets the background.
corner	CometChatCornerStyle	Sets the corner style.
emptyStateText	String	Sets the text for empty state.
emptyStateTextFont	UIFont	Sets the font for empty state text.
errorStateText	String	Sets the text for error state.
errorStateTextColor	UIColor	Sets the text color for error state.
errorStateTextFont	UIFont	Sets the font for error state text.
searchBackground	UIColor	Sets the background for the search bar.
searchBarHeight	CGFloat	Sets the height for the search bar.
searchBorderColor	UIColor	Sets the border color for the search bar.
searchCancelButtonFont	UIFont	Sets the font for the search cancel button.
searchCancelButtonTint	UIColor	Sets the tint for the search cancel button.
searchClearIcon	UIImage	Sets the icon for the search clear button.
searchCornerRadius	CometChatCornerStyle	Sets the corner radius for the search bar.
searchIcon	UIImage?	Sets the icon for the search bar.
searchPlaceholder	String	Sets the placeholder for the search bar.
searchTextColor	UIColor	Sets the color for the search text.
searchTextFont	UIFont	Sets the font for the search text.
set(title:mode:)	String, UINavigationItem.LargeTitleDisplayMode	Sets the title for the title bar.
titleColor	UIColor	Sets the color for the title (now part of style).
titleFont	UIFont	Sets the font for the title (now part of style).
hide(errorText:)	Bool	Hides the error text.
hide(search:)	Bool	Hides the search bar.
hide(separator:)	Bool	Hides the separator.
callStatusTextFont	UIFont	Sets the call status font.
missedCallTitleTint	UIColor	Sets the missed call color.
callTimeTextFont	UIFont	Sets the call time font.
dateSeparatorTextFont	UIFont	Sets the date separator font.
emptyStateTextFont	UIFont	Sets the empty state font (now emptyTitleTextFont).
errorStateTextFont	UIFont	Sets the error state font (now errorTitleTextFont).
callStatusTextColor	UIColor	Sets the call status color.
callStatusIconTint	UIColor	Sets the call status icon tint.
callTimeTextColor	UIColor	Sets the call time color.
dateSeparatorTextColor	UIColor	Sets the date separator color.
infoIconTint	UIColor	Sets the info icon tint.
listItemStyle	ListItemStyle	Styles to apply to each call log item.

Call Buttons

New Properties

Name	Type	Description
videoCallIconTint	UIColor	Tint color for the video call icon.
videoCallTextFont	UIFont	Font for the video call button text.
videoCallTextColor	UIColor	Color for the video call button text.
videoCallButtonBackground	UIColor	Background color for the video call button.
videoCallButtonCornerRadius	CometChatCornerStyle	Corner radius for the video call button.
videoCallButtonBorder	CGFloat	Border width for the video call button.
videoCallButtonBorderColor	UIColor	Border color for the video call button.
videoCallIcon	UIImage	Icon for the video call button.
audioCallIconTint	UIColor	Tint color for the audio call icon.
audioCallTextFont	UIFont	Font for the audio call button text.
audioCallTextColor	UIColor	Color for the audio call button text.
audioCallButtonBackground	UIColor	Background color for the audio call button.
audioCallButtonCornerRadius	CometChatCornerStyle	Corner radius for the audio call button.
audioCallButtonBorder	CGFloat	Border width for the audio call button.
audioCallButtonBorderColor	UIColor	Border color for the audio call button.
audioCallIcon	UIImage	Icon for the audio call button.
hideVideoCallButton	Bool	Hides the video call button.
hideVoiceCallButton	Bool	Hides the voice call button.
set(user:)	User	Sets the User object for CometChatCallButtons.
set(group:)	Group	Sets the Group object for CometChatCallButtons.
set(outgoingCallConfiguration:)	OutgoingCallConfiguration	Sets the configuration for outgoing calls.
set(customSoundForCalls:)	URL	Sets a custom sound for incoming and outgoing calls.
set(callSettingBuilder:)	(CallType, [CallUser]) -> CallSettings	Function to build call settings based on call type and participants.
set(onVoiceCallClick:)	(User?, Group?) -> Void	Override the action triggered upon pressing the voice call button.
set(onVideoCallClick:)	(User?, Group?) -> Void	Override the action triggered upon pressing the video call button.
set(onError:)	(CometChatException) -> Void	Triggered when an error occurs.
set(controller:)	UIViewController	Sets the controller (mandatory for proper configuration).
style	CallButtonStyle	Customizes the appearance of the CallButtons component.

Renamed Properties

Name	Type	Description	Old Name
hideVideoCallButton	Bool	Hides the video call button.	hide(videoCall:)
hideVoiceCallButton	Bool	Hides the voice call button.	hide(voiceCall:)
set(onVoiceCallClick:)	(User?, Group?) -> Void	Override the action triggered upon pressing the voice call button.	setOnVoiceCallClick
set(onVideoCallClick:)	(User?, Group?) -> Void	Override the action triggered upon pressing the video call button.	setOnVideoCallClick
set(onError:)	(CometChatException) -> Void	Triggered when an error occurs.	setOnError

Removed Properties

Name	Type	Description
set(background:)	UIColor	Sets the background color.
set(textFont:)	UIFont	Sets the font of the text.
set(textColor:)	UIColor	Sets the color of the text.
set(cornerRadius:)	CometChatCornerStyle	Sets the corner radius.
set(borderColor:)	UIColor	Sets the color of the border.
set(borderWidth:)	CGFloat	Sets the width of the border.
set(iconBackground:)	UIColor	Sets the background of the icon.
set(iconBorder:)	CGFloat	Sets the border of the icon.
set(iconCornerRadius:)	CGFloat	Sets the corner radius of the icon.
set(iconTint:)	UIColor	Sets the tint of the icon.
set(callButtonsStyle:)	ButtonStyle	Sets the button style for call buttons.
set(isCenterAligned:)	Bool	Sets the alignment of the buttons.
set(videoCallIcon:)	UIImage	Sets the icon for the video call button (now part of style).
set(videoCallIconText:)	String	Sets the text for the video call button.
set(voiceCallIcon:)	UIImage	Sets the icon for the voice call button (now part of style).
set(voiceCallIconText:)	String	Sets the text for the voice call button.

Incoming Call

New Properties

Name	Type	Description
overlayBackgroundColor	UIColor	Background color for the overlay.
acceptButtonBackgroundColor	UIColor	Background color for the accept button.
rejectButtonBackgroundColor	UIColor	Background color for the reject button.
acceptButtonTintColor	UIColor	Tint color for the accept button.
rejectButtonTintColor	UIColor	Tint color for the reject button.
acceptButtonImage	UIImage	Icon image for the accept button.
rejectButtonImage	UIImage	Icon image for the reject button.
acceptButtonCornerRadius	CometChatCornerStyle	Sets corner radius for accept button.
rejectButtonCornerRadius	CometChatCornerStyle	Sets corner radius for reject button.
acceptButtonBorderWidth	CGFloat	Sets border width for accept button.
rejectButtonBorderWidth	CGFloat	Sets border width for reject button.
acceptButtonBorderColor	UIColor	Sets border color for accept button.
rejectButtonBorderColor	UIColor	Sets border color for reject button.
backgroundColor	UIColor	Background color for the call view.
cornerRadius	CometChatCornerStyle	Corner radius for the view.
borderColor	UIColor	Border color for the view.
borderWidth	CGFloat	Border width for the view.
callLabelColor	UIColor	Text color for the call label.
callLabelFont	UIFont	Font for the call label.
nameLabelColor	UIColor	Text color for the name label.
nameLabelFont	UIFont	Font for the name label.
disableSoundForCalls	Bool	Disables sound for incoming calls.
set(customSoundForCalls:)	URL	Sets a custom sound for incoming calls.
set(call:)	Call	Sets the call object for the incoming call.
set(onAcceptClick:)	(Call, UIViewController?) -> Void	Override the action triggered upon pressing the accept button.
set(onCancelClick:)	(Call, UIViewController?) -> Void	Override the action triggered upon pressing the reject button.
set(onError:)	(CometChatException) -> Void	Triggered when an error occurs.
set(listItemView:)	(Call) -> UIView	Assigns a custom view to the incoming call item view.
set(leadingView:)	(Call) -> UIView	Sets a custom leading view for incoming call.
set(titleView:)	(Call) -> UIView	Sets a custom title view for incoming call.
style	IncomingCallStyle	Customizes the appearance of the IncomingCall component.
avatarStyle	AvatarStyle	Customizes the appearance of avatars.

Renamed Properties

Name	Type	Description	Old Name
set(onAcceptClick:)	(Call, UIViewController?) -> Void	Override the action triggered upon pressing the accept button.	setOnAcceptClick
set(onCancelClick:)	(Call, UIViewController?) -> Void	Override the action triggered upon pressing the reject button.	setOnCancelClick
set(onError:)	(CometChatException) -> Void	Triggered when an error occurs.	setOnError

Removed Properties

Name	Type	Description
set(background:)	UIColor	Sets the background color for IncomingCall.
set(cornerRadius:)	CometChatCornerStyle	Sets the corner radius for IncomingCall.
set(borderWidth:)	CGFloat	Sets the border width for IncomingCall.
set(borderColor:)	UIColor	Sets the border color for IncomingCall.
set(titleColor:)	UIColor	Sets the title color for IncomingCall.
set(titleFont:)	UIFont	Sets the title font for IncomingCall.
set(subtitleColor:)	UIColor	Sets the subtitle color for IncomingCall.
set(subtitleFont:)	UIFont	Sets the subtitle font for IncomingCall.
set(incomingCallStyle:)	IncomingCallStyle	Sets the incoming call style.
set(avatarStyle:)	AvatarStyle	Sets the avatar style.
set(user:)	User	Sets the user object for the incoming call.
set(acceptButtonIcon:)	UIImage	Sets the icon for the accept button (now part of style).
set(declineButtonIcon:)	UIImage	Sets the icon for the decline button (now part of style).

Outgoing Call

New Properties

Name	Type	Description
backgroundColor	UIColor	Sets the background color for the outgoing call view.
borderColor	UIColor	Sets the border color for the outgoing call view.
borderWidth	CGFloat	Sets the border width for the outgoing call view.
cornerRadius	CometChatCornerStyle	Sets the corner radius for the outgoing call view.
nameTextColor	UIColor	Sets the text color for the name label in the outgoing call view.
nameTextFont	UIFont	Sets the font for the name label in the outgoing call view.
callTextColor	UIColor	Sets the text color for the call label in the outgoing call view.
callTextFont	UIFont	Sets the font for the call label in the outgoing call view.
declineButtonBackgroundColor	UIColor	Sets the background color for the decline button in the outgoing call view.
declineButtonIconTint	UIColor	Sets the tint color for the decline button icon.
declineButtonIcon	UIImage	Sets the icon for the decline button.
declineButtonCornerRadius	CometChatCornerStyle	Sets the corner radius for decline button.
declineButtonBorderColor	UIColor	Sets the border color for decline button.
declineButtonBorderWidth	CGFloat	Sets the border width for decline button.
nameLabel	UIFont	Sets the font for the name label.
callingLabel	UIFont	Sets the font for the call label.
disableSoundForCalls	Bool	Disables sound for outgoing calls.
set(customSoundForCalls:)	URL	Sets a custom sound for outgoing calls.
set(call:)	Call	Sets the Call object for CometChatOutgoingCall.
set(onCancelClick:)	(Call, UIViewController?) -> Void	Override the action triggered upon pressing the cancel button.
set(onError:)	(CometChatException) -> Void	Triggered when an error occurs.
set(avatarView:)	(Call) -> UIView	Sets a custom avatar view for outgoing call.
set(cancelView:)	(Call) -> UIView	Sets a custom cancel button view for outgoing call.
set(titleView:)	(Call) -> UIView	Sets a custom title view for outgoing call.
set(subtitleView:)	(Call) -> UIView	Sets a custom subtitle view for outgoing call.
style	OutgoingCallStyle	Customizes the appearance of the OutgoingCall component.
avatarStyle	AvatarStyle	Customizes the appearance of avatars.

Renamed Properties

Name	Type	Description	Old Name
set(onCancelClick:)	(Call, UIViewController?) -> Void	Override the action triggered upon pressing the cancel button.	setOnCancelClick
set(onError:)	(CometChatException) -> Void	Triggered when an error occurs.	setOnError

Removed Properties

Name	Type	Description
set(background:)	UIColor	Sets the background color.
set(cornerRadius:)	CometChatCornerStyle	Sets the corner radius.
set(borderWidth:)	CGFloat	Sets the border width.
set(borderColor:)	UIColor	Sets the border color.
set(titleColor:)	UIColor	Sets the title color.
set(titleFont:)	UIFont	Sets the title font.
set(subtitleColor:)	UIColor	Sets the subtitle color.
set(subtitleFont:)	UIFont	Sets the subtitle font.
set(outgoingCallStyle:)	OutgoingCallStyle	Sets the outgoing call style.
set(avatarStyle:)	AvatarStyle	Sets the avatar style.
set(buttonStyle:)	ButtonStyle	Sets the button style for outgoing call.
disable(soundForCalls:)	Bool	Disables the default sound for calls.
set(declineButtonIcon:)	UIImage	Sets the icon for the decline button (now part of style).
set(user:)	User	Sets the User object for CometChatOutgoingCall.

Next Steps

Upgrading From V4

Migration guide from v4 to v5

Getting Started

Set up the iOS UI Kit v5 from scratch

Components Overview

Explore all available UI components

Theme Introduction

New v5 theming system

​Conversations

​New Properties

​Renamed Properties

​Removed Properties

​Users

​New Properties

​Renamed Properties

​Removed Properties

​Groups

​New Properties

​Renamed Properties

​Removed Properties

​Group Members

​New Properties

​Renamed Properties

​Removed Properties

​Message Header

​New Properties

​Renamed Properties

​Removed Properties

​Message List

​New Properties

​Renamed Properties

​Removed Properties

​Message Composer

​New Properties

​Renamed Properties

​Removed Properties

​Call Logs

​New Properties

​Renamed Properties

​Removed Properties

​Call Buttons

​New Properties

​Renamed Properties

​Removed Properties

​Incoming Call

​New Properties

​Renamed Properties

​Removed Properties

​Outgoing Call

​New Properties

​Renamed Properties

​Removed Properties

​Next Steps

Upgrading From V4

Getting Started

Components Overview

Theme Introduction

Conversations

New Properties

Renamed Properties

Removed Properties

Users

New Properties

Renamed Properties

Removed Properties

Groups

New Properties

Renamed Properties

Removed Properties

Group Members

New Properties

Renamed Properties

Removed Properties

Message Header

New Properties

Renamed Properties

Removed Properties

Message List

New Properties

Renamed Properties

Removed Properties

Message Composer

New Properties

Renamed Properties

Removed Properties

Call Logs

New Properties

Renamed Properties

Removed Properties

Call Buttons

New Properties

Renamed Properties

Removed Properties

Incoming Call

New Properties

Renamed Properties

Removed Properties

Outgoing Call

New Properties

Renamed Properties

Removed Properties

Next Steps