Version: v4

Groups with Messages

Overview

The GroupsWithMessages is a Composite Component encompassing components such as Groups and Messages. Both of these component contributes to the functionality and structure of the overall GroupsWithMessages component.

The GroupsWithMessages component is composed of the following BaseComponents:

Components	Description
Groups	The `Groups` component is designed to display a list of `Groups`. This essentially represents the recent conversation history.
Messages	The `Messages` component is designed to manage the messaging interaction for either individual `User` or `Group` conversations.

Usage

Integration

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

App.tsx

import { CometChat } from "@cometchat/chat-sdk-react-native";
import { CometChatGroupsWithMessages } from "@cometchat/chat-uikit-react-native";

function App(): React.JSX.Element {
  return <CometChatGroupsWithMessages />;
}

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

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

App.tsx

import { CometChat } from "@cometchat/chat-sdk-react-native";
import { CometChatGroupsWithMessages } from "@cometchat/chat-uikit-react-native";

function App(): React.JSX.Element {
  const onErrorHandler = (error: CometChat.CometChatException) => {
    //code
  };

  return <CometChatGroupsWithMessages onError={onErrorHandler} />;
}

The child components - Groups and Messages - both have their own set of actions. The Actions of these components can be overridden through the use of the Configurations object. Here is an example code snippet.

App.tsx

import { CometChat } from "@cometchat/chat-sdk-react-native";
import {
  CometChatGroupsWithMessages,
  GroupsConfigurationInterface,
  MessagesConfigurationInterface,
} from "@cometchat/chat-uikit-react-native";

function App(): React.JSX.Element {
  const groupsRequestBuilder = new CometChat.GroupsRequestBuilder()
    .setLimit(3)
    .joinedOnly(true);
  const groupsConfiguration: GroupsConfigurationInterface = {
    onItemLongPress(item) {
      //code
    },
    groupsRequestBuilder: groupsRequestBuilder,
    onItemPress(item) {
      //code
    },
  };

  const messagesConfiguration: MessagesConfigurationInterface = {
    hideMessageHeader: true,
    hideMessageComposer: true,
  };

  return (
    <CometChatGroupsWithMessages
      groupsConfiguration={groupsConfiguration}
      messagesConfigurations={messagesConfiguration}
    />
  );
}

The GroupsWithMessages component overrides several actions from its components to reach its default behavior. The list of actions overridden by GroupsWithMessages includes:

onItemPress : By overriding the OnItemClick of the Groups Component, GroupsWithMessages achieves navigation from Groups to Messages component.

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

While the GroupsWithMessages component does not have filters, its components do, For more detail on individual filters of its component refer to Groups Filters and Messages Filters.

By utilizing the Configurations object of its components, you can apply filters.

In the following example, we are applying a filter to the Group List based on only joined groups and setting the limit to 3 using the groupsRequestBuilder.

App.tsx

import { CometChat } from "@cometchat/chat-sdk-react-native";
import {
  CometChatGroupsWithMessages,
  GroupsConfigurationInterface,
} from "@cometchat/chat-uikit-react-native";

function App(): React.JSX.Element {
  const groupsRequestBuilder = new CometChat.GroupsRequestBuilder()
    .setLimit(3)
    .joinedOnly(true);

  const groupsConfiguration: GroupsConfigurationInterface = {
    groupsRequestBuilder: groupsRequestBuilder,
  };

  return (
    <CometChatGroupsWithMessages groupsConfiguration={groupsConfiguration} />
  );
}

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.

The GroupsWithMessages does not produce any events but its component does.

Customization

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

Style

Using Style you can customize the look and feel of the component in your app, These parameters typically control elements such as the color, size, shape, and fonts used within the component.

GroupsWithMessages does not have a style property but you can customize its sub-component styles. For more details on individual component styles, you can refer Groups Styles and Messages Styles.

Styles can be applied to SubComponents using their respective configurations.

App.tsx

import { CometChat } from "@cometchat/chat-sdk-react-native";
import {
  CometChatGroupsWithMessages,
  GroupsConfigurationInterface,
  MessagesConfigurationInterface,
  GroupsStyleInterface,
  MessageStyleInterface,
} from "@cometchat/chat-uikit-react-native";

function App(): React.JSX.Element {
  const groupsStyle: GroupsStyleInterface = {
    titleColor: "red",
    backgroundColor: "#d2cafa",
  };

  const groupsConfiguration: GroupsConfigurationInterface = {
    groupsStyle: groupsStyle,
  };

  const messageStyle: MessageStyleInterface = {
    backgroundColor: "#6851D6",
  };

  const messagesConfiguration: MessagesConfigurationInterface = {
    messagesStyle: messageStyle,
  };

  return (
    <CometChatGroupsWithMessages
      groupsConfiguration={groupsConfiguration}
      messagesConfiguration={messagesConfiguration}
    />
  );
}

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.

