Group Members - CometChat Docs

Overview

CometChatGroupMembers is a Component that displays all users added or invited to a group, granting them access to group discussions, shared content, and collaborative features. Group members can communicate in real-time via messaging, voice and video calls, and other activities. They can interact, share files, and join calls based on group permissions set by the administrator or owner.

Usage

Integration

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

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

const GroupMembersDemo = () => {
  const [chatGroup, setChatGroup] = React.useState<CometChat.Group>();

  React.useEffect(() => {
    CometChat.getGroup("guid").then((group) => {
      setChatGroup(group);
    });
  }, []);

  return <>{chatGroup && <CometChatGroupMembers group={chatGroup} />}</>;
};

export default GroupMembersDemo;

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 a list of all the group members that you have selected. 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 {
  CometChatGroupMembers,
  SelectionMode,
} from "@cometchat/chat-uikit-react";
import React from "react";

const GroupMembersDemo = () => {
  const [chatGroup, setChatGroup] = React.useState<CometChat.Group>();

  React.useEffect(() => {
    CometChat.getGroup("guid").then((group) => {
      setChatGroup(group);
    });
  }, []);

  function handleOnSelect(
    groupMembers: CometChat.GroupMember,
    selected: boolean
  ): void {
    console.log(groupMembers, selected);
    /** Your custom onSelect actions */
  }

  return (
    <>
      {chatGroup && (
        <CometChatGroupMembers
          group={chatGroup}
          selectionMode={SelectionMode.multiple}
          onSelect={handleOnSelect}
        />
      )}
    </>
  );
};

export default GroupMembersDemo;

2. onItemClick

The onItemClick event is activated when you click on the Group Members 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 { CometChatGroupMembers } from "@cometchat/chat-uikit-react";
import React from "react";

const GroupMembersDemo = () => {
  const [chatGroup, setChatGroup] = React.useState<CometChat.Group>();

  React.useEffect(() => {
    CometChat.getGroup("guid").then((group) => {
      setChatGroup(group);
    });
  }, []);

  function handleOnItemClick(groupMembers: CometChat.GroupMember): void {
    console.log(groupMembers, "your custom on item click action");
  }

  return (
    <>
      {chatGroup && (
        <CometChatGroupMembers
          group={chatGroup}
          onItemClick={handleOnItemClick}
        />
      )}
    </>
  );
};

export default GroupMembersDemo;

3. onEmpty

This action allows you to specify a callback function to be executed when a certain condition, typically the absence of data or content, is met within the component or element.

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

const GroupMembersDemo = () => {
  const [chatGroup, setChatGroup] = React.useState<CometChat.Group>();

  React.useEffect(() => {
    CometChat.getGroup("guid").then((group) => {
      setChatGroup(group);
    });
  }, []);

  function handleOnEmpty(): void {
    console.log("your custom on empty actions");
  }

  return (
    <>
      {chatGroup && (
        <CometChatGroupMembers group={chatGroup} onEmpty={handleOnEmpty} />
      )}
    </>
  );
};

export default GroupMembersDemo;

4. onError

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

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

const GroupMembersDemo = () => {
  const [chatGroup, setChatGroup] = React.useState<CometChat.Group>();

  React.useEffect(() => {
    CometChat.getGroup("guid").then((group) => {
      setChatGroup(group);
    });
  }, []);

  function handleOnError(error: CometChat.CometChatException): void {
    /** Your Custom on error actions */
  }

  return (
    <>
      {chatGroup && (
        <CometChatGroupMembers group={chatGroup} onError={handleOnError} />
      )}
    </>
  );
};

export default GroupMembersDemo;

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. GroupMembersRequestBuilder

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

Methods	Type	Description
setLimit	number	sets the number of group members that can be fetched in a single request, suitable for pagination
setSearchKeyword	String	used for fetching group members matching the passed string
setScopes	Array<String>	used for fetching group members based on multiple scopes

Example In the example below, we are applying a filter to the Group Members by setting the limit to two and setting the scope to show only admin and moderator.

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

