CometChat Pro Documentation

You'll find comprehensive guides and documentation to help you start working with CometChat as quickly as possible. Let's jump right in!

React UI Kit

Learn a quick integration of text chat and voice/video calling features for your application

The CometChat React UI Kit is developed to keep developers in mind and aims to reduce development efforts significantly.

The UI Kit’s customizable UI components simplify the process of integrating text chat and voice/video calling features to your website or mobile application in a few minutes.

I want to checkout React UI Kit.

Follow the steps mentioned in the README.md file.

Kindly, click on below button to download our React UI Kit.

React UI Kit

View on Github

I want to explore the sample app

Kindly, click on below button to download our React Sample App.

React Sample App

View on Github

Installation Steps

Prerequisites

Before you begin, ensure you have met the following requirements:

  1. A text editor. (e.g. Visual Studio Code, Notepad++, Sublime Text, Atom, or VIM)

  2. Node

  3. npm

  4. React

npm install [email protected]
  1. React DOM
npm install [email protected]
  1. React Scripts
npm install [email protected]

Installing React UI Kit

Setup

  1. Register on CometChat
  • To install React UI Kit, you need to first register on the CometChat Dashboard. Click here to Sign Up.
  1. Get your application keys
  • Create a new app.
  • Head over to the QuickStart or API & Auth Keys section and note the App ID, Auth Key, and Region.
  1. Add the CometChat dependency
npm install @cometchat-pro/[email protected] --save

Configure CometChat inside your app

  1. Import CometChat SDK
import { CometChat } from "@cometchat-pro/chat";
  1. Initialize CometChat
    The init() method initializes the settings required for CometChat.
    We suggest calling the init() method on app startup, preferably in the created() method of the Application class.
const appID = "APP_ID";
const region = "REGION";
const appSetting = new CometChat.AppSettingsBuilder().subscribePresenceForAllUsers().setRegion(region).build();
CometChat.init(appID, appSetting).then(
  () => {
    console.log("Initialization completed successfully");
    // You can now call login function.
  },
  error => {
    console.log("Initialization failed with error:", error);
    // Check the reason for error and take appropriate action.
  }
);

🚧

Note

Replace APP_ID and REGION with your CometChat App ID and Region in the above code.

  1. Login your user
    This method takes UID and Auth Key as input parameters and returns the User object containing all the information of the logged-in user.
const authKey = "AUTH_KEY";
const uid = "SUPERHERO1";

CometChat.login(uid, authKey).then(
  user => {
    console.log("Login Successful:", { user });    
  },
  error => {
    console.log("Login failed with exception:", { error });    
  }
);

🚧

Note

Replace AUTH_KEY with your CometChat Auth Key in the above code.

πŸ“˜

Note

We have set up 5 users for testing having UIDs: SUPERHERO1, SUPERHERO2, SUPERHERO3, SUPERHERO4, and SUPERHERO5.

We have used uid SUPERHERO1 as an example here. You can create a User from CometChat Dashboard as well.

Add UI Kit to your project

  • Clone this repository
git clone https://github.com/cometchat-pro/cometchat-pro-react-ui-kit.git
  • Copy the cloned repository to your source folder
  • Copy all the dependencies from package.json into your project's package.js and install them

Launch CometChat

Using the CometChatUI component, you can launch a fully functional chat application. In this component, all the UI Screens and UI Components are interlinked and work together to launch a fully functional chat on your website/application.

Usage

import { CometChatUI } from "./CometChatWorkspace/src";

class App extends React.Component {
  
  render() {

    return (
      <div style={{width: '800px', height:'800px' }}>
        <CometChatUI />
      </div>
    );
    }
}

Checkout our sample app

Visit our React sample app repo to run the React sample app.

Updated 14 days ago



React UI Kit


Learn a quick integration of text chat and voice/video calling features for your application

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.