you can utilize the group method with a Group object as input to the GroupsWithMessages component. This will automatically direct you to the Messages component for the specified Group.

1. Group

App.tsx

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

function App(): React.JSX.Element {
  const [group, setGroup] = useState<CometChat.Group | undefined>(undefined);

  const getGroup = async () => {
    const group = await CometChat.getGroup("guid");
    setGroup(group);
  };

  useEffect(() => {
    //login
    getGroup();
  });

  return (
    <>
      {group && (
        <CometChatGroupsWithMessages
          group={group}
        ></CometChatGroupsWithMessages>
      )}
    </>
  );
}

Components

Nearly all functionality customizations available for a Component are also available for the composite component. Using Configuration, you can modify the properties of its components to suit your needs.

You can find the list of all Functionality customization of individual components in Groups and Messages.

Example

App.tsx

import { CometChat } from "@cometchat/chat-sdk-react-native";
import {
  CometChatGroupsWithMessages,
  GroupsConfigurationInterface,
  MessagesConfigurationInterface,
} from "@cometchat/chat-uikit-react-native";

function App(): React.JSX.Element {
  const groupsRequestBuilder = new CometChat.GroupsRequestBuilder()
    .setLimit(10)
    .joinedOnly(true);

  const groupsConfiguration: GroupsConfigurationInterface = {
    groupsRequestBuilder: groupsRequestBuilder,
  };

  const messagesConfiguration: MessagesConfigurationInterface = {
    hideMessageHeader: true,
    hideMessageComposer: true,
  };

  return (
    <CometChatGroupsWithMessages
      groupsConfiguration={groupsConfiguration}
      messagesConfigurations={messagesConfiguration}
    />
  );
}

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 own views, layouts, and UI elements and then incorporate those into the component.

By utilizing the Configuration object of each component, you can apply advanced-level customizations to the GroupsWithMessages.

Example

App.tsx

import { CometChat } from "@cometchat/chat-sdk-react-native";
import {
  CometChatGroupsWithMessages,
  GroupsConfigurationInterface,
  MessagesConfigurationInterface,
} from "@cometchat/chat-uikit-react-native";

function App(): React.JSX.Element {
  const errorViewStyle: StyleProp<ViewStyle> = {
    flex: 1,
    alignItems: "center",
    justifyContent: "center",
    padding: 10,
    borderColor: "black",
    borderWidth: 1,
    backgroundColor: "#E8EAE9",
  };

  const getErrorStateView = () => {
    return (
      <View style={errorViewStyle}>
        <Text>Error</Text>
      </View>
    );
  };

  const groupsConfiguration: GroupsConfigurationInterface = {
    ErrorStateView: getErrorStateView,
  };

  return (
    <CometChatGroupsWithMessages groupsConfiguration={groupsConfiguration} />
  );
}

To find all the details on individual Component advance customization you can refer, Groups Advance and Messages Advance.

GroupsWithMessages uses advanced-level customization of both Groups & Messages components to achieve its default behavior.

GroupsWithMessages utilizes the onItemPress property of the Groups subcomponent to navigate the group from Groups to Messages

GroupsWithMessages utilizes the AppBarOptions of the Messages subcomponent to navigate from Messages to Details

warning

When you override onItemPress and AppBarOptions, the default behavior of GroupsWithMessages will also be overridden.

Configurations

Configurations offer the ability to customize the properties of each component within a Composite Component.