const GroupMembersDemo = () => {
  const [chatGroup, setChatGroup] = React.useState<CometChat.Group>();

  React.useEffect(() => {
    CometChat.getGroup("guid").then((group) => {
      setChatGroup(group);
    });
  }, []);

  return (
    <>
      {chatGroup && (
        <CometChatGroupMembers
          group={chatGroup}
          groupMemberRequestBuilder={new CometChat.GroupMembersRequestBuilder(
            "guid"
          )
            .setLimit(2)
            .setScopes(["admin", "moderator"])}
        />
      )}
    </>
  );
};

export default GroupMembersDemo;

2. SearchRequestBuilder

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

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

const GroupMembersDemo = () => {
  const [chatGroup, setChatGroup] = React.useState<CometChat.Group>();

  React.useEffect(() => {
    CometChat.getGroup("guid").then((group) => {
      setChatGroup(group);
    });
  }, []);

  return (
    <>
      {chatGroup && (
        <CometChatGroupMembers
          group={chatGroup}
          searchRequestBuilder={new CometChat.GroupMembersRequestBuilder("guid")
            .setLimit(2)
            .setSearchKeyword("**")}
        />
      )}
    </>
  );
};

export default GroupMembersDemo;

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. Events emitted by the Group Members component is as follows.

Event	Description
ccGroupMemberBanned	Triggers when the group member banned from the group successfully
ccGroupMemberKicked	Triggers when the group member kicked from the group successfully
ccGroupMemberScopeChanged	Triggers when the group member scope is changed in the group

const ccGroupMemberBanned = CometChatGroupEvents.ccGroupMemberBanned.subscribe(
  (item: IGroupMemberKickedBanned) => {
    /** Your Code */
  }
);

const ccGroupMemberKicked = CometChatGroupEvents.ccGroupMemberKicked.subscribe(
  (item: IGroupMemberKickedBanned) => {
    /** Your Code */
  }
);

const ccGroupMemberScopeChanged =
  CometChatGroupEvents.ccGroupMemberScopeChanged.subscribe(
    (item: IGroupMemberScopeChanged) => {
      /** Your Code */
    }
  );

ccGroupMemberBanned?.unsubscribe();

ccGroupMemberKicked?.unsubscribe();

ccGroupMemberScopeChanged?.unsubscribe();

Customization

To fit your app’s design requirements, you can customize the appearance of the Group Members component.

Style

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

import { CometChat } from "@cometchat/chat-sdk-javascript";
import { CometChatGroupMembers } from "@cometchat/chat-uikit-react";
import React from "react";
import "./GroupMembersStyle.css";

const GroupMembersDemo = () => {
  const [chatGroup, setChatGroup] = React.useState<CometChat.Group>();

  React.useEffect(() => {
    CometChat.getGroup("guid").then((group) => {
      setChatGroup(group);
    });
  }, []);

  return <>{chatGroup && <CometChatGroupMembers group={chatGroup} />}</>;
};

export default GroupMembersDemo;

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 { CometChat } from "@cometchat/chat-sdk-javascript";
import { CometChatGroupMembers } from "@cometchat/chat-uikit-react";
import React from "react";

const GroupMembersDemo = () => {
  const [chatGroup, setChatGroup] = React.useState<CometChat.Group>();

  React.useEffect(() => {
    CometChat.getGroup("guid").then((group) => {
      setChatGroup(group);
    });
  }, []);

  return (
    <>
      {chatGroup && (
        <CometChatGroupMembers group={chatGroup} title="Your Custom Title" />
      )}
    </>
  );
};

export default GroupMembersDemo;

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 Kick Member Option	Hides the option to kick a member from the group.	`hideKickMemberOption={true}`
Hide Ban Member Option	Hides the option to ban a member from the group.	`hideBanMemberOption={true}`
Hide Scope Change Option	Hides the option to change the scope of a group member.	`hideScopeChangeOption={true}`
Hide User Status	Hides the user’s online/offline status indicator.	`hideUserStatus={true}`
Show Scrollbar	Controls the visibility of the scrollbar in the list.	`showScrollbar={true}`
Group	The group for which members are being fetched.	`group={chatGroup}`
Search Keyword	The keyword used to filter the group members list.	`searchKeyword="admin"`
Selection Mode	Selection mode to use for the default list item view.	`selectionMode={SelectionMode.multiple}`
Loading View	A custom view to display during the loading state.	`loadingView={<LoadingSpinner />}`
Error View	Custom view for the error state of the component.	`errorView={<ErrorComponent />}`
Empty View	A custom view to display when no group members are available in the list.

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

