CometChatUI
CometChatUI is an option to launch a fully functional chat application using the UI Kit. In CometChatUI all the UI Components are interlinked and work together to launch a fully functional chat on your website/application.
Parameter | Description | Type |
---|---|---|
chatWithUser | The ID of the user you want to chat with | Optional |
chatWithGroup | The ID of the group you want to chat with | Optional |
friendsOnly | Value could be true or false This property when set to true will return only the friends of the logged-in user in the users tab. | Optional |
friendsOnly prop is deprecated from version v3.0.0-beta5-1. Please use userListMode variable
Customize UI Kit
Customize UI Kit
CometChatUserListWithMessages
TheCometChatUserListWithMessages
is a component with a list of users. The component has all the necessary listeners and methods required to display the user’s list and shows the set of the messages/chats of the selected user.

Parameter | Description | Type |
---|---|---|
chatWithUser | The ID of the user you want to chat with | Optional |
friendsOnly | Value could be true or false This property when set to true will return only the friends of the logged-in user. | Optional |
friendsOnly prop is deprecated from version v3.0.0-beta5-1. Please use userListMode variable of UIKitSettings class for displaying only friends in the user list.
Please refer to this link for documentation: Customize UI Kit
Please refer to this link for documentation: Customize UI Kit
CometChatGroupListWithMessages
TheCometChatGroupListWithMessages
is a component with a list of groups. The component has all the necessary listeners and methods required to display the group’s list and shows the set of the messages/chats of the selected group.

Parameter | Description | Type |
---|---|---|
chatWithGroup | The ID of the group you want to chat with | Optional |
CometChatConversationListWithMessages
TheCometChatConversationListWithMessages
is a component with a list of recent conversations. The component has all the necessary listeners and methods required to display the recent conversation list and shows the set of the messages/chats of the selected recent conversation

Parameter | Description | Type |
---|---|---|
chatWithUser | The ID of the user you want to chat with | Optional |
chatWithGroup | The ID of the group you want to chat with | Optional |
CometChatMessages
TheCometChatMessages
is a component that displays the list of messages for a particular user or group.
Parameter | Description | Type |
---|---|---|
chatWithUser | The ID of the user you want to chat with | Required |
chatWithGroup | The ID of the group you want to chat with | Optional |
CometChatUserList
TheCometChatUserList
is a component that displays the list of users available to chat. You can use this component within your app if you wish to display the list of users.

Parameter | Description | Type |
---|---|---|
friendsOnly | Value could be true or false. This property when set to true will return only the friends of the logged-in user. | Optional |
friendsOnly prop is deprecated from version v3.0.0-beta5-1. Please use userListMode variable of UIKitSettings class for displaying only friends in the user list. Please refer to this link for documentation: Customize UI Kit
CometChatGroupList
TheCometChatGroupList
is a component that displays the list of groups available. You can use this component within your app if you wish to display the list of groups.

CometChatConversationList
You can use theCometChatConversationList
component to display the list of recent conversations that the logged-in user was a part of.