GroupsWithMessages has Groups and Messages component. Hence, each of these components will have its individual `Configuration``.

Configurations expose properties that are available in its individual components.

Groups

You can customize the properties of the Groups component by making use of the groupsConfiguration. You can accomplish this by employing the groupsConfiguration props as demonstrated below:

App.tsx

import { CometChat } from "@cometchat/chat-sdk-react-native";
import {
  CometChatGroupsWithMessages,
  GroupsConfigurationInterface,
} from "@cometchat/chat-uikit-react-native";

function App(): React.JSX.Element {
  const groupsConfiguration: GroupsConfigurationInterface = {
    //override properties
  };

  return (
    <CometChatGroupsWithMessages groupsConfiguration={groupsConfiguration} />
  );
}

All exposed properties of GroupsConfiguration can be found under Groups. Properties marked with the report symbol are not accessible within the Configuration Object.

Example

Let's say you want to change the style of the Groups subcomponent and, in addition, you only want to display the Group List based on only joined groups and setting the limit to 3.

You can modify the style using the groupsStyle property and filter the list with the groupsRequestBuilder property.

App.tsx

import { CometChat } from "@cometchat/chat-sdk-react-native";
import {
  CometChatGroupsWithMessages,
  GroupsConfigurationInterface,
  GroupsStyleInterface,
} from "@cometchat/chat-uikit-react-native";

function App(): React.JSX.Element {
  const groupsStyle: GroupsStyleInterface = {
    titleColor: "red",
    backgroundColor: "#d2cafa",
  };

  const groupsRequestBuilder = new CometChat.GroupsRequestBuilder()
    .setLimit(3)
    .joinedOnly(true);

  const groupsConfiguration: GroupsConfigurationInterface = {
    groupsRequestBuilder: groupsRequestBuilder,
    groupsStyle: groupsStyle,
  };

  return (
    <CometChatGroupsWithMessages groupsConfiguration={groupsConfiguration} />
  );
}

Messages

You can customize the properties of the Messages component by making use of the messagesConfiguration. You can accomplish this by employing the messagesConfiguration props as demonstrated below:

App.tsx

import { CometChat } from "@cometchat/chat-sdk-react-native";
import {
  CometChatGroupsWithMessages,
  MessagesConfigurationInterface,
} from "@cometchat/chat-uikit-react-native";

function App(): React.JSX.Element {
  const messagesConfiguration: MessagesConfigurationInterface = {
    //override properties
  };

  return (
    <CometChatGroupsWithMessages
      messagesConfigurations={messagesConfiguration}
    />
  );
}

All exposed properties of MessagesConfiguration can be found under Messages. Properties marked with the report symbol are not accessible within the Configuration Object.

Example

Let's say you want to change the style of the Messages subcomponent and, in addition, you only want to hide message header.

You can modify the style using the messagesStyle property and hide the message header with the hideMessageHeader property.

App.tsx

import { CometChat } from "@cometchat/chat-sdk-react-native";
import {
  CometChatGroupsWithMessages,
  MessageStyleInterface,
  MessagesConfigurationInterface,
} from "@cometchat/chat-uikit-react-native";

function App(): React.JSX.Element {
  const messageStyle: MessageStyleInterface = {
    //override style
  };

  const messagesConfiguration: MessagesConfigurationInterface = {
    hideMessageHeader: true,
    messagesStyle: messageStyle,
  };

  return (
    <CometChatGroupsWithMessages
      messagesConfigurations={messagesConfiguration}
    />
  );
}

Create Group

You can customize the properties of the Create Group component by making use of the CreateGroupConfiguration. You can accomplish this by employing the createGroupConfiguration props as demonstrated below:

App.tsx

import { CometChat } from "@cometchat/chat-sdk-react-native";
import {
  CometChatGroupsWithMessages,
  CreateGroupConfigurationInterface,
} from "@cometchat/chat-uikit-react-native";

function App(): React.JSX.Element {
  const createGroupConfiguration: CreateGroupConfigurationInterface = {
    //override properites
  };

  return (
    <CometChatGroupsWithMessages
      createGroupConfiguration={createGroupConfiguration}
    />
  );
}

All exposed properties of CreateGroupConfiguration can be found under Create Group. Properties marked with the report symbol are not accessible within the Configuration Object.

Example

Let's say you want to change the style of the Create Group subcomponent.

You can modify the style using the createGroupStyle property.

App.tsx

import { CometChat } from "@cometchat/chat-sdk-react-native";
import {
  CometChatGroupsWithMessages,
  CreateGroupStyleInterface,
  CreateGroupConfigurationInterface,
} from "@cometchat/chat-uikit-react-native";

function App(): React.JSX.Element {
  const createGroupStyle: CreateGroupStyleInterface = {
    background: "#6851D6",
  };

  const createGroupConfiguration: CreateGroupConfigurationInterface = {
    createGroupStyle: createGroupStyle,
    onBack: () => {
      //code
    },
  };

  return (
    <CometChatGroupsWithMessages
      createGroupConfiguration={createGroupConfiguration}
    />
  );
}

UI Kits

SDKs

Widgets

APIs

Overview​

Usage​

Integration​

Actions​

1. onError​

Filters​

Events​

Customization​

Style​

Functionality​

1. Group​

Components​

Advanced​

Configurations​

Groups​

Messages​

Create Group​

Overview

Usage

Integration

Actions

1. onError

Filters

Events

Customization

Style

Functionality

1. Group

Components

Advanced

Configurations

Groups

Messages

Create Group