Skip to main content

Documentation Index

Fetch the complete documentation index at: https://cometchat-22654f5b-react-uikit-v7.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

PackageMigration fromKey changesReference
@cometchat/chat-uikit-reactv6 → v7Plugin system replaces templates/textFormatters; compound components replace string props; individual hide*Option props consolidated; view props become render props on MessageBubbleMigration Overview

Common Patterns

These 10 patterns apply across all components. You do not need to look them up per-component:
#Patternv6v7Action Required
1View prop typesJSX.ElementReactNodeNone (backward-compatible)
2Date format typeCalendarObjectCometChatDateFormatConfigSame shape, type alias renamed
3hideError propbooleanRemovedUse errorView prop instead
4disableLoadingState propbooleanRemovedUse loadingView prop instead
5textFormatters on list componentsCometChatTextFormatter[]RemovedHandled by plugin system
6templates propCometChatMessageTemplate[]RemovedHandled by plugin system
7className propNot availablestringNew on all components — for custom styling
8children propNot availableReactNodeNew on many components — for compound composition

CometChatConversations

Removed Props

PropReplacement
textFormattersPlugin system handles formatting
hideErrorUse errorView prop

New Props

PropTypeDescription
onEmpty() => voidCalled when conversation list is empty
searchRequestBuilderConversationsRequestBuilderBuilder for search filtering
searchKeywordstringControlled search keyword

CometChatMessageList

Modified Props

Propv6 Typev7 TypeNotes
goToMessageIdstringnumberChanged to match SDK’s getId() return type

Removed Props

PropReplacement
templatesPlugin system
textFormattersPlugin system
hideErrorUse errorView prop

New Props

PropTypeDescription
loggedInUserCometChat.UserOverride the logged-in user
messageTypesstring[]Filter message types to display
messageCategoriesstring[]Filter message categories
onAvatarClick(user: CometChat.User) => voidAvatar click callback
onEditMessage(message: CometChat.BaseMessage) => voidEdit message callback
onReplyMessage(message: CometChat.BaseMessage) => voidReply message callback
disableTruncationbooleanDisable text truncation in bubbles
bubbleView(message, loggedInUser) => ReactNodeCustom bubble renderer
onActiveChatChanged(data) => voidActive chat change callback
onMessageRead(message: CometChat.BaseMessage) => voidMessage read callback
onMessageDeleted(message: CometChat.BaseMessage) => voidMessage deleted callback
onConversationMarkedAsRead(conversation) => voidConversation marked as read
onConversationUpdated(conversation) => voidConversation updated callback

CometChatMessageComposer

Renamed Props

v6 Namev7 Name
initialComposerTextinitialText
placeholderTextplaceholder
hideImageAttachmentOption / hideVideoAttachmentOption / hideAudioAttachmentOption / hideFileAttachmentOption / hidePollsOption / hideCollaborativeDocumentOption / hideCollaborativeWhiteboardOptionhideAttachmentOptions (single object with boolean fields)

New Props

PropTypeDescription
layoutCometChatMessageComposerLayoutAbsorbs CompactMessageComposer variant
textstringControlled text value
maxInputHeightnumberMax height before scrolling
enableRichTextEditorbooleanEnable rich text formatting toolbar
hideRichTextFormattingOptionsbooleanHide formatting toolbar when rich text is enabled
showBubbleMenuOnSelectionbooleanShow bubble menu on text selection
messageToEditTextMessage | nullMessage being edited
messageToReplyBaseMessage | nullMessage being replied to
hideAttachmentOptionsCometChatAttachmentHideOptionsObject to hide specific attachment types
showAttachmentPreviewbooleanShow attachment preview before sending
enableDragDropbooleanEnable drag-and-drop file upload
maxAttachmentsnumberMax attachments per message
allowedFileTypesstring[]Allowed MIME types
maxFileSizenumberMax file size in bytes
hideAIButtonbooleanHide AI assistant button
hideLiveReactionbooleanHide live reaction button
hideErrorbooleanHide error state
disableAutoFocusOnMobilebooleanDisable auto-focus on mobile
liveReactionIconstringCustom live reaction icon
attachmentIconViewReactNodeCustom attachment icon
voiceRecordingIconViewReactNodeCustom voice recording icon
emojiIconViewReactNodeCustom emoji icon
secondaryButtonViewReactNodeCustom secondary button
sendTextMessageOverride(text, richTextHtml?) => stringOverride sent text
onClosePreview() => voidClose preview callback
onAttachmentAdded(file: File) => voidAttachment added callback
onAttachmentRemoved(file: File) => voidAttachment removed callback
onMentionSelected(user) => voidMention selected callback