With this property, you can assign a custom ListItem to the Group Members Component. 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, GroupMember } from "@cometchat/chat-sdk-javascript";
import React from "react";
import {
  CometChatAvatar,
  CometChatGroupMembers,
  CometChatOption,
  CometChatUIKitLoginListener,
  GroupMemberUtils,
  localize,
} from "@cometchat/chat-uikit-react";
import "./GroupMembersStyle.css";

const GroupMembersDemo = () => {
  const [chatGroup, setChatGroup] = React.useState<CometChat.Group>();

  React.useEffect(() => {
    CometChat.getGroup("guid").then((group) => {
      setChatGroup(group);
    });
  }, []);

  const getCustomItemView = (groupMember: GroupMember) => {
    const loggedInUser = CometChatUIKitLoginListener.getLoggedInUser();
    let scope: string | CometChatOption[] =
      GroupMemberUtils.getViewMemberOptions(
        groupMember,
        chatGroup!,
        loggedInUser?.getUid()
      );
    if (typeof scope !== "string") {
      scope = groupMember.getScope();
    }

    return (
      <div className="group-member-list-item">
        <div className="group-member-list-item__avatar">
          <CometChatAvatar
            image={groupMember.getAvatar()}
            name={groupMember.getName()}
          />
          {groupMember.getStatus() === "online" && (
            <div className="group-member-list-item__avatar-status" />
          )}
        </div>
        <div className="group-member-list-item__content">
          <div className="group-member-list-item__content-name">
            {groupMember.getName()}
          </div>
          <div
            className={`group-member-list-item__content-tag group-member-list-item__content-tag-${localize(
              scope.toUpperCase()
            ).toLowerCase()}`}
          >
            {localize(scope.toUpperCase())}
          </div>
        </div>
      </div>
    );
  };

  return (
    <>
      {chatGroup && (
        <CometChatGroupMembers
          group={chatGroup}
          itemView={getCustomItemView}
        />
      )}
    </>
  );
};

export default GroupMembersDemo;

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 = (member: CometChat.GroupMember) => {
  return <div className={`group-members__title-view group-members__title-view-${member.getRole()}`}>
          <span className="group-members__title-view-name">{member.getName()}</span>
          <span className="group-members__title-view-type"><img src="ICON_HERE"></img>{member.getRole()}</span>
   </div>;
}

<CometChatGroupMembers group={group}  titleView={customTitleView} />;

SubtitleView

You can customize the subtitle view for each group members to meet your requirements. 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, GroupMember } from "@cometchat/chat-sdk-javascript";
import React from "react";
import { CometChatGroupMembers } from "@cometchat/chat-uikit-react";
import "./GroupMembersStyle.css";

const GroupMembersDemo = () => {
  const [chatGroup, setChatGroup] = React.useState<CometChat.Group>();

  React.useEffect(() => {
    CometChat.getGroup("guid").then((group) => {
      setChatGroup(group);
    });
  }, []);

  const getCustomSubtitleView = (groupMember: GroupMember) => {
    const formatTime = (timestamp: number) => {
      const date = new Date(timestamp * 1000);
      return date.toLocaleDateString();
    };
    return (
      <div className="group-member-subtitle">
        {"Joined at: " + formatTime(groupMember.getJoinedAt())}
      </div>
    );
  };

  return (
    <>
      {chatGroup && (
        <CometChatGroupMembers
          group={chatGroup}
          subtitleView={getCustomSubtitleView}
        />
      )}
    </>
  );
};

export default GroupMembersDemo;

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 { CometChatGroupMembers,CometChatAvatar } from "@cometchat/chat-uikit-react";

