Groups - CometChat Docs

Overview

The Groups is a Component, showcasing an accessible list of all available groups. It provides an integral search functionality, allowing you to locate any specific groups swiftly and easily. For each group listed, the group name is displayed by default, in conjunction with the group icon when available. Additionally, it provides a useful feature by displaying the number of members in each group as a subtitle, offering valuable context about group size and activity level.

The Groups component is composed of the following BaseComponents:

Components	Description
CometChatList	A reusable container component having title, search box, customisable background and a list view.
CometChatListItem	A component that renders data obtained from a Group object on a Tile having a title, subtitle, leading and trailing view.

Usage

Integration

The following code snippet illustrates how you can directly incorporate the Groups component into your Application.

import { CometChatGroups } from "@cometchat/chat-uikit-react";
import React from "react";

const GroupsDemo = () => {
  return <CometChatGroups />;
};

export default GroupsDemo;

Actions

Actions dictate how a component functions. They are divided into two types: Predefined and User-defined. You can override either type, allowing you to tailor the behavior of the component to fit your specific needs.

1. onSelect

The onSelect action is activated when you select the done icon while in selection mode. This returns the group object along with the boolean flag selected to indicate if the group was selected or unselected. This action does not come with any predefined behavior. However, you have the flexibility to override this event and tailor it to suit your needs using the following code snippet.

import { CometChat } from "@cometchat/chat-sdk-javascript";
import { CometChatGroups, SelectionMode } from "@cometchat/chat-uikit-react";
import React from "react";

const GroupsDemo = () => {
  function handleOnSelect(group: CometChat.Group, selected: boolean): void {
    console.log(group);
    //your custom onSelect actions
  }
  return (
    <CometChatGroups
      selectionMode={SelectionMode.multiple}
      onSelect={handleOnSelect}
    />
  );
};

export default GroupsDemo;

2. onItemClick

The onItemClick event is activated when you click on the Group List item. This action does not come with any predefined behavior. However, you have the flexibility to override this event and tailor it to suit your needs using the following code snippet.

import { CometChat } from "@cometchat/chat-sdk-javascript";
import { CometChatGroups } from "@cometchat/chat-uikit-react";
import React from "react";

const GroupsDemo = () => {
  function handleOnItemClick(group: CometChat.Group): void {
    console.log(group, "your custom on item click action");
  }
  return <CometChatGroups onItemClick={handleOnItemClick} />;
};

export default GroupsDemo;

3. onError

This action doesn’t change the behavior of the component but rather listens for any errors that occur in the Groups component.

import { CometChat } from "@cometchat/chat-sdk-javascript";
import { CometChatGroups } from "@cometchat/chat-uikit-react";
import React from "react";

const GroupsDemo = () => {
  const handleOnError = (error: CometChat.CometChatException) => {
    console.log("Your custom on error actions");
  };
  return <CometChatGroups onError={handleOnError} />;
};

export default GroupsDemo;

Filters

Filters allow you to customize the data displayed in a list within a Component. You can filter the list based on your specific criteria, allowing for a more customized. Filters can be applied using RequestBuilders of Chat SDK.

1. GroupsRequestBuilder

The GroupsRequestBuilder enables you to filter and customize the group list based on available parameters in GroupsRequestBuilder. This feature allows you to create more specific and targeted queries when fetching groups. The following are the parameters available in GroupsRequestBuilder

Methods	Type	Description
setLimit	number	sets the number groups that can be fetched in a single request, suitable for pagination
setSearchKeyword	String	used for fetching groups matching the passed string
joinedOnly	boolean	to fetch only joined groups.
setTags	Array<String>	used for fetching groups containing the passed tags
withTags	boolean	used to fetch tags data along with the list of groups

Example In the example below, we are applying a filter to the Group List based on only joined groups and setting the limit to two.

import { CometChat } from "@cometchat/chat-sdk-javascript";
import { CometChatGroups } from "@cometchat/chat-uikit-react";
import React from "react";

const GroupsDemo = () => {
  return (
    <CometChatGroups
      groupsRequestBuilder={new CometChat.GroupsRequestBuilder()
        .setLimit(2)
        .joinedOnly(true)}
    />
  );
};

