Skip to content
Open
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
4 changes: 4 additions & 0 deletions fundamentals/pin-message.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ title: "Pin Message"
description: "Pin, unpin, and fetch pinned CometChat messages in one-on-one or group conversations using the Pin Message extension."
---

import { EntryPoint } from "/snippets/entry-point.mdx";

<EntryPoint campaign="fundamentals" />

## Extension settings

1. Login to [CometChat](https://app.cometchat.com/login) and select your app.
Expand Down
4 changes: 4 additions & 0 deletions fundamentals/webhooks.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ sidebarTitle: "Webhooks"
description: "Use CometChat webhooks to send real-time chat, user, group, call, and moderation events to your server."
---

import { EntryPoint } from "/snippets/entry-point.mdx";

<EntryPoint campaign="fundamentals" />

CometChat Webhooks enable real-time, event-driven communication with your server by sending HTTP POST requests whenever specific events occur in your chat application.

## What Are Webhooks?
Expand Down
4 changes: 4 additions & 0 deletions mcp-server.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ description: "Connect CometChat to Claude, Cursor, Windsurf, VS Code, and any ot
canonical: "https://www.cometchat.com/docs/mcp-server"
---

import { EntryPoint } from "/snippets/entry-point.mdx";

<EntryPoint campaign="mcp-server" />

The **CometChat MCP server** lets Claude, Cursor, Windsurf, VS Code, and any
other Model Context Protocol–compatible agent integrate CometChat into your
app from natural-language prompts. Ask the agent to *"add a chat tab where
Expand Down
4 changes: 4 additions & 0 deletions notifications/ios-fcm-push-notifications.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ title: "iOS FCM Push Notifications"
description: "Guide to integrating Firebase Cloud Messaging (FCM) push notifications in iOS apps using CometChat."
---

import { EntryPoint } from "/snippets/entry-point.mdx";

<EntryPoint stack="iOS" campaign="notifications" />

<Note>FCM doesn't support VoIP pushes; use APNs + PushKit for VoIP calls.</Note>

<Note>
Expand Down
4 changes: 4 additions & 0 deletions rest-api/banned-users/unban.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,8 @@ openapi: delete /groups/{guid}/bannedusers/{uid}
description: "Unban a CometChat user from a group using GUID and UID parameters to restore group access through the REST API."
---

import { EntryPoint } from "/snippets/entry-point.mdx";

<EntryPoint campaign="rest-api" />

For the complete error reference, see [Error Guide](/articles/error-guide).
4 changes: 4 additions & 0 deletions rest-api/chat-apis.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ title: "Overview"
description: "CometChat REST API documentation for integrating chat functionality into your server-side applications."
---

import { EntryPoint } from "/snippets/entry-point.mdx";

<EntryPoint campaign="rest-api" />

Welcome to CometChat's REST API documentation! This documentation provides detailed information on the Chat APIs offered by CometChat, a comprehensive communication platform that enables developers to integrate chat functionality into their server side applications effortlessly.

## API Resources
Expand Down
4 changes: 4 additions & 0 deletions rest-api/messages.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ title: "Overview"
description: "Send, retrieve, and manage CometChat messages with REST APIs for user and group chats, including text, media, threads, and reactions."
---

import { EntryPoint } from "/snippets/entry-point.mdx";

<EntryPoint campaign="rest-api" />

A **Message** is the core unit of communication in CometChat. Users can send text, media files, and custom data to other users or groups. Messages support threading, reactions, read receipts, and delivery tracking.

### Key behaviors
Expand Down
4 changes: 4 additions & 0 deletions sdk/android/edit-message.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ sidebarTitle: "Edit Message"
description: "Edit CometChat text and custom messages after sending them with the Android SDK and update message state in chats."
---

import { EntryPoint } from "/snippets/entry-point.mdx";

<Accordion title="AI Integration Quick Reference">

```kotlin
Expand All @@ -27,6 +29,8 @@ CometChat.addMessageListener("LISTENER_ID", object : CometChat.MessageListener()
```
</Accordion>

<EntryPoint stack="Android SDK" campaign="sdk" />

## Edit a Message

Use `editMessage()` with a [`TextMessage`](/sdk/reference/messages#textmessage) or [`CustomMessage`](/sdk/reference/messages#custommessage) object. Set the message ID using `setId()`.
Expand Down
4 changes: 4 additions & 0 deletions sdk/javascript/3.0/messaging-edit-message.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ title: "Edit A Message"
description: "Edit A Message — CometChat documentation."
---

import { EntryPoint } from "/snippets/entry-point.mdx";

<EntryPoint stack="JavaScript SDK" campaign="sdk" />



While [editing a message](/sdk/javascript/3.0/messaging-edit-message#edit-a-message) is straightforward, receiving events for edited messages with CometChat has two parts:
Expand Down
46 changes: 46 additions & 0 deletions snippets/entry-point.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
{/*
The docs entry point: one line under the title, one link to the Start-here guide for the
stack of the page it sits on. The wording lives here and nowhere else, so it changes in
one place (task T-docs-entry.05).

Props
stack a key of the guides map below. Leave it out when the page has no single stack,
or when the platform has more than one product line and the page does not say
which (a notifications page is read by both UI Kit and SDK users). The line
then points at the page where a reader picks one.
campaign the docs section the page sits in. It becomes utm_campaign.

The destination is derived from stack, never passed in. An href prop would be a second
source of truth for the same fact, and when it was one the pair drifted on four of nine
pages (reviewed on #585).

A stack that is not in the map falls back to the chooser rather than throwing. A throw
here would be a build failure, and a build failure in a table cell is what froze five
React pages on live for six weeks, so this component does not add that risk.

Every link carries utm_source=docs and utm_medium=entry, so a signup that starts on a
docs page can be counted (task T-docs-entry.07). Tracking is built in one place below,
so it comes out in one edit if that decision changes.

JSX, not Markdown: inside an exported component, Markdown renders literally. The sentence
stays on one line so the serialized .md output is one line too.
*/}

export const EntryPoint = ({ stack, campaign }) => {
const guides = {
"React": "/ui-kit/react/integration-react",
"Next.js": "/ui-kit/react/integration-nextjs",
"React Native": "/ui-kit/react-native/react-native-cli-integration",
"Android": "/ui-kit/android/getting-started",
"Android SDK": "/sdk/android/setup",
"iOS": "/ui-kit/ios/getting-started",
"JavaScript SDK": "/sdk/javascript/setup-sdk",
};
const guide = stack ? guides[stack] : undefined;
const [path, fragment] = (guide || "/chat-call").split("#");
const tracking = `utm_source=docs&utm_medium=entry&utm_campaign=${encodeURIComponent(campaign)}`;
const href = `${path}${path.includes("?") ? "&" : "?"}${tracking}${fragment ? `#${fragment}` : ""}`;
return (
<p>New to CometChat? <a href={href}>{guide ? `Start with the ${stack} integration guide` : "Pick your stack and start building"}</a>.</p>
);
};
4 changes: 4 additions & 0 deletions ui-kit/android/guide-new-chat.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ sidebarTitle: "New Chat"
description: "Enable users to start one-on-one or group chats from a new chat screen with user and group browsing."
---

import { EntryPoint } from "/snippets/entry-point.mdx";

<Accordion title="AI Integration Quick Reference">

| Field | Value |
Expand All @@ -15,6 +17,8 @@ description: "Enable users to start one-on-one or group chats from a new chat sc

</Accordion>

<EntryPoint stack="Android" campaign="ui-kit" />

Enable users to start one-on-one or group chats by integrating CometChat's **New Chat** screen (`CometChatUsers` + `CometChatGroups`), providing a seamless flow from your conversation list to a specific chat.

## Overview
Expand Down
3 changes: 3 additions & 0 deletions ui-kit/kotlin/2.0/ui-components.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ title: "UI Components"
description: "UI Components — CometChat documentation."
---

import { EntryPoint } from "/snippets/entry-point.mdx";


Version: v2

**UI Components** are building a block of the UI Kit. **UI Components** are a set of custom classes specially designed to build a feature-rich chat app. To achieve high customizability while building an app one can use the UI Components. There are different UI Components available in the UI Kit library.
Expand Down
4 changes: 4 additions & 0 deletions ui-kit/react-native/message-bubble-styling.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: "Message Bubble Styling"
description: "Customize CometChat React Native UI Kit message bubbles for text, image, video, audio, file, poll, and other message types."
---

import { EntryPoint } from "/snippets/entry-point.mdx";

<Accordion title="AI Integration Quick Reference">

| Field | Value |
Expand All @@ -20,6 +22,8 @@ description: "Customize CometChat React Native UI Kit message bubbles for text,

</Accordion>

<EntryPoint stack="React Native" campaign="ui-kit" />

Customize message bubble appearance by passing bubble styles in `theme.messageListStyles`.

<Warning>
Expand Down
4 changes: 4 additions & 0 deletions ui-kit/react/components/message-composer.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: "Message Composer"
description: "Rich text input with attachments, emoji, voice recording, mentions, and formatting for sending messages."
---

import { EntryPoint } from "/snippets/entry-point.mdx";

<Accordion title="AI Integration Quick Reference">
```json
{
Expand Down Expand Up @@ -134,6 +136,8 @@ description: "Rich text input with attachments, emoji, voice recording, mentions
```
</Accordion>

<EntryPoint stack="React" campaign="ui-kit" />

## Overview

`CometChatMessageComposer` is a rich text input component for sending messages. It supports attachments, emoji, voice recording, mentions, rich text formatting, and reply/edit previews. Wire it alongside `CometChatMessageList` and `CometChatMessageHeader` to build a complete messaging experience.
Expand Down
4 changes: 4 additions & 0 deletions ui-kit/react/guide-new-chat-creation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ sidebarTitle: "New Chat Creation"
description: "Start new one-on-one or group conversations by selecting users or groups from a list."
---

import { EntryPoint } from "/snippets/entry-point.mdx";

<EntryPoint stack="React" campaign="ui-kit" />

## Goal

By the end of this guide you will have a chat interface where users can initiate new one-on-one conversations by selecting from a user list, or start group chats by selecting from available groups — then immediately begin messaging.
Expand Down
4 changes: 4 additions & 0 deletions ui-kit/react/next-tab-based-chat.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ sidebarTitle: "Tab-Based Chat"
description: "Build a tab-based chat interface with Chat, Call Logs, and Users tabs in Next.js (App Router)."
---

import { EntryPoint } from "/snippets/entry-point.mdx";

<Accordion title="AI Integration Quick Reference">

| Field | Value |
Expand All @@ -18,6 +20,8 @@ description: "Build a tab-based chat interface with Chat, Call Logs, and Users t

</Accordion>

<EntryPoint stack="Next.js" campaign="ui-kit" />

This guide builds a tabbed messaging UI — Chat, Calls, and Users tabs in the sidebar, with a message view on the right. Good for full-featured apps that need more than just conversations.

This assumes you've already completed [Next.js Integration](/ui-kit/react/integration-nextjs) (project created, UI Kit installed, init + login working).
Expand Down
4 changes: 4 additions & 0 deletions ui-kit/react/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ sidebarTitle: "Overview"
description: "Prebuilt React components for chat, voice, and video calling. Supports React.js, Next.js, React Router, and Astro."
---

import { EntryPoint } from "/snippets/entry-point.mdx";

<Accordion title="AI Integration Quick Reference">

| Field | Value |
Expand All @@ -18,6 +20,8 @@ description: "Prebuilt React components for chat, voice, and video calling. Supp

</Accordion>

<EntryPoint campaign="ui-kit" />

The CometChat React UI Kit provides prebuilt, customizable components for adding chat, voice, and video calling to any React app. Each component handles its own data fetching, real-time listeners, and state — you just drop them into your layout.

<Frame>
Expand Down
3 changes: 3 additions & 0 deletions web-shared/localize.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ title: "Localize"
description: "Localize — CometChat documentation."
---

import { EntryPoint } from "/snippets/entry-point.mdx";


With language localization, CometChat UI Kit adapts to the language of a specific country or region. `CometChatLocalize` allows you to detect the language of your users based on their browser settings and set the language accordingly.

## Supported languages
Expand Down
3 changes: 3 additions & 0 deletions web-shared/reactions-configuration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ title: "ReactionsConfiguration"
description: "ReactionsConfiguration — CometChat documentation."
---

import { EntryPoint } from "/snippets/entry-point.mdx";


You can modify the Reaction component's properties using the ReactionsConfiguration object. To use a configuration, you simply need to pass it to respective parameter.

The ReactionsConfiguration supports the following properties:
Expand Down