CometChatMessageHeader

Modified Props

Propv6 Signaturev7 SignatureNotes
onItemClick() => void(entity: User | Group) => voidNow receives the user/group entity

Removed Props

PropReplacement
itemViewUse compound composition to replace header parts

New Props

PropTypeDescription
onSummaryClick() => voidSummary button click
onVoiceCallClick(entity: User | Group) => voidVoice call button click
onVideoCallClick(entity: User | Group) => voidVideo call button click
callSettingsBuilderanyCustom call settings builder

CometChatThreadHeader

Removed Props

PropReplacement
templatePlugin system
textFormattersPlugin system

New Props

PropTypeDescription
onParentDeleted() => voidCalled when parent message is deleted
headerViewReactNodeCustom header content

CometChatUsers

Removed Props

PropReplacement
hideErrorUse errorView prop
disableLoadingStateUse loadingView prop

CometChatGroups

Removed Props

PropReplacement
hideErrorUse errorView prop

New Props

PropTypeDescription
onEmpty() => voidCalled when list is empty
searchKeywordstringControlled search keyword

CometChatGroupMembers

Modified Props

Propv6 Signaturev7 SignatureNotes
options(group, member) => Option[](member) => Option[]group param removed — component already knows its group

Removed Props

PropReplacement
hideErrorUse errorView prop
disableLoadingStateUse loadingView prop

New Props

PropTypeDescription
onBack() => voidBack button callback

CometChatIncomingCall

Removed Props

PropReplacement
callIncoming call is detected automatically in v7

New Props

PropTypeDescription
onCallEnded() => voidCalled when call ends

CometChatOngoingCall

New Props

PropTypeDescription
isAudioOnlybooleanAudio-only call mode
isDirectCallingbooleanDirect calling mode
onCallEnded() => voidCalled when call ends

CometChatMessageBubble

Renamed Props

v6 Namev7 Name
topMenuSizequickOptionsCount

Modified Props

Propv6 Typev7 TypeMigration
leadingViewJSX.Element | null(message) => ReactNode | nullWrap in arrow function: () => yourJSX
headerViewJSX.Element | null(message) => ReactNode | nullWrap in arrow function
bottomViewJSX.Element | null(message) => ReactNode | nullWrap in arrow function
threadViewJSX.Element | null(message) => ReactNode | nullWrap in arrow function
footerViewJSX.Element | null(message) => ReactNode | nullWrap in arrow function
statusInfoViewJSX.Element | null(message) => ReactNode | nullWrap in arrow function
options(CometChatActionsIcon | CometChatActionsView)[]CometChatMessageOption[]New type with id, title, onClick
setRef(ref: any) => voidRef<HTMLDivElement>Use useRef() instead of callback

Removed Props

PropReplacement
idDerived from message prop
typeDerived from message prop
categoryDerived from message prop

New Props

PropTypeDescription
messageCometChat.BaseMessageThe message object (required)
groupCometChat.GroupGroup context
hideAvatarbooleanHide avatar
forceShowAvatarbooleanForce show avatar
hideSenderNamebooleanHide sender name
hideTimestampbooleanHide timestamp
hideThreadViewbooleanHide thread indicator
showErrorbooleanShow error state
disableInteractionbooleanDisable all interactions
hideReceiptsbooleanHide delivery receipts
messageSentAtDateTimeFormatCometChatDateFormatConfigTimestamp format
onAvatarClick(user) => voidAvatar click callback
onThreadClick(message) => voidThread click callback
onOptionClick(option, message) => voidOption click callback
onReactionChipClick(messageId, emoji) => voidReaction chip click
isSelectedbooleanSelection state

CometChatContextMenu

Renamed Props

v6 Namev7 Name
dataitems
moreIconHoverTextmoreButtonTooltip

Modified Props

PropChange
onOptionClickedType changed: now receives CometChatContextMenuItemData

CometChatConfirmDialog