export default GroupsDemo;

2. SearchRequestBuilder

The SearchRequestBuilder uses GroupsRequestBuilder enables you to filter and customize the search list based on available parameters in GroupsRequestBuilder. This feature allows you to keep uniformity between the displayed Groups List and searched Group List. Example

import { CometChat } from "@cometchat/chat-sdk-javascript";
import { CometChatGroups } from "@cometchat/chat-uikit-react";
import React from "react";

const GroupsDemo = () => {
  return (
    <CometChatGroups
      searchRequestBuilder={new CometChat.GroupsRequestBuilder()
        .setLimit(2)
        .setSearchKeyword("your keyword")}
    />
  );
};

export default GroupsDemo;

Events

Events are emitted by a Component. By using event you can extend existing functionality. Being global events, they can be applied in Multiple Locations and are capable of being Added or Removed. To handle events supported by Groups you have to add corresponding listeners by using CometChatGroupEvents The Groups component does not produce any events directly.

Customization

To fit your app’s design requirements, you can customize the appearance of the Groups component. We provide exposed methods that allow you to modify the experience and behavior according to your specific needs.

Style

Using CSS you can customize the look and feel of the component in your app like the color, size, shape, and fonts. Example

import { CometChatGroups } from "@cometchat/chat-uikit-react";
import React from "react";

const GroupsDemo = () => {
  return <CometChatGroups />;
};

export default GroupsDemo;

Functionality

These are a set of small functional customizations that allow you to fine-tune the overall experience of the component. With these, you can change text, set custom icons, and toggle the visibility of UI elements.

import { CometChatGroups, TitleAlignment } from "@cometchat/chat-uikit-react";
import React from "react";

const GroupsDemo = () => {
  return (
    <CometChatGroups
      title="Your Custom Title"
      titleAlignment={TitleAlignment.center}
      hideSearch={true}
    />
  );
};

export default GroupsDemo;

Below is a list of customizations along with corresponding code snippets:

Property	Description	Code
Hide Search	Hides the default search bar.	`hideSearch={true}`
Hide Error	Hides the default and custom error view passed in `errorView` prop.	`hideError={true}`
Hide Group Type	Hides the group type icon.	`hideGroupType={true}`
Active Group	The group to highlight in the list.	`activeGroup={chatGroup}`
Selection Mode	Selection mode to use for the default trailing view.	`selectionMode={SelectionMode.multiple}`
Show Scrollbar	Controls the visibility of the scrollbar in the list.	`showScrollbar={true}`
Loading View	A custom view to display during the loading state.	`loadingView={<>Custom Loading View</>}`
Empty View	Custom view for the empty state of the component.	`emptyView={<>Custom Empty View</>}`
Error View	A custom view to display when an error occurs.	`errorView={<>Custom Error View</>}`

Advanced

For advanced-level customization, you can set custom views to the component. This lets you tailor each aspect of the component to fit your exact needs and application aesthetics. You can create and define your views, layouts, and UI elements and then incorporate those into the component.

ItemView

A custom view to render for each group in the fetched list. Shown below is the default chat interface.

The customized chat interface is displayed below.

Use the following code to achieve the customization shown above.

import { CometChat } from "@cometchat/chat-sdk-javascript";
import { CometChatGroups } from "@cometchat/chat-uikit-react";
import React from "react";

const GroupsDemo = () => {
  const getItemView = (group: CometChat.Group) => {
    return (
      <div className="group-list-item">
        <div className="group-list-item__title-wrapper">
          <div className="group-list-item__title">{group.getName()}</div>
          <div className="group-list-item__tail">JOIN</div>
        </div>
        <div className="group-list-item__subtitle">
          {group.getMembersCount()} Members • {group.getDescription()}
        </div>
      </div>
    );
  };

  return <CometChatGroups itemView={getItemView} />;
};

export default GroupsDemo;

TitleView

The customized chat interface is displayed below.

Use the following code to achieve the customization shown above.

import React from "react";
import { CometChat } from "@cometchat/chat-sdk-javascript";
import { CometChatGroups } from "@cometchat/chat-uikit-react";

