Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -459,6 +459,7 @@
"group": "Chat",
"pages": [
"ui-kit/react/core-features",
"ui-kit/react/offline-support",
"ui-kit/react/extensions",
"ui-kit/react/ai-features"
]
Expand Down
2 changes: 2 additions & 0 deletions ui-kit/react/cometchat-provider.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,8 @@ export default App;

For production, use `CometChatUIKit.loginWithAuthToken(token)` instead of `login(uid)`.

To turn on offline support (saved chats without a network, queued sends), add `.setOfflineConfig({ enabled: true })` to the builder before `build()`. See [Offline Support](/ui-kit/react/offline-support).

---

## Props
Expand Down
1 change: 1 addition & 0 deletions ui-kit/react/components/audio-bubble.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,12 @@

Key capabilities:

- **Stacked audio cards** — one card per audio attachment with filename, play/pause, seekable slider, elapsed/total time

Check warning on line 37 in ui-kit/react/components/audio-bubble.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/audio-bubble.mdx#L37

Did you really mean 'seekable'?
- **Inline playback** — plays audio directly in the bubble without a fullscreen viewer

Check warning on line 38 in ui-kit/react/components/audio-bubble.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/audio-bubble.mdx#L38

Did you really mean 'fullscreen'?
- **Download button** — download individual audio files
- **Batch grouping** — rendered as one connected group when several media messages are sent together (handled by the [message list](/ui-kit/react/components/message-list#multi-attachment-batch-grouping))
- **Caption support** — optional caption rendered below the cards
- **Offline support** — with [offline support](/ui-kit/react/offline-support) on, media downloaded while online is shown from the device; a file that isn't saved shows "Available when online" while offline, and tapping it asks the SDK to download it

<Info>
**Live Preview** — interact with the audio bubble.
Expand All @@ -48,7 +49,7 @@

<iframe
src="https://storybook.cometchat.io/react/iframe.html?id=components-bubbles-message-bubble-audios--two-audios&viewMode=story&shortcuts=false&singleStory=true"
className="w-full rounded-xl"

Check warning on line 52 in ui-kit/react/components/audio-bubble.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/audio-bubble.mdx#L52

Did you really mean 'className'?
loading="lazy"
style={{height: "500px", border: "1px solid #e0e0e0"}}
title="CometChat Audio Bubble — Two Audios"
Expand Down Expand Up @@ -78,7 +79,7 @@
| --- | --- |
| Play/Pause button | Toggles playback for that audio file |
| Filename | Display name of the audio file |
| Seek slider | Seekable progress bar showing current position |

Check warning on line 82 in ui-kit/react/components/audio-bubble.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/audio-bubble.mdx#L82

Did you really mean 'Seekable'?
| Time display | `currentTime / totalDuration` in `m:ss` format |
| Download button | Downloads the audio file |

Expand Down Expand Up @@ -119,9 +120,9 @@

---

### textFormatters

Check warning on line 123 in ui-kit/react/components/audio-bubble.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/audio-bubble.mdx#L123

Did you really mean 'textFormatters'?

Text formatters applied to the caption (mentions, URLs).

Check warning on line 125 in ui-kit/react/components/audio-bubble.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/audio-bubble.mdx#L125

Did you really mean 'formatters'?

| | |
| --- | --- |
Expand Down
13 changes: 13 additions & 0 deletions ui-kit/react/components/conversations.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Conversations"
description: "Scrollable list of recent one-on-one and group conversations for the logged-in user with real-time updates."

Check warning on line 3 in ui-kit/react/components/conversations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/conversations.mdx#L3

Did you really mean 'Scrollable'?
---

<Accordion title="AI Integration Quick Reference">
Expand Down Expand Up @@ -47,12 +47,13 @@
"onSearchBarClicked": "() => void"
},
"visibility": {
"hideReceipts": { "type": "boolean", "default": false },

Check warning on line 50 in ui-kit/react/components/conversations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/conversations.mdx#L50

Did you really mean 'hideReceipts'?
"hideUserStatus": { "type": "boolean", "default": false },
"hideGroupType": { "type": "boolean", "default": false },
"hideUnreadCount": { "type": "boolean", "default": false },
"hideDeleteConversation": { "type": "boolean", "default": false },
"hidePinConversation": { "type": "boolean", "default": false },
"hideOfflineNotices": { "type": "boolean", "default": false, "since": "7.3.0", "note": "Offline support only." },
"showSearchBar": { "type": "boolean", "default": true },
"showScrollbar": { "type": "boolean", "default": false }
},
Expand All @@ -61,14 +62,14 @@
"customSoundForMessages": { "type": "string", "default": "built-in" }
},
"selection": {
"selectionMode": {

Check warning on line 65 in ui-kit/react/components/conversations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/conversations.mdx#L65

Did you really mean 'selectionMode'?
"type": "CometChatConversationsSelectionMode",
"values": ["'none'", "'single'", "'multiple'"],
"default": "'none'"
}
},
"formatting": {
"textFormatters": { "type": "CometChatTextFormatter[]", "default": "undefined", "since": "7.2.0", "note": "Applied to the last-message subtitle." }

Check warning on line 72 in ui-kit/react/components/conversations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/conversations.mdx#L72

Did you really mean 'textFormatters'?
},
"viewSlots": {
"itemView": "(conversation: CometChat.Conversation) => ReactNode",
Expand Down Expand Up @@ -165,6 +166,7 @@
- Search filtering
- Selection mode (single/multiple)
- Pin conversation — pin a chat to the top of the list, with a pin indicator on the row
- Offline support (when turned on) — saved conversations first, "Connect to load chats" when nothing is saved, and a notice if unsent messages were lost. See [Offline Support](/ui-kit/react/offline-support)

---

Expand Down Expand Up @@ -225,7 +227,7 @@
function ChatApp() {
const [user, setUser] = useState<User | undefined>();
const [group, setGroup] = useState<Group | undefined>();
const [activeConversation, setActiveConversation] = useState<Conversation | undefined>();

Check warning on line 230 in ui-kit/react/components/conversations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/conversations.mdx#L230

Did you really mean 'activeConversation'?

const handleConversationClick = (conversation: Conversation) => {
setActiveConversation(conversation); // highlights the open row in the list
Expand Down Expand Up @@ -313,9 +315,9 @@
| Prop | Signature | Fires when |
| --- | --- | --- |
| `onItemClick` | `(conversation: CometChat.Conversation) => void` | User clicks a conversation item |
| `onSelect` | `(conversation: CometChat.Conversation, selected: boolean) => void` | Conversation selected/deselected (selection mode) |

Check warning on line 318 in ui-kit/react/components/conversations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/conversations.mdx#L318

Did you really mean 'onSelect'?
| `onError` | `((error: CometChat.CometChatException) => void) \| null` | SDK error occurs |

Check warning on line 319 in ui-kit/react/components/conversations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/conversations.mdx#L319

Did you really mean 'onError'?
| `onEmpty` | `() => void` | List is empty after initial fetch |

Check warning on line 320 in ui-kit/react/components/conversations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/conversations.mdx#L320

Did you really mean 'onEmpty'?
| `onSearchBarClicked` | `() => void` | Search bar is clicked (makes input read-only) |

### Events Emitted
Expand Down Expand Up @@ -381,8 +383,8 @@

```tsx
<CometChatConversations
headerView={<MyCustomHeader />}

Check warning on line 386 in ui-kit/react/components/conversations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/conversations.mdx#L386

Did you really mean 'headerView'?
itemView={(conversation) => <MyCustomItem conversation={conversation} />}

Check warning on line 387 in ui-kit/react/components/conversations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/conversations.mdx#L387

Did you really mean 'itemView'?
emptyView={<EmptyState />}
loadingView={<Skeleton />}
errorView={<ErrorBanner />}
Expand All @@ -392,10 +394,10 @@
| Slot | Signature | Replaces |
| --- | --- | --- |
| `itemView` | `(conversation) => ReactNode` | Entire conversation row |
| `leadingView` | `(conversation) => ReactNode` | Avatar section |

Check warning on line 397 in ui-kit/react/components/conversations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/conversations.mdx#L397

Did you really mean 'leadingView'?
| `titleView` | `(conversation) => ReactNode` | Conversation name |

Check warning on line 398 in ui-kit/react/components/conversations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/conversations.mdx#L398

Did you really mean 'titleView'?
| `subtitleView` | `(conversation) => ReactNode` | Last message preview |

Check warning on line 399 in ui-kit/react/components/conversations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/conversations.mdx#L399

Did you really mean 'subtitleView'?
| `trailingView` | `(conversation) => ReactNode` | Timestamp + unread badge |

Check warning on line 400 in ui-kit/react/components/conversations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/conversations.mdx#L400

Did you really mean 'trailingView'?
| `headerView` | `ReactNode` | Header area |
| `searchView` | `ReactNode` | Search bar |
| `loadingView` | `ReactNode` | Loading shimmer |
Expand Down Expand Up @@ -712,7 +714,7 @@

let className = "conversations__trailing-view-min";
let topLabel = `${diffInMinutes}`;
let bottomLabel = diffInMinutes === 1 ? "Min ago" : "Mins ago";

Check warning on line 717 in ui-kit/react/components/conversations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/conversations.mdx#L717

Did you really mean 'bottomLabel'?

Check warning on line 717 in ui-kit/react/components/conversations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/conversations.mdx#L717

Did you really mean 'Mins'?

if (diffInHours >= 1 && diffInHours <= 10) {
className = "conversations__trailing-view-hour";
Expand Down Expand Up @@ -934,7 +936,7 @@
| Sub-component | Description | Props | Flat API equivalent |
| --- | --- | --- | --- |
| `Root` | Context provider and container | All Root props + `children` | — |
| `List` | Scrollable conversation list | `itemView`, `className` | `itemView` |

Check warning on line 939 in ui-kit/react/components/conversations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/conversations.mdx#L939

Did you really mean 'Scrollable'?
| `Item` | Individual conversation row | `leadingView`, `titleView`, `subtitleView`, `trailingView`, `className` | Per-item view props |
| `Header` | Header area | `title`, `children` | `headerView` |
| `SearchBar` | Search input | `placeholder`, `onClick` | `searchView` |
Expand Down Expand Up @@ -991,7 +993,7 @@

---

### searchKeyword

Check warning on line 996 in ui-kit/react/components/conversations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/conversations.mdx#L996

Did you really mean 'searchKeyword'?

Initial search keyword to pre-filter conversations on mount.

Expand Down Expand Up @@ -1090,6 +1092,17 @@

---

### hideOfflineNotices

Hide the notice that [offline support](/ui-kit/react/offline-support#hide-the-offline-notices) shows after a cache reset lost, or may have lost, unsent messages. Has no effect with offline support off.

| | |
| --- | --- |
| Type | `boolean` |
| Default | `false` |

---

### showSearchBar

Whether to show the search bar. Set to `false` to hide it entirely.
Expand All @@ -1105,9 +1118,9 @@

---

### showScrollbar

Check warning on line 1121 in ui-kit/react/components/conversations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/conversations.mdx#L1121

Did you really mean 'showScrollbar'?

Show the native scrollbar on the conversation list.

Check warning on line 1123 in ui-kit/react/components/conversations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/conversations.mdx#L1123

Did you really mean 'scrollbar'?

| | |
| --- | --- |
Expand Down Expand Up @@ -1236,7 +1249,7 @@

### textFormatters

Custom display formatters applied to the **last-message subtitle** of each conversation item.

Check warning on line 1252 in ui-kit/react/components/conversations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/conversations.mdx#L1252

Did you really mean 'formatters'?

| | |
| --- | --- |
Expand Down
1 change: 1 addition & 0 deletions ui-kit/react/components/file-bubble.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@
- **Download button** — download individual files
- **Batch grouping** — rendered as one connected group when several media messages are sent together (handled by the [message list](/ui-kit/react/components/message-list#multi-attachment-batch-grouping))
- **Caption support** — optional caption rendered below the cards
- **Offline support** — with [offline support](/ui-kit/react/offline-support) on, media downloaded while online is shown from the device; a file that isn't saved shows "Available when online" while offline, and tapping it asks the SDK to download it

<Info>
**Live Preview** — interact with the file bubble.
Expand All @@ -41,7 +42,7 @@

<iframe
src="https://storybook.cometchat.io/react/iframe.html?id=components-bubbles-message-bubble-files--two-files&viewMode=story&shortcuts=false&singleStory=true"
className="w-full rounded-xl"

Check warning on line 45 in ui-kit/react/components/file-bubble.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/file-bubble.mdx#L45

Did you really mean 'className'?
loading="lazy"
style={{height: "500px", border: "1px solid #e0e0e0"}}
title="CometChat File Bubble — Two Files"
Expand Down Expand Up @@ -124,9 +125,9 @@

---

### textFormatters

Check warning on line 128 in ui-kit/react/components/file-bubble.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/file-bubble.mdx#L128

Did you really mean 'textFormatters'?

Text formatters applied to the caption (mentions, URLs).

Check warning on line 130 in ui-kit/react/components/file-bubble.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/file-bubble.mdx#L130

Did you really mean 'formatters'?

| | |
| --- | --- |
Expand Down
1 change: 1 addition & 0 deletions ui-kit/react/components/group-members.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Group Members"
description: "Scrollable list of members for a specific group with role-based actions like kick, ban, and scope change."

Check warning on line 3 in ui-kit/react/components/group-members.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/group-members.mdx#L3

Did you really mean 'Scrollable'?
---

<Accordion title="AI Integration Quick Reference">
Expand Down Expand Up @@ -44,6 +44,7 @@
- Search filtering
- Role-based action menus (kick, ban, change scope)
- Selection mode (single/multiple)
- Offline support (when turned on) — saved members first, and "Connect to load members" or "Connect to search" when nothing is saved. See [Offline Support](/ui-kit/react/offline-support)

---

Expand Down Expand Up @@ -217,12 +218,12 @@

| Slot | Signature | Replaces |
| --- | --- | --- |
| `itemView` | `(member) => ReactNode` | Entire member row |

Check warning on line 221 in ui-kit/react/components/group-members.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/group-members.mdx#L221

Did you really mean 'itemView'?
| `leadingView` | `(member) => ReactNode` | Avatar section |
| `titleView` | `(member) => ReactNode` | Member name |
| `subtitleView` | `(member) => ReactNode` | Status / role text |
| `trailingView` | `(member) => ReactNode` | Scope badge + action menu |
| `headerView` | `ReactNode` | Header area |

Check warning on line 226 in ui-kit/react/components/group-members.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/group-members.mdx#L226

Did you really mean 'headerView'?
| `loadingView` | `ReactNode` | Loading shimmer |
| `emptyView` | `ReactNode` | Empty state |
| `errorView` | `ReactNode` | Error state |
Expand Down Expand Up @@ -331,7 +332,7 @@
</Tab>
</Tabs>

#### subtitleView

Check warning on line 335 in ui-kit/react/components/group-members.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/group-members.mdx#L335

Did you really mean 'subtitleView'?

Replace the subtitle text. Joined date example.

Expand Down Expand Up @@ -376,7 +377,7 @@
</Tab>
</Tabs>

#### trailingView

Check warning on line 380 in ui-kit/react/components/group-members.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/group-members.mdx#L380

Did you really mean 'trailingView'?

Replace the right section. Scope tag example.

Expand Down Expand Up @@ -550,7 +551,7 @@
| Sub-component | Description | Props | Flat API equivalent |
| --- | --- | --- | --- |
| `Root` | Context provider and container | All Root props + `children` | — |
| `List` | Scrollable member list | `itemView` | `itemView` |

Check warning on line 554 in ui-kit/react/components/group-members.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/group-members.mdx#L554

Did you really mean 'Scrollable'?
| `Item` | Individual member row | `leadingView`, `titleView`, `subtitleView`, `trailingView` | Per-item view props |
| `Header` | Header area | `title`, `children` | `headerView` |
| `SearchBar` | Search input | `placeholder` | — |
Expand Down Expand Up @@ -623,7 +624,7 @@

---

### searchKeyword

Check warning on line 627 in ui-kit/react/components/group-members.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/group-members.mdx#L627

Did you really mean 'searchKeyword'?

Initial search keyword to pre-filter members on mount.

Expand All @@ -645,7 +646,7 @@

---

### hideSearch

Check warning on line 649 in ui-kit/react/components/group-members.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/group-members.mdx#L649

Did you really mean 'hideSearch'?

Hide the search bar entirely.

Expand Down Expand Up @@ -689,9 +690,9 @@

---

### showScrollbar

Check warning on line 693 in ui-kit/react/components/group-members.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/group-members.mdx#L693

Did you really mean 'showScrollbar'?

Show the native scrollbar on the member list.

Check warning on line 695 in ui-kit/react/components/group-members.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/group-members.mdx#L695

Did you really mean 'scrollbar'?

| | |
| --- | --- |
Expand All @@ -700,7 +701,7 @@

---

### selectionMode

Check warning on line 704 in ui-kit/react/components/group-members.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/group-members.mdx#L704

Did you really mean 'selectionMode'?

Enable selection mode for single or multi-select operations.

Expand Down
1 change: 1 addition & 0 deletions ui-kit/react/components/groups.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Groups"
description: "Searchable, scrollable list of groups with selection support and real-time membership updates."

Check warning on line 3 in ui-kit/react/components/groups.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/groups.mdx#L3

Did you really mean 'scrollable'?
---

<Accordion title="AI Integration Quick Reference">
Expand Down Expand Up @@ -45,6 +45,7 @@
- Search filtering
- Swipe/hover options
- Selection mode (single/multiple)
- Offline support (when turned on) — saved groups first, and "Connect to load groups" or "Connect to search" when nothing is saved. See [Offline Support](/ui-kit/react/offline-support)

---

Expand Down Expand Up @@ -107,7 +108,7 @@
return (
<div style={{ display: "flex", height: "100vh" }}>
<div style={{ width: 360 }}>
<CometChatGroups onItemClick={(g) => setGroup(g)} activeGroup={group} />

Check warning on line 111 in ui-kit/react/components/groups.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/groups.mdx#L111

Did you really mean 'activeGroup'?
</div>
{group && (
<div style={{ flex: 1, display: "flex", flexDirection: "column" }}>
Expand Down Expand Up @@ -218,7 +219,7 @@

| Slot | Signature | Replaces |
| --- | --- | --- |
| `itemView` | `(group) => ReactNode` | Entire group row |

Check warning on line 222 in ui-kit/react/components/groups.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/groups.mdx#L222

Did you really mean 'itemView'?
| `leadingView` | `(group) => ReactNode` | Avatar section |
| `titleView` | `(group) => ReactNode` | Group name |
| `subtitleView` | `(group) => ReactNode` | Member count / description |
Expand Down Expand Up @@ -325,7 +326,7 @@
</Tab>
</Tabs>

#### titleView

Check warning on line 329 in ui-kit/react/components/groups.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/groups.mdx#L329

Did you really mean 'titleView'?

Replace the name / title text. Group type badge inline example.

Expand Down Expand Up @@ -389,7 +390,7 @@
</Tab>
</Tabs>

#### subtitleView

Check warning on line 393 in ui-kit/react/components/groups.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/groups.mdx#L393

Did you really mean 'subtitleView'?

Replace the member count subtitle text.

Expand Down Expand Up @@ -453,7 +454,7 @@
| Sub-component | Description | Props | Flat API equivalent |
| --- | --- | --- | --- |
| `Root` | Context provider and container | All Root props + `children` | — |
| `List` | Scrollable group list | `itemView` | `itemView` |

Check warning on line 457 in ui-kit/react/components/groups.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/groups.mdx#L457

Did you really mean 'Scrollable'?
| `Item` | Individual group row | `leadingView`, `titleView`, `subtitleView`, `trailingView` | Per-item view props |
| `Header` | Header area | `title`, `children` | `headerView` |
| `SearchBar` | Search input | `placeholder` | — |
Expand Down Expand Up @@ -510,7 +511,7 @@

---

### searchKeyword

Check warning on line 514 in ui-kit/react/components/groups.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/groups.mdx#L514

Did you really mean 'searchKeyword'?

Initial search keyword to pre-filter groups on mount.

Expand All @@ -532,7 +533,7 @@

---

### hideSearch

Check warning on line 536 in ui-kit/react/components/groups.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/groups.mdx#L536

Did you really mean 'hideSearch'?

Hide the search bar entirely.

Expand All @@ -543,9 +544,9 @@

---

### showScrollbar

Check warning on line 547 in ui-kit/react/components/groups.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/groups.mdx#L547

Did you really mean 'showScrollbar'?

Show the native scrollbar on the group list.

Check warning on line 549 in ui-kit/react/components/groups.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/groups.mdx#L549

Did you really mean 'scrollbar'?

| | |
| --- | --- |
Expand All @@ -554,7 +555,7 @@

---

### selectionMode

Check warning on line 558 in ui-kit/react/components/groups.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/groups.mdx#L558

Did you really mean 'selectionMode'?

Enable selection mode for single or multi-select operations.

Expand Down
1 change: 1 addition & 0 deletions ui-kit/react/components/image-bubble.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Image Bubble"
sidebarTitle: "Image Bubble"
description: "A batch-aware bubble that renders one or more image attachments with adaptive grid layouts, a caption, and a fullscreen gallery viewer."

Check warning on line 4 in ui-kit/react/components/image-bubble.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/image-bubble.mdx#L4

Did you really mean 'fullscreen'?
---

<Accordion title="AI Integration Quick Reference">
Expand All @@ -13,7 +13,7 @@
| Package | `@cometchat/chat-uikit-react` |
| Import | `import { CometChatImagesBubble } from "@cometchat/chat-uikit-react";` |
| CSS root class | `.cometchat-images-bubble` |
| Primary output | `onImageClicked(attachment, index)` — opens the fullscreen gallery |

Check warning on line 16 in ui-kit/react/components/image-bubble.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/image-bubble.mdx#L16

Did you really mean 'fullscreen'?
| Prerequisites | App wrapped in [`CometChatProvider`](/ui-kit/react/cometchat-provider) with valid credentials + a logged-in user |
| Stitching | None — self-extracting from the SDK message |
| Full props | See [Props](#props) |
Expand All @@ -27,9 +27,10 @@
Key capabilities:

- **Adaptive grid layouts** — single image, 2-column, 2×2 grid, and overflow (+N) based on attachment count
- **Fullscreen gallery viewer** — click any image to open a paginated fullscreen gallery

Check warning on line 30 in ui-kit/react/components/image-bubble.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/image-bubble.mdx#L30

Did you really mean 'Fullscreen'?

Check warning on line 30 in ui-kit/react/components/image-bubble.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/image-bubble.mdx#L30

Did you really mean 'fullscreen'?
- **Batch grouping** — rendered as one connected group when several media messages are sent together (handled by the [message list](/ui-kit/react/components/message-list#multi-attachment-batch-grouping))
- **Placeholder loading** — shows a configurable placeholder while images load
- **Offline support** — with [offline support](/ui-kit/react/offline-support) on, media downloaded while online is shown from the device; a file that isn't saved shows "Available when online" while offline, and tapping it asks the SDK to download it

<Info>
**Live Preview** — interact with the image bubble.
Expand All @@ -39,7 +40,7 @@

<iframe
src="https://storybook.cometchat.io/react/iframe.html?id=components-bubbles-message-bubble-images--grid-3-images&viewMode=story&shortcuts=false&singleStory=true"
className="w-full rounded-xl"

Check warning on line 43 in ui-kit/react/components/image-bubble.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/image-bubble.mdx#L43

Did you really mean 'className'?
loading="lazy"
style={{height: "700px", border: "1px solid #e0e0e0"}}
title="CometChat Image Bubble — 3 Image Grid"
Expand Down Expand Up @@ -109,9 +110,9 @@

---

### textFormatters

Check warning on line 113 in ui-kit/react/components/image-bubble.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/image-bubble.mdx#L113

Did you really mean 'textFormatters'?

Text formatters applied to the caption (mentions, URLs).

Check warning on line 115 in ui-kit/react/components/image-bubble.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/image-bubble.mdx#L115

Did you really mean 'formatters'?

| | |
| --- | --- |
Expand All @@ -120,7 +121,7 @@

---

### placeholderImage

Check warning on line 124 in ui-kit/react/components/image-bubble.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/image-bubble.mdx#L124

Did you really mean 'placeholderImage'?

Custom placeholder image URL shown while the image is loading. Falls back to a default photo icon.

Expand All @@ -133,7 +134,7 @@

### onImageClicked

Callback fired when an image tile is clicked (in addition to opening the fullscreen viewer).

Check warning on line 137 in ui-kit/react/components/image-bubble.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/image-bubble.mdx#L137

Did you really mean 'fullscreen'?

| | |
| --- | --- |
Expand Down
1 change: 1 addition & 0 deletions ui-kit/react/components/message-composer.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
}
},
"textInput": {
"initialText": { "type": "string", "default": "undefined" },

Check warning on line 32 in ui-kit/react/components/message-composer.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/message-composer.mdx#L32

Did you really mean 'initialText'?
"text": { "type": "string", "default": "undefined", "note": "Controlled mode — consumer owns state" },
"placeholder": { "type": "string", "default": "'Type a message...'" },
"enterKeyBehavior": {
Expand All @@ -48,7 +48,7 @@
"messageToReply": { "type": "CometChat.BaseMessage | null", "default": "null" }
},
"attachments": {
"attachmentOptions": { "type": "CometChatComposerAttachmentOption[]", "default": "undefined" },

Check warning on line 51 in ui-kit/react/components/message-composer.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/message-composer.mdx#L51

Did you really mean 'attachmentOptions'?
"hideAttachmentOptions": { "type": "CometChatAttachmentHideOptions", "default": "undefined", "keys": ["image", "video", "audio", "file", "polls", "collaborativeDocument", "collaborativeWhiteboard"], "note": "All keys optional booleans. Stickers are not a key — use hideStickersButton." },
"showAttachmentPreview": { "type": "boolean", "default": true },
"enableMultipleAttachments": { "type": "boolean", "default": true, "note": "Enable multi-attachment staging tray and batch send. Set false for legacy single-select behavior." },
Expand Down Expand Up @@ -162,6 +162,7 @@
- Edit and reply mode with preview banners
- Typing indicator events
- Live reactions
- Offline support (when turned on) — a text message or sticker sent without a connection is queued and goes out on reconnect. See [Offline Support](/ui-kit/react/offline-support)

---

Expand Down Expand Up @@ -287,12 +288,12 @@

Each staged file is a tile with its own upload lifecycle:

| State | Meaning | Tile UI | Retryable |

Check warning on line 291 in ui-kit/react/components/message-composer.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/message-composer.mdx#L291

Did you really mean 'Retryable'?
| --- | --- | --- | --- |
| `uploading` | Bytes are transferring | Progress ring with percentage | — |
| `success` | Uploaded, ready to send | Thumbnail (image/video) or file card | — |
| `failed` | Transfer failed (transient — e.g. network drop) | Retry control on the tile | Yes |
| `rejected` | File not accepted (see below) | Rejected marker + hover tooltip | No |

Check warning on line 296 in ui-kit/react/components/message-composer.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/message-composer.mdx#L296

Did you really mean 'tooltip'?

This mirrors the underlying SDK upload semantics: **failed** uploads are transient and can be retried, while **rejected** files must be swapped out.

Expand All @@ -302,20 +303,20 @@
- **Per-file size** — a file larger than the allowed size (`file.size.max`) is rejected as an individual tile.

<Note>
These limits are **Dashboard/app-level settings**, not UI Kit props. The maximum file **count** (`file.count.max`) and **size** (`file.size.max`) are read from your CometChat app settings at runtime, and permitted file **types** are governed by your app's role-based file-type permissions (RBAC/SBAC). If an attachment is rejected unexpectedly, verify these settings for your app and role in the CometChat Dashboard — they are not overridable from the composer.

Check warning on line 306 in ui-kit/react/components/message-composer.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/message-composer.mdx#L306

Did you really mean 'overridable'?
</Note>

### Why a file is rejected

A rejected tile explains itself on hover via a tooltip:

Check warning on line 311 in ui-kit/react/components/message-composer.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/message-composer.mdx#L311

Did you really mean 'tooltip'?

| Reason | What the tooltip conveys |

Check warning on line 313 in ui-kit/react/components/message-composer.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/message-composer.mdx#L313

Did you really mean 'tooltip'?
| --- | --- |
| File exceeds the maximum size | The file is too large, including the configured size limit in MB. |
| File type not permitted | The file's type is blocked by your app's role-based file-type permissions (RBAC/SBAC). |

<Note>
The per-file **size** and **type** rejections surface on the individual tile (with the hover tooltip above). The **count** limit is different — it rejects the whole over-limit pick at once and surfaces as a validation banner, not a per-tile tooltip.

Check warning on line 319 in ui-kit/react/components/message-composer.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/message-composer.mdx#L319

Did you really mean 'tooltip'?

Check warning on line 319 in ui-kit/react/components/message-composer.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/message-composer.mdx#L319

Did you really mean 'tooltip'?
</Note>

### Batch send
Expand Down Expand Up @@ -348,8 +349,8 @@

| Event | Payload | Fires when |
| --- | --- | --- |
| `ui:message/sent` | `{ message, status }` | Message sent (inprogress → success/error) |

Check warning on line 352 in ui-kit/react/components/message-composer.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/message-composer.mdx#L352

Did you really mean 'inprogress'?
| `ui:compose/edit` | `{ message, status }` | Message edit (inprogress → success/error/cancelled) |

Check warning on line 353 in ui-kit/react/components/message-composer.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/message-composer.mdx#L353

Did you really mean 'inprogress'?
| `ui:compose/reply` | `{ message, status }` | Reply context set/cleared |
| `ui:compose/recording-started` | `{ composerInstanceId }` | Voice recording started (stops other instances) |

Expand Down Expand Up @@ -398,7 +399,7 @@
| `toolbarTrailingView` | `ReactNode` | Content at the trailing end of the rich-text formatting toolbar |
| `headerView` | `ReactNode` | Header area above the input |

#### attachmentOptions

Check warning on line 402 in ui-kit/react/components/message-composer.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/message-composer.mdx#L402

Did you really mean 'attachmentOptions'?

Override the default attachment options.

Expand Down Expand Up @@ -478,7 +479,7 @@
```

<Note>
The toolbar (and therefore the trailing view) only renders when the rich-text editor is enabled — pass `enableRichTextEditor`. For a complete walkthrough that builds the button and formatter, see the [Custom Text Formatter guide](/ui-kit/react/guide-custom-text-formatter).

Check warning on line 482 in ui-kit/react/components/message-composer.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/message-composer.mdx#L482

Did you really mean 'walkthrough'?
</Note>

Your node is rendered as-is with **no wrapper class** — style it yourself. It sits inside `.cometchat-formatting-toolbar`, after an auto-inserted `.cometchat-formatting-toolbar__separator`.
Expand Down Expand Up @@ -769,7 +770,7 @@

#### hideAttachmentOptions

Hide specific attachment options in the default layout. Replaces the seven individual `hide*Option` booleans from v6.

Check warning on line 773 in ui-kit/react/components/message-composer.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/message-composer.mdx#L773

Did you really mean 'booleans'?

| | |
| --- | --- |
Expand Down
1 change: 1 addition & 0 deletions ui-kit/react/components/message-header.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -183,6 +183,7 @@
- Online/offline presence status (for 1-on-1 conversations)
- Group member count (for group conversations)
- Real-time typing indicators
- Offline support (when turned on) — while the SDK is disconnected, the one-to-one header shows no "Online" subtitle and no header shows typing; a group header keeps its member count. See [Offline Support](/ui-kit/react/offline-support)
- Voice and video call buttons with call state management
- Back navigation for mobile layouts
- AI conversation summary trigger
Expand All @@ -205,7 +206,7 @@
<CometChatMessageHeader
user={user}
onItemClick={(entity) => openDetails(entity)}
onBack={() => navigateBack()}

Check warning on line 209 in ui-kit/react/components/message-header.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/message-header.mdx#L209

Did you really mean 'onBack'?
/>
);
}
Expand Down Expand Up @@ -306,7 +307,7 @@
| `onVoiceCallClick` | `(entity: CometChat.User \| CometChat.Group) => void` | User clicks the voice call button |
| `onVideoCallClick` | `(entity: CometChat.User \| CometChat.Group) => void` | User clicks the video call button |
| `onPinnedMessagesClicked` | `() => void` | User clicks "Pinned messages" in the overflow menu |
| `onError` | `((error: CometChat.CometChatException) => void) \| null` | SDK error occurs |

Check warning on line 310 in ui-kit/react/components/message-header.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/message-header.mdx#L310

Did you really mean 'onError'?

<Note>
These navigation callbacks are placeholders you wire to your app's layout. `onSearchOptionClicked` should open in-conversation search (mount `CometChatSearch` → jump to a result via `goToMessageId`) — see the [Search Messages guide](/ui-kit/react/guide-search-messages). `onItemClick` typically opens a details/info panel, and `onBack` returns to the conversation list; both are handled by your own routing/layout state.
Expand Down Expand Up @@ -362,7 +363,7 @@

| Slot | Type | Replaces |
| --- | --- | --- |
| `leadingView` | `ReactNode` | Avatar area |

Check warning on line 366 in ui-kit/react/components/message-header.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/message-header.mdx#L366

Did you really mean 'leadingView'?
| `titleView` | `ReactNode` | Display name |
| `subtitleView` | `ReactNode` | Status / typing indicator |
| `trailingView` | `ReactNode` | Call buttons + overflow menu |
Expand All @@ -370,7 +371,7 @@

#### Custom item layout

Combine `leadingView`, `titleView`, and `subtitleView` to fully replace the header's item area.

Check warning on line 374 in ui-kit/react/components/message-header.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/message-header.mdx#L374

Did you really mean 'titleView'?

Check warning on line 374 in ui-kit/react/components/message-header.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/message-header.mdx#L374

Did you really mean 'subtitleView'?

<Frame>
<img src="/images/0a3d38de-messages_header_list_item_view_web_screens-024979a70f09486b76e913633bfc9e81.png" />
Expand Down
15 changes: 14 additions & 1 deletion ui-kit/react/components/message-list.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Message List"
description: "Scrollable message feed with plugin-based bubble rendering, reactions, receipts, threads, and real-time updates."

Check warning on line 3 in ui-kit/react/components/message-list.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/message-list.mdx#L3

Did you really mean 'Scrollable'?
---

<Accordion title="AI Integration Quick Reference">
Expand Down Expand Up @@ -35,7 +35,7 @@
"parentMessageId": {
"type": "number",
"default": "undefined",
"note": "Deprecated — pass parentMessage instead. Still honoured (as the parent's id) when parentMessage is absent."

Check warning on line 38 in ui-kit/react/components/message-list.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/message-list.mdx#L38

Did you really mean 'parentMessage'?
}
},
"data": {
Expand Down Expand Up @@ -71,7 +71,7 @@
}
},
"visibility": {
"hideReceipts": { "type": "boolean", "default": false },

Check warning on line 74 in ui-kit/react/components/message-list.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/message-list.mdx#L74

Did you really mean 'hideReceipts'?
"hideStickyDate": { "type": "boolean", "default": false },
"hideDateSeparator": { "type": "boolean", "default": false },
"hideAvatar": { "type": "boolean", "default": false },
Expand All @@ -82,7 +82,8 @@
"showConversationStarters": { "type": "boolean", "default": false },
"showMarkAsUnreadOption": { "type": "boolean", "default": false },
"disableTruncation": { "type": "boolean", "default": false },
"isAgentChat": { "type": "boolean", "default": false }
"isAgentChat": { "type": "boolean", "default": false },
"hideOfflineNotices": { "type": "boolean", "default": false, "since": "7.3.0", "note": "Offline support only." }
},
"optionToggles": {
"hideReplyOption": { "type": "boolean", "default": false },
Expand Down Expand Up @@ -145,7 +146,7 @@
"onError": "((error: CometChat.CometChatException) => void) | null"
},
"formatting": {
"textFormatters": { "type": "CometChatTextFormatter[]", "default": "undefined", "since": "7.2.0", "note": "Merged into text and caption bubbles." }

Check warning on line 149 in ui-kit/react/components/message-list.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/message-list.mdx#L149

Did you really mean 'textFormatters'?
},
"viewSlots": {
"bubbleView": "(message: CometChat.BaseMessage, loggedInUser: CometChat.User) => ReactNode",
Expand Down Expand Up @@ -222,7 +223,7 @@

## Overview

`CometChatMessageList` is a scrollable message feed component. It renders messages for a given user or group conversation and emits thread navigation via `onThreadRepliesClick`. Wire it between `CometChatMessageHeader` and `CometChatMessageComposer` to build a standard chat panel.

Check warning on line 226 in ui-kit/react/components/message-list.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/message-list.mdx#L226

Did you really mean 'scrollable'?
<Info>
**Live Preview** — interact with the default message list.

Expand Down Expand Up @@ -250,6 +251,7 @@
- Date separators and sticky floating date header
- Jump-to-message for search results and deep links
- Mark-as-unread support
- Offline support (when turned on) — cached messages first, unsent messages marked with Retry and Delete, and "Connect to load …" where the cache runs out. See [Offline Support](/ui-kit/react/offline-support)

> **Note:** `user` and `group` are mutually exclusive. Pass one or the other to specify the conversation context.

Expand Down Expand Up @@ -501,7 +503,7 @@

### Pin and Save Options

When pinning and saving are enabled for your app (the `features.ux.messages.pinned.enabled` and `features.ux.messages.saved.enabled` app settings), `CometChatMessageList` automatically adds **Pin**, **Unpin**, **Save**, and **Unsave** to the message context menu — no props required. The **Pin/Unpin option is shown to every member** — the client does not gate it by role. The **server** enforces who may pin or unpin in that conversation; a denied attempt is rejected and surfaces a permission toast (localized via the `action_permission_denied` key). Saving is per-user and always available.

Check warning on line 506 in ui-kit/react/components/message-list.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/message-list.mdx#L506

Did you really mean 'Unsave'?

Use the `hide*` props to remove any of these options:

Expand All @@ -518,7 +520,7 @@
| `hidePinMessageOption` | Pin |
| `hideUnpinMessageOption` | Unpin |
| `hideSaveMessageOption` | Save |
| `hideUnsaveMessageOption` | Unsave |

Check warning on line 523 in ui-kit/react/components/message-list.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/message-list.mdx#L523

Did you really mean 'Unsave'?
| `hideThreadSubscriptionOption` | Subscribe / unsubscribe thread |

See the [Pin & Save Messages guide](/ui-kit/react/guide-pin-and-save-messages) for the full screen, and [Core Features → Pin & Save](/ui-kit/react/core-features#pin-and-save-messages) for enabling the features.
Expand All @@ -530,12 +532,12 @@
```tsx
<CometChatMessageList
user={user}
headerView={<TypingIndicator />}

Check warning on line 535 in ui-kit/react/components/message-list.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/message-list.mdx#L535

Did you really mean 'headerView'?
footerView={<SmartRepliesBar />}

Check warning on line 536 in ui-kit/react/components/message-list.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/message-list.mdx#L536

Did you really mean 'footerView'?
emptyView={<EmptyConversation />}
loadingView={<MessageSkeleton />}
errorView={<ErrorBanner />}
bubbleView={(message, loggedInUser) => <CustomBubble message={message} />}

Check warning on line 540 in ui-kit/react/components/message-list.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/message-list.mdx#L540

Did you really mean 'bubbleView'?
/>
```

Expand All @@ -544,11 +546,11 @@
| `bubbleView` | `(message, loggedInUser) => ReactNode` | Entire bubble rendering for each message |
| `headerView` | `ReactNode` | Header area above the scroll container |
| `footerView` | `ReactNode` | Footer area below the scroll container |
| `loadingView` | `ReactNode` | Loading shimmer |

Check warning on line 549 in ui-kit/react/components/message-list.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/message-list.mdx#L549

Did you really mean 'loadingView'?
| `emptyView` | `ReactNode` | Empty state |

Check warning on line 550 in ui-kit/react/components/message-list.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/message-list.mdx#L550

Did you really mean 'emptyView'?
| `errorView` | `ReactNode` | Error state |

Check warning on line 551 in ui-kit/react/components/message-list.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/message-list.mdx#L551

Did you really mean 'errorView'?

#### headerView

Check warning on line 553 in ui-kit/react/components/message-list.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/message-list.mdx#L553

Did you really mean 'headerView'?

Custom view above the message list.

Expand All @@ -564,7 +566,7 @@
import { CometChatMessageList, CometChatButton } from "@cometchat/chat-uikit-react";

function MessageListWithHeader() {
const [chatUser, setChatUser] = useState<CometChat.User>();

Check warning on line 569 in ui-kit/react/components/message-list.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/message-list.mdx#L569

Did you really mean 'chatUser'?

useEffect(() => {
CometChat.getUser("uid").then((user) => setChatUser(user));
Expand Down Expand Up @@ -618,7 +620,7 @@
</Tab>
</Tabs>

#### footerView

Check warning on line 623 in ui-kit/react/components/message-list.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/message-list.mdx#L623

Did you really mean 'footerView'?

Custom view below the message list.

Expand Down Expand Up @@ -685,7 +687,7 @@
| Sub-component | Description | Props | Flat API equivalent |
| --- | --- | --- | --- |
| `Root` | Context provider, data hook, container | All Root props + `children` | — |
| `View` | Scrollable message feed | `className` | — |

Check warning on line 690 in ui-kit/react/components/message-list.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/message-list.mdx#L690

Did you really mean 'Scrollable'?
| `Header` | Content above the feed | `children`, `className` | `headerView` |
| `Footer` | Content below the feed | `children`, `className` | `footerView` |
| `ScrollToBottom` | Floating scroll button | `className` | — |
Expand Down Expand Up @@ -804,7 +806,7 @@

---

### messageTypes

Check warning on line 809 in ui-kit/react/components/message-list.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/message-list.mdx#L809

Did you really mean 'messageTypes'?

Restrict which message types are fetched and displayed.

Expand All @@ -815,7 +817,7 @@

---

### messageCategories

Check warning on line 820 in ui-kit/react/components/message-list.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/message-list.mdx#L820

Did you really mean 'messageCategories'?

Restrict which message categories are fetched and displayed.

Expand Down Expand Up @@ -904,7 +906,7 @@

---

### hideAvatar

Check warning on line 909 in ui-kit/react/components/message-list.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/message-list.mdx#L909

Did you really mean 'hideAvatar'?

Hide the avatar on incoming messages in group conversations.

Expand Down Expand Up @@ -941,9 +943,9 @@

---

### showScrollbar

Check warning on line 946 in ui-kit/react/components/message-list.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/message-list.mdx#L946

Did you really mean 'showScrollbar'?

Show the native scrollbar on the message list. When `false`, the scrollbar is hidden but scrolling still works.

Check warning on line 948 in ui-kit/react/components/message-list.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/message-list.mdx#L948

Did you really mean 'scrollbar'?

Check warning on line 948 in ui-kit/react/components/message-list.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/message-list.mdx#L948

Did you really mean 'scrollbar'?

| | |
| --- | --- |
Expand Down Expand Up @@ -993,7 +995,7 @@

---

### disableTruncation

Check warning on line 998 in ui-kit/react/components/message-list.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/message-list.mdx#L998

Did you really mean 'disableTruncation'?

Disable text truncation (read more / show less) in text bubbles. When `true`, full message text is always shown.

Expand All @@ -1015,6 +1017,17 @@

---

### hideOfflineNotices

Hide the notices about unsent messages that [offline support](/ui-kit/react/offline-support#hide-the-offline-notices) shows in the list (removed, not sent, lost in a cache reset, outbox full, send refused, send under way). Has no effect with offline support off.

| | |
| --- | --- |
| Type | `boolean` |
| Default | `false` |

---

### Option Toggles

---
Expand Down Expand Up @@ -1076,7 +1089,7 @@

### hideUnsaveMessageOption

Hide the "Unsave" option from the message context menu.

Check warning on line 1092 in ui-kit/react/components/message-list.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/message-list.mdx#L1092

Did you really mean 'Unsave'?

| | |
| --- | --- |
Expand Down Expand Up @@ -1194,7 +1207,7 @@

### hideFlagRemarkField

Hide the remark textarea in the flag/report message dialog.

Check warning on line 1210 in ui-kit/react/components/message-list.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/message-list.mdx#L1210

Did you really mean 'textarea'?

| | |
| --- | --- |
Expand Down Expand Up @@ -1266,7 +1279,7 @@

---

### messageAlignment

Check warning on line 1282 in ui-kit/react/components/message-list.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/message-list.mdx#L1282

Did you really mean 'messageAlignment'?

Controls message bubble alignment. `0` aligns all messages to the left. `1` uses standard alignment (sent on right, received on left).

Expand Down Expand Up @@ -1320,7 +1333,7 @@

### smartRepliesDelayDuration

Delay in milliseconds before showing smart replies after a qualifying message is received. Acts as a debounce — if another message arrives within this window, the timer resets.

Check warning on line 1336 in ui-kit/react/components/message-list.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/message-list.mdx#L1336

Did you really mean 'debounce'?

| | |
| --- | --- |
Expand Down Expand Up @@ -1454,7 +1467,7 @@

---

### onError

Check warning on line 1470 in ui-kit/react/components/message-list.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/message-list.mdx#L1470

Did you really mean 'onError'?

Callback when an SDK error occurs during fetch or real-time operations.

Expand Down Expand Up @@ -1548,7 +1561,7 @@

### textFormatters

Custom display formatters merged into the text and caption bubbles rendered by the list.

Check warning on line 1564 in ui-kit/react/components/message-list.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/message-list.mdx#L1564

Did you really mean 'formatters'?

| | |
| --- | --- |
Expand Down Expand Up @@ -1596,7 +1609,7 @@
Display thread context above a threaded message list
</Card>
<Card title="Plugins Overview" icon="puzzle-piece" href="/ui-kit/react/plugins/overview">
Learn how plugins register custom bubble renderers

Check warning on line 1612 in ui-kit/react/components/message-list.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/message-list.mdx#L1612

Did you really mean 'renderers'?
</Card>
<Card title="Theming" icon="paintbrush" href="/ui-kit/react/theming">
Customize colors, fonts, and spacing
Expand Down
1 change: 1 addition & 0 deletions ui-kit/react/components/notification-feed.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@

</Accordion>

`CometChatNotificationFeed` displays a scrollable notification feed where each item is rendered as a card using `@cometchat/cards-react`. It handles fetching, pagination, category filtering, timestamp grouping, real-time updates, and read/delivered/engagement reporting automatically.

Check warning on line 22 in ui-kit/react/components/notification-feed.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/notification-feed.mdx#L22

Did you really mean 'scrollable'?

<Note>
**Prerequisite: Campaigns must be configured first.** The feed only shows content once **Campaigns / Notifications are set up in the CometChat Dashboard** — channels, categories, and card templates. Without this, the feed renders but stays empty. See [Campaigns](/ui-kit/react/campaigns) for the end-to-end setup (Dashboard configuration through frontend wiring).
Expand Down Expand Up @@ -170,13 +170,13 @@
**Navigation is your app's responsibility.** `onItemClick` and `onActionClick` only report the intent (deep link, `chatWithUser`, `chatWithGroup`, `openUrl`) — the component does not route anywhere on its own. Your app must handle the transition (open the URL, switch to the chat with `params.uid` / `params.guid`, etc.). For the recommended navigation-event pattern, see [Event System — Navigation](/ui-kit/react/event-system#navigation).
</Note>

#### onError

Check warning on line 173 in ui-kit/react/components/notification-feed.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/notification-feed.mdx#L173

Did you really mean 'onError'?

Fires when an internal error occurs (network failure, SDK exception).

```tsx
<CometChatNotificationFeed
onError={(error) => {

Check warning on line 179 in ui-kit/react/components/notification-feed.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/notification-feed.mdx#L179

Did you really mean 'onError'?
console.error("Feed error:", error.message);
}}
/>
Expand All @@ -201,12 +201,13 @@
| --- | --- |
| Real-time updates | New items appear at the top via WebSocket `NotificationFeedListener` |
| Delivery reporting | Items are reported as delivered when fetched |
| Read reporting | Items are reported as read when visible in viewport (IntersectionObserver) |

Check warning on line 204 in ui-kit/react/components/notification-feed.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/notification-feed.mdx#L204

Did you really mean 'viewport'?
| Unread count polling | Polls unread count every 30 seconds to update badges |
| Infinite scroll | Fetches next page when scrolling near the bottom |
| Timestamp grouping | Groups items as "Today", "Yesterday", day name, or date |
| Category filtering | Filter chips row with per-category unread badges |
| Mark all read | Header button to mark all notifications as read |
| Offline support | With [offline support](/ui-kit/react/offline-support) on, saved items show first; with nothing saved offline, the feed shows "Connect to load notifications" and loads again on reconnect |

---

Expand Down Expand Up @@ -249,13 +250,13 @@
| Sub-component | Description | Props | Flat API equivalent |
| --- | --- | --- | --- |
| `Root` | Context provider and container | All Root props + `children` | — |
| `Header` | Header bar with title + mark-all-read | `title`, `showBackButton`, `onBackPress`, `children` | `headerView` |

Check warning on line 253 in ui-kit/react/components/notification-feed.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/notification-feed.mdx#L253

Did you really mean 'headerView'?
| `FilterChips` | Category filter chips | `children` | — |
| `List` | Scrollable feed list | `itemView` | `itemView` |

Check warning on line 255 in ui-kit/react/components/notification-feed.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/notification-feed.mdx#L255

Did you really mean 'Scrollable'?

Check warning on line 255 in ui-kit/react/components/notification-feed.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/notification-feed.mdx#L255

Did you really mean 'itemView'?
| `Item` | Individual feed item | `item`, `cardThemeMode`, `cardThemeOverride` | — |
| `EmptyState` | Empty state | `children` | `emptyView` |

Check warning on line 257 in ui-kit/react/components/notification-feed.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/notification-feed.mdx#L257

Did you really mean 'emptyView'?
| `ErrorState` | Error state | `children` | `errorView` |

Check warning on line 258 in ui-kit/react/components/notification-feed.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/notification-feed.mdx#L258

Did you really mean 'errorView'?
| `LoadingState` | Loading state | `children` | `loadingView` |

Check warning on line 259 in ui-kit/react/components/notification-feed.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/notification-feed.mdx#L259

Did you really mean 'loadingView'?

### CSS Styling

Expand All @@ -282,7 +283,7 @@
| `.cometchat-notification-feed__chip--active` | Active filter chip |
| `.cometchat-notification-feed__chip--inactive` | Inactive filter chip |
| `.cometchat-notification-feed__chip-badge` | Chip unread badge |
| `.cometchat-notification-feed__content` | Scrollable content area |

Check warning on line 286 in ui-kit/react/components/notification-feed.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/notification-feed.mdx#L286

Did you really mean 'Scrollable'?
| `.cometchat-notification-feed__item` | Feed item container |
| `.cometchat-notification-feed__item--unread` | Unread feed item |
| `.cometchat-notification-feed__unread-indicator` | Unread dot indicator |
Expand Down Expand Up @@ -311,7 +312,7 @@

---

### showHeader

Check warning on line 315 in ui-kit/react/components/notification-feed.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/notification-feed.mdx#L315

Did you really mean 'showHeader'?

Shows/hides the entire header.

Expand Down
1 change: 1 addition & 0 deletions ui-kit/react/components/pinned-messages.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,7 @@
- Real-time updates when a message is pinned or unpinned
- An overflow menu of per-message options (unpin, save, copy, info, and more)
- Empty, loading, and error states
- Offline support (when turned on) — saved pinned messages first, and "Connect to load messages" when nothing is saved. See [Offline Support](/ui-kit/react/offline-support)

<Note>
Pinning must be enabled for your app through the `features.ux.messages.pinned.enabled` app setting for pins to load. See [Core Features](/ui-kit/react/core-features#pin-and-save-messages).
Expand All @@ -145,7 +146,7 @@

function PinnedPanel({
group,
onClose,

Check warning on line 149 in ui-kit/react/components/pinned-messages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/pinned-messages.mdx#L149

Did you really mean 'onClose'?
}: {
group: Group;
onClose: () => void;
Expand Down Expand Up @@ -372,9 +373,9 @@

---

### textFormatters

Check warning on line 376 in ui-kit/react/components/pinned-messages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/pinned-messages.mdx#L376

Did you really mean 'textFormatters'?

Text formatters applied when rendering the pinned message previews. See [Text Formatters](/ui-kit/react/plugins/text-formatters).

Check warning on line 378 in ui-kit/react/components/pinned-messages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/pinned-messages.mdx#L378

Did you really mean 'formatters'?

| | |
| --- | --- |
Expand Down Expand Up @@ -407,7 +408,7 @@

### hideSaveMessageOption / hideUnsaveMessageOption

Remove the save / unsave actions from the per-message options.

Check warning on line 411 in ui-kit/react/components/pinned-messages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/pinned-messages.mdx#L411

Did you really mean 'unsave'?

| | |
| --- | --- |
Expand Down Expand Up @@ -493,7 +494,7 @@

---

### className

Check warning on line 497 in ui-kit/react/components/pinned-messages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/pinned-messages.mdx#L497

Did you really mean 'className'?

Additional CSS class for the root element.

Expand Down
1 change: 1 addition & 0 deletions ui-kit/react/components/reaction-list.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@
// Parent calls SDK to remove the reaction
CometChat.removeReaction(String(msg.getId()), reaction.getReaction());
}}
onEmpty={onClose}

Check warning on line 55 in ui-kit/react/components/reaction-list.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/reaction-list.mdx#L55

Did you really mean 'onEmpty'?
/>
);
}
Expand All @@ -78,7 +78,7 @@
| --- | --- |
| `Root` | Context provider. Receives message and config. Renders default layout when no children. |
| `Tabs` | Emoji tab bar — "All" tab plus one tab per unique emoji. Keyboard navigable. |
| `Items` | Scrollable list of users who reacted. IntersectionObserver pagination. |

Check warning on line 81 in ui-kit/react/components/reaction-list.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/reaction-list.mdx#L81

Did you really mean 'Scrollable'?
| `LoadingState` | Shimmer loading placeholder. Self-hides when not loading. |
| `ErrorState` | Error message with retry button. Self-hides when not in error state. |
| `EmptyState` | Empty message. Self-hides when not empty. |
Expand Down Expand Up @@ -150,7 +150,7 @@
```tsx lines
<CometChatReactionList
message={message}
onError={(error) => console.error("Reaction list error:", error)}

Check warning on line 153 in ui-kit/react/components/reaction-list.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/reaction-list.mdx#L153

Did you really mean 'onError'?
/>
```

Expand All @@ -161,6 +161,7 @@
- "All" tab shows every reactor across all emojis.
- Per-emoji tabs show only reactors for that emoji.
- Tab counts update optimistically when the current user removes a reaction.
- With [offline support](/ui-kit/react/offline-support) on and no reactors saved, the list shows "Connect to load reactions", and the tabs show the message's own reaction counts until the list can load.
- Keyboard navigation: `ArrowLeft` / `ArrowRight` to move between tabs, `Enter` / `Space` to select.

### Reactor Items
Expand All @@ -178,7 +179,7 @@
When the current user clicks their reaction:
1. The reaction is removed from the list immediately (optimistic update).
2. `onItemClick` is called so the parent can call the SDK.
3. If no reactions remain, `onEmpty` is called.

Check warning on line 182 in ui-kit/react/components/reaction-list.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/reaction-list.mdx#L182

Did you really mean 'onEmpty'?

The component does **not** call the SDK itself — the parent owns that responsibility.

Expand Down Expand Up @@ -319,7 +320,7 @@

---

### className

Check warning on line 323 in ui-kit/react/components/reaction-list.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/reaction-list.mdx#L323

Did you really mean 'className'?

Optional custom CSS class for the root container.

Expand Down
1 change: 1 addition & 0 deletions ui-kit/react/components/saved-messages.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,7 @@
- Real-time updates when a message is saved or unsaved
- An unsave action per row
- Empty, loading, and error states
- Offline support (when turned on) — saved messages from the cache first, and "Connect to load messages" when nothing is saved. See [Offline Support](/ui-kit/react/offline-support)

<Note>
Saving must be enabled for your app through the `features.ux.messages.saved.enabled` app setting for saves to load. See [Core Features](/ui-kit/react/core-features#pin-and-save-messages).
Expand All @@ -117,7 +118,7 @@
```tsx
import { CometChatSavedMessages } from "@cometchat/chat-uikit-react";

function SavedScreen({ onClose }: { onClose: () => void }) {

Check warning on line 121 in ui-kit/react/components/saved-messages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/saved-messages.mdx#L121

Did you really mean 'onClose'?
return <CometChatSavedMessages onClose={onClose} />;
}
```
Expand Down Expand Up @@ -194,13 +195,13 @@

### Events

The component itself publishes nothing, but the unsave action it renders (through the shared message options) publishes `ui:message/save-changed`, which keeps other surfaces in sync.

Check warning on line 198 in ui-kit/react/components/saved-messages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/saved-messages.mdx#L198

Did you really mean 'unsave'?

It subscribes to the kit event bus and updates its list automatically — an optimistic `ui:` flip the moment a save/unsave succeeds locally, then the network-confirmed SDK event:

| Event | Payload | Behavior |
| --- | --- | --- |
| `ui:message/save-changed` | `{ message, saved }` | Optimistic: adds on save, removes on unsave |

Check warning on line 204 in ui-kit/react/components/saved-messages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/saved-messages.mdx#L204

Did you really mean 'unsave'?
| `message/saved` / `message/unsaved` | `{ message }` | Network-confirmed add / remove |

See the [Event System](/ui-kit/react/event-system#pin-and-save) for the full list.
Expand All @@ -211,14 +212,14 @@

### Per-message Options

Each saved row exposes an unsave action. Hide it with `hideUnsaveMessageOption`:

Check warning on line 215 in ui-kit/react/components/saved-messages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/saved-messages.mdx#L215

Did you really mean 'unsave'?

```tsx
<CometChatSavedMessages hideUnsaveMessageOption />
```

<Note>
Saved rows are list items rather than full message bubbles, so they carry only the unsave action — there is no full per-message options menu here.

Check warning on line 222 in ui-kit/react/components/saved-messages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/saved-messages.mdx#L222

Did you really mean 'unsave'?
</Note>

### View Props
Expand Down Expand Up @@ -288,9 +289,9 @@

---

### textFormatters

Check warning on line 292 in ui-kit/react/components/saved-messages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/saved-messages.mdx#L292

Did you really mean 'textFormatters'?

Text formatters applied when rendering the saved message previews. See [Text Formatters](/ui-kit/react/plugins/text-formatters).

Check warning on line 294 in ui-kit/react/components/saved-messages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/saved-messages.mdx#L294

Did you really mean 'formatters'?

| | |
| --- | --- |
Expand All @@ -312,7 +313,7 @@

### hideUnsaveMessageOption

Remove the unsave action from each saved row.

Check warning on line 316 in ui-kit/react/components/saved-messages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/saved-messages.mdx#L316

Did you really mean 'unsave'?

| | |
| --- | --- |
Expand Down Expand Up @@ -343,7 +344,7 @@

---

### className

Check warning on line 347 in ui-kit/react/components/saved-messages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/saved-messages.mdx#L347

Did you really mean 'className'?

Additional CSS class for the root element.

Expand All @@ -368,7 +369,7 @@
| Row preview | `.cometchat-saved-messages__item-preview` |
| Row subtitle | `.cometchat-saved-messages__item-subtitle` |
| Row media-type icon | `.cometchat-saved-messages__item-subtitle-icon` (`--image`, `--video`, `--audio`, `--file`) |
| Row unsave button | `.cometchat-saved-messages__item-unsave` |

Check warning on line 372 in ui-kit/react/components/saved-messages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/saved-messages.mdx#L372

Did you really mean 'unsave'?
| Empty state | `.cometchat-saved-messages__empty` |
| Empty title | `.cometchat-saved-messages__empty-title` |
| Empty subtitle | `.cometchat-saved-messages__empty-subtitle` |
Expand Down
1 change: 1 addition & 0 deletions ui-kit/react/components/search.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
`CometChatSearch` is a unified search component. It searches across conversations and messages, displaying results in separate sections with filter chips for scoping. It emits the selected result via `onConversationClicked` or `onMessageClicked` — both include the `searchKeyword` in the event payload. Wire it to `CometChatConversations` or `CometChatMessageList` to navigate to the matched result.

<Note>
**These result callbacks are required to make the component useful.** `CometChatSearch` does not navigate on its own — clicking a result only fires `onConversationClicked` or `onMessageClicked`. Your app must handle navigation: open the [Conversations](/ui-kit/react/components/conversations) list or route to the matched entity, and pass the message's ID to [Message List](/ui-kit/react/components/message-list) via `goToMessageId` to scroll to the exact message. For an end-to-end walkthrough, see the [Search Messages guide](/ui-kit/react/guide-search-messages).

Check warning on line 26 in ui-kit/react/components/search.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/search.mdx#L26

Did you really mean 'walkthrough'?
</Note>
<Warning>
**Message search is plan-gated.** It requires **Search enabled on your CometChat plan** (check your app's plan in the [Dashboard](https://app.cometchat.com/)). Until it's enabled, the search API responds with **HTTP `402 Payment Required`** and no results appear — even when `CometChatSearch` is wired correctly.
Expand All @@ -49,6 +49,7 @@
- Scoped search via `uid` or `guid`
- Custom request builders for both conversations and messages
- Customizable result item views
- Offline support (when turned on) — a keyword search offline with nothing saved shows "Connect to search"; a search by filter alone is answered from the device. See [Offline Support](/ui-kit/react/offline-support)

---

Expand Down Expand Up @@ -103,7 +104,7 @@
function ConversationSearch({ userId }: { userId: string }) {
return (
<CometChatSearch
uid={userId}

Check warning on line 107 in ui-kit/react/components/search.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/search.mdx#L107

Did you really mean 'uid'?
searchIn={["messages"]}
onMessageClicked={(event) => {
scrollToMessage(event.message);
Expand Down Expand Up @@ -178,7 +179,7 @@

### Search Scope

Control which result sections appear using `searchIn`:

Check warning on line 182 in ui-kit/react/components/search.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/search.mdx#L182

Did you really mean 'searchIn'?

```tsx
{/* Only show conversation results */}
Expand All @@ -197,7 +198,7 @@

```tsx
<CometChatSearch
searchFilters={["messages", "conversations", "unread", "photos"]}

Check warning on line 201 in ui-kit/react/components/search.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/search.mdx#L201

Did you really mean 'searchFilters'?
initialSearchFilter="messages"
/>
```
Expand Down Expand Up @@ -613,7 +614,7 @@

---

### guid

Check warning on line 617 in ui-kit/react/components/search.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/search.mdx#L617

Did you really mean 'guid'?

Scope search to a specific group's conversation. When set, conversation filters are hidden.

Expand Down Expand Up @@ -657,7 +658,7 @@

---

### hideReceipts

Check warning on line 661 in ui-kit/react/components/search.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/search.mdx#L661

Did you really mean 'hideReceipts'?

Hide message delivery/read receipts in conversation results.

Expand All @@ -668,9 +669,9 @@

---

### textFormatters

Check warning on line 672 in ui-kit/react/components/search.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/search.mdx#L672

Did you really mean 'textFormatters'?

Text formatters applied to conversation subtitles.

Check warning on line 674 in ui-kit/react/components/search.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/search.mdx#L674

Did you really mean 'formatters'?

| | |
| --- | --- |
Expand Down Expand Up @@ -723,7 +724,7 @@

---

### conversationOptions

Check warning on line 727 in ui-kit/react/components/search.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/search.mdx#L727

Did you really mean 'conversationOptions'?

Function that returns context menu options for each conversation result item.

Expand Down
1 change: 1 addition & 0 deletions ui-kit/react/components/users.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Users"
description: "Searchable, scrollable list of users with selection support and real-time presence updates."

Check warning on line 3 in ui-kit/react/components/users.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/users.mdx#L3

Did you really mean 'scrollable'?
---

<Accordion title="AI Integration Quick Reference">
Expand Down Expand Up @@ -45,6 +45,7 @@
- Search filtering
- Alphabetical section headers
- Selection mode (single/multiple) with optional preview chips
- Offline support (when turned on) — saved users first, and "Connect to load users" or "Connect to search" when nothing is saved. See [Offline Support](/ui-kit/react/offline-support)

---

Expand Down Expand Up @@ -107,7 +108,7 @@
return (
<div style={{ display: "flex", height: "100vh" }}>
<div style={{ width: 360 }}>
<CometChatUsers onItemClick={(u) => setUser(u)} activeUser={user} />

Check warning on line 111 in ui-kit/react/components/users.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/users.mdx#L111

Did you really mean 'activeUser'?
</div>
{user && (
<div style={{ flex: 1, display: "flex", flexDirection: "column" }}>
Expand Down Expand Up @@ -212,7 +213,7 @@

| Slot | Signature | Replaces |
| --- | --- | --- |
| `itemView` | `(user) => ReactNode` | Entire user row |

Check warning on line 216 in ui-kit/react/components/users.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/users.mdx#L216

Did you really mean 'itemView'?
| `leadingView` | `(user) => ReactNode` | Avatar section |
| `titleView` | `(user) => ReactNode` | User name |
| `subtitleView` | `(user) => ReactNode` | Status text |
Expand Down Expand Up @@ -280,7 +281,7 @@
</Tab>
</Tabs>

#### leadingView

Check warning on line 284 in ui-kit/react/components/users.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/users.mdx#L284

Did you really mean 'leadingView'?

Replace the avatar / left section.

Expand Down Expand Up @@ -325,7 +326,7 @@
</Tab>
</Tabs>

#### titleView

Check warning on line 329 in ui-kit/react/components/users.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/users.mdx#L329

Did you really mean 'titleView'?

Replace the name / title text. Role badge inline example.

Expand Down Expand Up @@ -384,7 +385,7 @@
</Tab>
</Tabs>

#### subtitleView

Check warning on line 388 in ui-kit/react/components/users.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/users.mdx#L388

Did you really mean 'subtitleView'?

Replace the subtitle text for each user.

Expand Down Expand Up @@ -432,7 +433,7 @@
</Tab>
</Tabs>

#### trailingView

Check warning on line 436 in ui-kit/react/components/users.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/users.mdx#L436

Did you really mean 'trailingView'?

Replace the right section.

Expand Down Expand Up @@ -498,7 +499,7 @@
| Sub-component | Description | Props | Flat API equivalent |
| --- | --- | --- | --- |
| `Root` | Context provider and container | All Root props + `children` | — |
| `List` | Scrollable user list | `itemView` | `itemView` |

Check warning on line 502 in ui-kit/react/components/users.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/users.mdx#L502

Did you really mean 'Scrollable'?
| `Item` | Individual user row | `leadingView`, `titleView`, `subtitleView`, `trailingView` | Per-item view props |
| `Header` | Header area | `title`, `children` | `headerView` |
| `SearchBar` | Search input | `placeholder` | — |
Expand Down Expand Up @@ -557,7 +558,7 @@

---

### searchKeyword

Check warning on line 561 in ui-kit/react/components/users.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/users.mdx#L561

Did you really mean 'searchKeyword'?

Initial search keyword to pre-filter users on mount.

Expand All @@ -579,7 +580,7 @@

---

### hideSearch

Check warning on line 583 in ui-kit/react/components/users.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/users.mdx#L583

Did you really mean 'hideSearch'?

Hide the search bar entirely.

Expand Down Expand Up @@ -612,9 +613,9 @@

---

### showScrollbar

Check warning on line 616 in ui-kit/react/components/users.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/users.mdx#L616

Did you really mean 'showScrollbar'?

Show the native scrollbar on the user list.

Check warning on line 618 in ui-kit/react/components/users.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/users.mdx#L618

Did you really mean 'scrollbar'?

| | |
| --- | --- |
Expand All @@ -623,7 +624,7 @@

---

### selectionMode

Check warning on line 627 in ui-kit/react/components/users.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/users.mdx#L627

Did you really mean 'selectionMode'?

Enable selection mode for single or multi-select operations.

Expand Down
1 change: 1 addition & 0 deletions ui-kit/react/components/video-bubble.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Video Bubble"
sidebarTitle: "Video Bubble"
description: "A batch-aware bubble that renders one or more video attachments with adaptive grid layouts, poster thumbnails, and a fullscreen viewer."

Check warning on line 4 in ui-kit/react/components/video-bubble.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/video-bubble.mdx#L4

Did you really mean 'fullscreen'?
---

<Accordion title="AI Integration Quick Reference">
Expand All @@ -13,7 +13,7 @@
| Package | `@cometchat/chat-uikit-react` |
| Import | `import { CometChatVideosBubble } from "@cometchat/chat-uikit-react";` |
| CSS root class | `.cometchat-videos-bubble` |
| Primary output | `onVideoClicked: (attachment: CometChatVideosBubbleAttachment, index: number) => void` — opens the fullscreen viewer |

Check warning on line 16 in ui-kit/react/components/video-bubble.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/video-bubble.mdx#L16

Did you really mean 'fullscreen'?
| Prerequisites | App wrapped in [`CometChatProvider`](/ui-kit/react/cometchat-provider) with valid credentials + a logged-in user |
| Stitching | None — self-extracting from the SDK message |
| Full props | See [Props](#props) |
Expand All @@ -30,8 +30,9 @@
- **Poster thumbnails** — auto-generated from the `thumbnail-generation` extension or first frame
- **Duration overlay** — displays video duration on each tile
- **Play icon overlay** — visual indicator on each video tile
- **Fullscreen viewer** — click any video to open in fullscreen player

Check warning on line 33 in ui-kit/react/components/video-bubble.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/video-bubble.mdx#L33

Did you really mean 'Fullscreen'?

Check warning on line 33 in ui-kit/react/components/video-bubble.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/video-bubble.mdx#L33

Did you really mean 'fullscreen'?
- **Batch grouping** — rendered as one connected group when several media messages are sent together (handled by the [message list](/ui-kit/react/components/message-list#multi-attachment-batch-grouping))
- **Offline support** — with [offline support](/ui-kit/react/offline-support) on, media downloaded while online is shown from the device; a file that isn't saved shows "Available when online" while offline, and tapping it asks the SDK to download it

<Note>
Auto poster thumbnails are produced by the **Thumbnail Generation** extension — enable it in the Dashboard ([Thumbnail Generation](/fundamentals/thumbnail-generation)). Without it, the bubble falls back to the first video frame.
Expand All @@ -45,7 +46,7 @@

<iframe
src="https://storybook.cometchat.io/react/iframe.html?id=components-bubbles-message-bubble-videos--grid-2-videos&viewMode=story&shortcuts=false&singleStory=true"
className="w-full rounded-xl"

Check warning on line 49 in ui-kit/react/components/video-bubble.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/video-bubble.mdx#L49

Did you really mean 'className'?
loading="lazy"
style={{height: "600px", border: "1px solid #e0e0e0"}}
title="CometChat Video Bubble — 2 Videos Grid"
Expand Down Expand Up @@ -117,9 +118,9 @@

---

### textFormatters

Check warning on line 121 in ui-kit/react/components/video-bubble.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/video-bubble.mdx#L121

Did you really mean 'textFormatters'?

Text formatters applied to the caption (mentions, URLs).

Check warning on line 123 in ui-kit/react/components/video-bubble.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/video-bubble.mdx#L123

Did you really mean 'formatters'?

| | |
| --- | --- |
Expand Down
1 change: 1 addition & 0 deletions ui-kit/react/components/voice-note-bubble.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Voice Note Bubble"
sidebarTitle: "Voice Note Bubble"
description: "A dedicated bubble for recorded voice notes with waveform playback, rendered when audio messages carry the voice_note metadata tag."

Check warning on line 4 in ui-kit/react/components/voice-note-bubble.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/voice-note-bubble.mdx#L4

Did you really mean 'voice_note'?
---

<Accordion title="AI Integration Quick Reference">
Expand Down Expand Up @@ -40,10 +40,11 @@

Key characteristics:

- **Waveform playback** — play/pause, seekable progress bar, elapsed/total time

Check warning on line 43 in ui-kit/react/components/voice-note-bubble.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/voice-note-bubble.mdx#L43

Did you really mean 'seekable'?
- **Always standalone** — voice notes are never grouped or batched with other messages
- **Metadata-driven** — only used when the message has `audioType: "voice_note"` in metadata
- **Waveform player** — renders with the `CometChatAudioBubble` player and its CSS selectors
- **Offline support** — with [offline support](/ui-kit/react/offline-support) on, a voice note downloaded while online plays from the device; one that isn't saved shows "Available when online" while offline, and tapping it asks the SDK to download it

<Info>
**Live Preview** — interact with the voice note bubble.
Expand Down Expand Up @@ -77,7 +78,7 @@

## How Voice Notes Are Tagged

When a user records audio via the composer's voice recorder, the UIKit stamps `audioType: "voice_note"` into the message metadata before sending:

Check warning on line 81 in ui-kit/react/components/voice-note-bubble.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/components/voice-note-bubble.mdx#L81

Did you really mean 'UIKit'?

```json
{
Expand Down
15 changes: 14 additions & 1 deletion ui-kit/react/core-features.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ description: "Overview of CometChat React UI Kit core features, including messag
| --- | --- |
| Package | `@cometchat/chat-uikit-react` |
| Required setup | Wrap app in `CometChatProvider` with valid credentials — must complete before rendering any component |
| Core features | Instant Messaging, Media Sharing, Read Receipts, Mark as Unread, Typing Indicator, User Presence, Reactions, Mentions, Quoted Reply, Pin & Save Messages, Search, Threaded Conversations, Moderation, Report Message, Group Chat |
| Core features | Instant Messaging, Media Sharing, Read Receipts, Mark as Unread, Typing Indicator, User Presence, Reactions, Mentions, Quoted Reply, Pin & Save Messages, Search, Threaded Conversations, Moderation, Report Message, Group Chat, Offline Support |
| Key components | `CometChatConversations` → [Conversations](/ui-kit/react/components/conversations), `CometChatMessageList` → [Message List](/ui-kit/react/components/message-list), `CometChatMessageComposer` → [Message Composer](/ui-kit/react/components/message-composer), `CometChatMessageHeader` → [Message Header](/ui-kit/react/components/message-header), `CometChatUsers` → [Users](/ui-kit/react/components/users), `CometChatGroups` → [Groups](/ui-kit/react/components/groups), `CometChatGroupMembers` → [Group Members](/ui-kit/react/components/group-members) |
| CSS class prefix | `.cometchat-` |
| Theming | Override CSS variables on `.cometchat` class. See [Theming](/ui-kit/react/theming) |
Expand Down Expand Up @@ -308,6 +308,19 @@ Search requires wiring the result callbacks to navigation: handle `onConversatio

See the [Groups](/ui-kit/react/components/groups) component page for details.

## Offline Support

With offline support turned on, chats and messages the user has already opened appear at once from a cache on the device, messages sent while offline are queued and sent automatically on reconnect, and each list tells the user when something needs a connection ("Connect to load chats", "Connect to search", "Connect to load more"). Offline support is off by default; turn it on with `setOfflineConfig()` on the `UIKitSettingsBuilder`. It needs React UI Kit 7.3.0 and JavaScript Chat SDK 4.3.0 or later.

| Components | Functionality |
| ------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
| [Conversations](/ui-kit/react/components/conversations) | Shows saved conversations first, then merges in the server's list. Shows a notice if unsent messages were lost in a cache reset. |
| [Message List](/ui-kit/react/components/message-list) | Opens chats from the cache, marks queued and failed messages, and offers Retry and Delete on unsent messages. |
| [Message Composer](/ui-kit/react/components/message-composer) | Queues text messages and stickers sent while offline. |
| [Users](/ui-kit/react/components/users), [Groups](/ui-kit/react/components/groups), [Group Members](/ui-kit/react/components/group-members) | Show saved rows first, and "Connect to load …" or "Connect to search" when nothing is saved. |

See [Offline Support](/ui-kit/react/offline-support) for setup, the offline states and texts, events and customization.

---

## Next Steps
Expand Down
11 changes: 10 additions & 1 deletion ui-kit/react/event-system.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@
}
```

The hook automatically subscribes on mount and unsubscribes on unmount. No cleanup needed.

Check warning on line 78 in ui-kit/react/event-system.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/event-system.mdx#L78

Did you really mean 'unmount'?

<Warning>
**`deps` is a required second argument.** It is not optional.
Expand Down Expand Up @@ -226,7 +226,7 @@

| Event Type | Payload | Published by |
| --- | --- | --- |
| `ui:message/sent` | `{ message, status }` | MessageComposer |
| `ui:message/sent` | `{ message, status }` | MessageComposer; `CometChatUIKit.sendTextMessage()` / `sendMediaMessage()` / `sendCustomMessage()` |
| `ui:message/deleted` | `{ message }` | MessageList (after delete) |
| `ui:message/read` | `{ message }` | MessageList (mark as read) |

Expand Down Expand Up @@ -259,6 +259,15 @@
Change either to `status === "success"`, or import `CometChatMessageStatus` and compare with `CometChatMessageStatus.success`.
</Warning>

### Offline Support

Published only with [offline support](/ui-kit/react/offline-support#events) turned on.

| Event Type | Payload | Published by |
| --- | --- | --- |
| `ui:message/send-state-changed` | `{ message, state, reason? }` | UI Kit, when an own message's send state changes (`"sending"`, `"sent"`, `"failed"`, `"discarded"`) |
| `ui:offline/cache-reset` | `{ reason, pendingMessagesLost }` | UI Kit, when the SDK wiped and rebuilt its offline cache |

### Pin and Save (optimistic)

Published by the message options the moment a pin/save succeeds locally, before the network echo. Pinned/Saved panels and the message list listen to these so every surface flips together.
Expand All @@ -266,7 +275,7 @@
| Event Type | Payload | Published by |
| --- | --- | --- |
| `ui:message/pin-changed` | `{ message, pinned }` | Message options (pin / unpin action) |
| `ui:message/save-changed` | `{ message, saved }` | Message options (save / unsave action) |

Check warning on line 278 in ui-kit/react/event-system.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/event-system.mdx#L278

Did you really mean 'unsave'?

### Composer Commands

Expand Down
5 changes: 5 additions & 0 deletions ui-kit/react/integration-astro.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Astro Integration"

Check warning on line 2 in ui-kit/react/integration-astro.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/integration-astro.mdx#L2

Did you really mean 'Astro'?
sidebarTitle: "Integration"
description: "Add CometChat to an Astro app in 5 steps: create project, install, init + login, render island, run."

Check warning on line 4 in ui-kit/react/integration-astro.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/integration-astro.mdx#L4

Did you really mean 'Astro'?
---

<Accordion title="AI Integration Quick Reference">
Expand All @@ -9,19 +9,20 @@
| Field | Value |
| --- | --- |
| Package | `@cometchat/chat-uikit-react` v7.x |
| Peer deps | `react` `>=18 <21`, `react-dom` `>=18 <21`, `@cometchat/chat-sdk-javascript` ^4.2.0; optional `@cometchat/calls-sdk-javascript` ^5.0.3 (calling only) |

Check warning on line 12 in ui-kit/react/integration-astro.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/integration-astro.mdx#L12

Did you really mean 'deps'?
| Bundled deps | `dompurify`, `@cometchat/cards-react` — regular dependencies, installed automatically. Do not add them yourself |

Check warning on line 13 in ui-kit/react/integration-astro.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/integration-astro.mdx#L13

Did you really mean 'deps'?
| Init | `CometChatUIKit.init(UIKitSettings)` — must resolve before `login()` |
| Login | `CometChatUIKit.login("UID")` — must resolve before rendering components |
| Order | `init()` → `login()` → render `<CometChatProvider>`. Breaking this order = blank screen |
| Auth Key | Dev/testing only. Use Auth Token in production |
| SSR | Use `client:only="react"` directive — CometChat components cannot be server-rendered |
| Calling | Optional. Install `@cometchat/calls-sdk-javascript` and call `.setCallingEnabled(true)` on `UIKitSettingsBuilder` |
| Offline support | Optional, off by default. Call `.setOfflineConfig({ enabled: true })` on `UIKitSettingsBuilder`. Needs UI Kit 7.3.0 and `@cometchat/chat-sdk-javascript` 4.3.0 or later. See [Offline Support](/ui-kit/react/offline-support) |
| Other frameworks | [React.js](/ui-kit/react/integration-react) · [Next.js](/ui-kit/react/integration-nextjs) · [React Router](/ui-kit/react/integration-react-router) |

</Accordion>

This guide walks you through adding CometChat to an Astro app using React islands. By the end you'll have a working chat UI.

Check warning on line 25 in ui-kit/react/integration-astro.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/integration-astro.mdx#L25

Did you really mean 'Astro'?

<Frame>
<img src="/images/two_panel_layout_without_tabs_react_v7.png" />
Expand All @@ -47,7 +48,7 @@

---

## Step 1 — Create an Astro Project

Check warning on line 51 in ui-kit/react/integration-astro.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/integration-astro.mdx#L51

Did you really mean 'Astro'?

```bash
npm create astro@latest my-app
Expand Down Expand Up @@ -86,7 +87,7 @@

CometChat components live inside a React island (a `.tsx` file in `src/components/`). Initialize the SDK, login, then render inside `CometChatProvider`.

For development, use one of the pre-created test UIDs:

Check warning on line 90 in ui-kit/react/integration-astro.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/integration-astro.mdx#L90

Did you really mean 'UIDs'?

`cometchat-uid-1` · `cometchat-uid-2` · `cometchat-uid-3` · `cometchat-uid-4` · `cometchat-uid-5`

Expand Down Expand Up @@ -162,11 +163,15 @@
For production, use `CometChatUIKit.loginWithAuthToken(token)` instead of `login(uid)`. Generate auth tokens server-side via the CometChat REST API. Never ship auth keys in client code.
</Note>

<Note>
To show saved chats without a network and queue messages sent while offline, add `.setOfflineConfig({ enabled: true })` to the `UIKitSettingsBuilder` before `build()`. It is off by default and needs `@cometchat/chat-sdk-javascript` 4.3.0 or later. See [Offline Support](/ui-kit/react/offline-support).
</Note>

---

## Step 4 — Render the Island in an Astro Page

Check warning on line 172 in ui-kit/react/integration-astro.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/integration-astro.mdx#L172

Did you really mean 'Astro'?

Create an Astro page that renders the React island with `client:only="react"`. This ensures the component only runs in the browser — no server-side rendering.

Check warning on line 174 in ui-kit/react/integration-astro.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/integration-astro.mdx#L174

Did you really mean 'Astro'?

```astro title="src/pages/index.astro"
---
Expand Down
5 changes: 5 additions & 0 deletions ui-kit/react/integration-nextjs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,15 @@
| Field | Value |
| --- | --- |
| Package | `@cometchat/chat-uikit-react` v7.x |
| Peer deps | `react` `>=18 <21`, `react-dom` `>=18 <21`, `@cometchat/chat-sdk-javascript` ^4.2.0; optional `@cometchat/calls-sdk-javascript` ^5.0.3 (calling only) |

Check warning on line 12 in ui-kit/react/integration-nextjs.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/integration-nextjs.mdx#L12

Did you really mean 'deps'?
| Bundled deps | `dompurify`, `@cometchat/cards-react` — regular dependencies, installed automatically. Do not add them yourself |

Check warning on line 13 in ui-kit/react/integration-nextjs.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/integration-nextjs.mdx#L13

Did you really mean 'deps'?
| Init | `CometChatUIKit.init(UIKitSettings)` — must resolve before `login()` |
| Login | `CometChatUIKit.login("UID")` — must resolve before rendering components |
| Order | `init()` → `login()` → render `<CometChatProvider>`. Breaking this order = blank screen |
| Auth Key | Dev/testing only. Use `loginWithAuthToken` in production |
| SSR | CometChat components must be loaded with `dynamic(() => import(...), { ssr: false })` |
| Calling | Optional. Install `@cometchat/calls-sdk-javascript` and call `.setCallingEnabled(true)` on `UIKitSettingsBuilder` |
| Offline support | Optional, off by default. Call `.setOfflineConfig({ enabled: true })` on `UIKitSettingsBuilder`. Needs UI Kit 7.3.0 and `@cometchat/chat-sdk-javascript` 4.3.0 or later. See [Offline Support](/ui-kit/react/offline-support) |
| Other frameworks | [React.js](/ui-kit/react/integration-react) · [React Router](/ui-kit/react/integration-react-router) · [Astro](/ui-kit/react/integration-astro) |

</Accordion>
Expand Down Expand Up @@ -84,7 +85,7 @@

CometChat uses browser APIs and cannot run in Server Components. Create a `'use client'` component that initializes the SDK, logs in, and renders your chat UI inside `CometChatProvider`.

For development, use one of the pre-created test UIDs:

Check warning on line 88 in ui-kit/react/integration-nextjs.mdx

View check run for this annotation

Mintlify / Mintlify Validation (cometchat-22654f5b) - vale-spellcheck

ui-kit/react/integration-nextjs.mdx#L88

Did you really mean 'UIDs'?

`cometchat-uid-1` · `cometchat-uid-2` · `cometchat-uid-3` · `cometchat-uid-4` · `cometchat-uid-5`

Expand Down Expand Up @@ -162,6 +163,10 @@
For production, use `CometChatUIKit.loginWithAuthToken(token)` instead of `login(uid)`. Generate auth tokens server-side via the CometChat REST API. Never ship auth keys in client code.
</Note>

<Note>
To show saved chats without a network and queue messages sent while offline, add `.setOfflineConfig({ enabled: true })` to the `UIKitSettingsBuilder` before `build()`. It is off by default and needs `@cometchat/chat-sdk-javascript` 4.3.0 or later. See [Offline Support](/ui-kit/react/offline-support).
</Note>

---

## Step 4 — Import with SSR Disabled
Expand Down
Loading