// Custom leading view component
const customLeadingView = (member: CometChat.GroupMember): JSX.Element => {
  // Determine the member's scope or owner status
  const scope = member.getUid() === group.getOwner() ? "owner" : member.getScope();

  return (
    <div className={`group-member__leading-view group-member__leading-view-${scope}`}>
      <CometChatAvatar 
        image={member?.getAvatar()} 
        name={member?.getName()} 
      />
      
      <span className="group-member__leading-view-scope"><img src="ICON_HERE"></img>{scope}</span>
    </div>
  );
};
<CometChatGroupMembers group={group}  leadingView={customLeadingView} />;

TrailingView

You can customize the trailing view for each group members to meet your requirements. 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, GroupMember } from "@cometchat/chat-sdk-javascript";
import React from "react";
import {
  CometChatGroupMembers,
  CometChatOption,
  CometChatUIKitLoginListener,
  GroupMemberUtils,
  localize,
} from "@cometchat/chat-uikit-react";
import "./GroupMembersStyle.css";

const GroupMembersDemo = () => {
  const [chatGroup, setChatGroup] = React.useState<CometChat.Group>();

  React.useEffect(() => {
    CometChat.getGroup("guid").then((group) => {
      setChatGroup(group);
    });
  }, []);

  const getCustomTrailingView = (groupMember: GroupMember) => {
    const loggedInUser = CometChatUIKitLoginListener.getLoggedInUser();
    let scope: string | CometChatOption[] =
      GroupMemberUtils.getViewMemberOptions(
        groupMember,
        chatGroup!,
        loggedInUser?.getUid()
      );
    if (typeof scope !== "string") {
      scope = groupMember.getScope();
    }
    return (
      <div className="group-member-scope-tag">
        {localize((scope as string).toUpperCase())}
      </div>
    );
  };

  return (
    <>
      {chatGroup && (
        <CometChatGroupMembers group={chatGroup} trailingView={getCustomTrailingView} />
      )}
    </>
  );
};

export default GroupMembersDemo;

HeaderView

You can set the Custom headerView to add more options to the Group Members component. 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 { CometChatGroupMembers,localize } from "@cometchat/chat-uikit-react";
import React from "react";

const getHeaderView = () => {
    return (
        <div className="cometchat-group-members__header">
            <div className="cometchat-group-members__header__title">
                {localize("GROUP_MEMBERS")}
            </div>
            <CometChatButton 
                onClick={() => {
                    // logic here
                }}
                iconURL={ICON_URL} 
            />
        </div>
    );
};

<CometChatGroupMembers group={chatGroup}  headerView={getHeaderView()} />

Options

You can set the Custom options to the Group Members component. 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 {
  CometChatGroupMembers,
  CometChatOption,
} from "@cometchat/chat-uikit-react";
import React from "react";
import "./GroupMembersStyle.css";

const GroupMembersDemo = () => {
  const [chatGroup, setChatGroup] = React.useState<CometChat.Group>();

  React.useEffect(() => {
    CometChat.getGroup("guid").then((group) => {
      setChatGroup(group);
    });
  }, []);

  return (
    <>
      {chatGroup && (
        <CometChatGroupMembers
          group={chatGroup}
          options={(
            group: CometChat.Group,
            groupMember: CometChat.GroupMember
          ) => {
            const customOptions = [
              new CometChatOption({
                id: "1",
                title: "Kick User",
                onClick: () => {
                  /** Your logic for handling click of custom option. */
                },
              }),
            ];
            return customOptions;
          }}
        />
      )}
    </>
  );
};

export default GroupMembersDemo;

​Overview

​Usage

​Integration

​Actions

1. onSelect

2. onItemClick

3. onEmpty

4. onError

​Filters

1. GroupMembersRequestBuilder

2. SearchRequestBuilder

​Events

​Customization

​Style

​Functionality

​Advanced

​ItemView

​TitleView

​SubtitleView

​LeadingView

​TrailingView

​HeaderView

​Options

Overview

Usage

Integration

Actions

Filters

Events

Customization

Style

Functionality

Advanced

ItemView

TitleView

SubtitleView

LeadingView

TrailingView

HeaderView

Options