All string/callback props moved to compound sub-components:
v6 Propv7 Location
titleCometChatConfirmDialog.Contenttitle prop
messageTextCometChatConfirmDialog.ContentmessageText prop
cancelButtonTextCometChatConfirmDialog.ActionscancelButtonText prop
confirmButtonTextCometChatConfirmDialog.ActionsconfirmButtonText prop
onSubmitClickCometChatConfirmDialog.ActionsonConfirm prop
onCancelClickCometChatConfirmDialog.ActionsonCancel prop
New root-level props: isOpen, onClose, closeOnOutsideClick, variant.

CometChatActionSheet

All props moved to compound pattern:
v6 Propv7 Equivalent
actionsPass items as <CometChatActionSheet.Item item={...} /> children
onActionItemClickEach CometChatActionSheet.Item handles its own onClick via item.onClick
New root-level props: isOpen, onClose, layoutMode, title.

CometChatCheckbox

Renamed Props

v6 Namev7 Name
labelTextlabel
onCheckBoxValueChangedonChange

CometChatChangeScope

Renamed Props

v6 Namev7 Name
onCloseClickonClose

Modified Props

Propv6 Typev7 TypeNotes
optionsstring[]CometChatChangeScopeOptionData[]Changed to structured { id, label } objects. Migration: options.map(s => ({ id: s, label: s }))

CometChatDate

Renamed Props

v6 Namev7 Name
calendarObjectformatConfig

New Props

PropTypeDescription
formatter(timestamp: number) => stringCustom format function
variantCometChatDateVariantDisplay variant

CometChatReactions

Renamed Props

v6 Namev7 Name
messageObjectmessage
onReactionListItemClickonReactorClick

Modified Props

Propv6 Signaturev7 SignatureNotes
onReactionClick(reaction: ReactionCount, message) => void(emoji: string, message) => voidFirst param changed from object to emoji string

CometChatReactionList

Renamed Props

v6 Namev7 Name
messageObjectmessage
reactionItemClickedonItemClick

CometChatFullScreenViewer

Renamed Props

v6 Namev7 Name
ccCloseClickedonClose

Removed Props

PropReplacement
messageReplaced by individual props: senderName, senderAvatar, sentAt
placeholderImageHandled internally

New Props

PropTypeDescription
isOpenbooleanControlled open state
mediaTypeCometChatFullScreenViewerMediaTypeType of media being viewed
fileNamestringFile name display
fileSizenumberFile size display
attachmentsCometChatMediaAttachment[]Multi-media gallery support
startIndexnumberInitial gallery index
senderNamestringSender display name
senderAvatarstringSender avatar URL
senderStatusstringSender online status
sentAtstringMessage timestamp
onIndexChange(index: number) => voidGallery index change callback
onDownload(attachment) => voidDownload callback
enablePictureInPicturebooleanPiP for video

CometChatImageBubble

Removed Props

PropReplacement
srcReplaced by attachments array (multi-image support)
isSentByMeReplaced by variant prop ("incoming" / "outgoing")
placeholderImageHandled internally

New Props

PropTypeDescription
attachmentsCometChatImageBubbleAttachment[]Multi-image support
variantCometChatImageBubbleVariantReplaces isSentByMe
captionstringImage caption
messageCometChat.MediaMessageSource message
senderNamestringSender name for caption
textFormattersCometChatTextFormatter[]Text formatters for caption

CometChatSearchBar

Modified Props

Propv6 Signaturev7 SignatureNotes
onChange(input: { value?: string }) => void(value: string) => voidSimplified — receives string directly

New Props

PropTypeDescription
defaultSearchTextstringDefault search text
disabledbooleanDisable the search bar
debounceMsnumberDebounce delay in ms
inputRefRef<HTMLInputElement>Ref to the input element
styleCSSPropertiesInline styles

CometChatButton

Removed Props

PropReplacement
textUse children
iconURLUse children (render your own icon)
onClickUses native ButtonHTMLAttributes — standard onClick from React

New Props

PropTypeDescription
variantCometChatButtonVariantButton style variant
sizeCometChatButtonSizeButton size
loadingLabelstringLabel shown during loading

Next Steps

Migration Overview

Architecture changes and step-by-step checklist

Components Overview

Browse all v7 components