Skip to main content

Documentation Index

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

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

FieldValue
Package@cometchat/chat-uikit-react v7.0.x
Peer depsreact >=18, react-dom >=18, @cometchat/chat-sdk-javascript ^4.1.9, dompurify ^3.3.1
CallingOptional — @cometchat/calls-sdk-javascript
SSRSSR-safe — no browser APIs at module scope. Next.js App Router compatible.
Localization19 languages built-in
Source GitHub
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.

Try It

Live Demo

Try the full chat experience in your browser

CodeSandbox

Fork, add your credentials, and start building

Get Started

Pick your framework and follow the step-by-step integration guide:

React.js

Vite or Create React App

Next.js

App Router with client-side rendering

React Router

SPA with React Router v6+

Astro

React islands with client:only directive

What’s Included

  • Compound components — compose only what you need using namespace sub-components (Root, View, EmptyState, etc.)
  • Plugin system — extensible message rendering via CometChatMessagePlugin interface
  • Theming — CSS custom properties (--cometchat-*) with built-in light and dark themes
  • Localization — 19 supported languages with customizable translation keys
  • Calling — optional voice and video calling via @cometchat/calls-sdk-javascript
  • SSR-safe — no browser-only APIs at module scope; Next.js App Router compatible
  • Tree-shakeable — ESM-first build with dual ESM + CJS output

Prerequisites

Before integrating the UI Kit, ensure you have:
  • Node.js 18+ installed
  • A CometChat account with the following credentials:
    • appId — your CometChat application ID
    • region — your app region (e.g., "us" or "eu")
    • authKey — your CometChat auth key (for client-side authentication)
You can find these values in the CometChat Dashboard.

Installation

npm install @cometchat/chat-uikit-react @cometchat/chat-sdk-javascript react react-dom dompurify
PackageVersion
@cometchat/chat-uikit-react^7.0.0
@cometchat/chat-sdk-javascript^4.1.9
react>=18.0.0 <21.0.0
react-dom>=18.0.0 <21.0.0
dompurify^3.3.1
@cometchat/calls-sdk-javascriptOptional — for voice/video calling

Explore

Components

Browse all prebuilt UI components

Theming

Colors, fonts, dark mode, and custom styling

Plugins

Customize message rendering with the plugin system

Guides

Threaded messages, new chat, search, and more

Resources

Sample App

Working reference app

Source Code

Full UI Kit source on GitHub

Figma

Design resources and prototyping

Troubleshooting

Common issues and fixes

Support

Open a support ticket

Migration Guide

Upgrading from v6