// Custom title view component
const customTitleView = (group: CometChat.Group) => {
   return <div className={`groups__title-view groups__title-view-${group.getType()}`}>
      <span className="groups__title-view-name">{group.getName()}</span>
      <span className="groups__title-view-type"><img src={"ICON_HERE"}/>{group.getType()}</span>
  </div>;
}

<CometChatGroups user={userObj} titleView={customTitleView} />;

SubtitleView

Custom subtitle view to be rendered for each group in the fetched list. Shown below is the default chat interface.

The customized chat interface is displayed below.

Use the following code to achieve the customization shown above.

import { CometChat } from "@cometchat/chat-sdk-javascript";
import { CometChatGroups } from "@cometchat/chat-uikit-react";
import React from "react";

const GroupsDemo = () => {
  const getSubtitleView = (group: CometChat.Group): JSX.Element => {
    if (!(group instanceof CometChat.Group)) {
      return <></>;
    }

    return (
      <div className="group-subtitle">
        {group.getMembersCount()} Members • {group.getDescription()}
      </div>
    );
  };

  return <CometChatGroups subtitleView={getSubtitleView} />;
};

export default GroupsDemo;

LeadingView

The customized chat interface is displayed below.

Use the following code to achieve the customization shown above.

import React from "react";
import { CometChat } from "@cometchat/chat-sdk-javascript";
import { CometChatGroups,CometChatAvatar } from "@cometchat/chat-uikit-react";

// Custom leading view component
 const customLeadingView = (group: CometChat.Group) => {
        return <>
            {group.getHasJoined() ? <div className="groups__leading-view groups__leading-view-joined">
                <CometChatAvatar
                    image={group?.getIcon()}
                    name={group?.getName()}
                />
                {/* Icon here */}
                <span className="groups__leading-view-info"> Joined</span>


            </div> : <div className="groups__leading-view">
                <CometChatAvatar
                    image={group?.getIcon()}
                    name={group?.getName()}
                />
                {/* Icon here */}
                <span className="groups__leading-view-info"> Join</span>


            </div>}</>;
    }

<CometChatGroups  leadingView={customLeadingView} />;

TrailingView

The customized chat interface is displayed below.

Use the following code to achieve the customization shown above.

import React from "react";
import { CometChat } from "@cometchat/chat-sdk-javascript";
import {
  CometChatGroups,
} from "@cometchat/chat-uikit-react";

// Custom trailing view component
const customTrailingButtonView = (group:CometChat.Group) =>  {
return <div className="groups__trailing-view">
 {group.getHasJoined() ? "JOINED" : "+ JOIN"}
</div>
}

<CometChatGroups  trailingView={customTrailingButtonView} />;

Header View

A custom component to render in the top-right corner of the groups list. The customized chat interface is displayed below.

Use the following code to achieve the customization shown above.

import { CometChatGroups } from "@cometchat/chat-uikit-react";
import React from "react";

const GroupsDemo = () => {
  const getHeaderView = () => {
    return <div className="group-header-view" />;
  };

  return <CometChatGroups headerView={getHeaderView()} />;
};

export default GroupsDemo;

Options

You can set the Custom options to the Groups component. The customized chat interface is displayed below.

Use the following code to achieve the customization shown above.

import { CometChatGroups, CometChatOption } from "@cometchat/chat-uikit-react";
import React from "react";

const GroupsDemo = () => {
  const getOptions = (group: CometChat.Group): CometChatOption[] => {
    return [
      new CometChatOption({
        id: "delete",
        title: "delete",
        onClick: () => {
          console.log("Custom option clicked for group:", group);
        },
      }),
    ];
  };

  return <CometChatGroups options={getOptions} />;
};

export default GroupsDemo;

​Overview

​Usage

​Integration

​Actions

1. onSelect

2. onItemClick

3. onError

​Filters

1. GroupsRequestBuilder

2. SearchRequestBuilder

​Events

​Customization

​Style

​Functionality

​Advanced

​ItemView

​TitleView

​SubtitleView

​LeadingView

​TrailingView

​Header View

​Options

Overview

Usage

Integration

Actions

Filters

Events

Customization

Style

Functionality

Advanced

ItemView

TitleView

SubtitleView

LeadingView

TrailingView

Header View

Options