Threaded Messages - CometChat Docs

Overview

ThreadedMessages is a Composite Component that displays all replies made to a particular message in a conversation. By default, the parent message will be displayed at the top, the message composer will be at the bottom and between them a message list will contain all replies.

ThreadedMessages is composed of the following components:

Component	Description
MessageList	CometChatMessageList is a component that displays a list of Messages
MessageComposer	CometChatMessageComposer is a component that helps in writing and editing of messages and also sending attachments

Usage

Integration

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

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

const bubbleView = () => {
  return <div>your custom bubble view</div>;
};

export function ThreadedMessagesDemo() {
  const [parentMessage, setParentMessage] = React.useState<CometChat.BaseMessage>();
  const [chatWithUser, setChatWithUser] = React.useState<CometChat.User>()

  React.useEffect(() => {
    CometChat.getUser("uid").then((user) => {
        setChatWithUser(user);
    })
    CometChat.getMessageDetails("parent Id").then((message)=>{
        setParentMessage(message)
    })
}, []);

  const threadedMessagesStyle = new ThreadedMessagesStyle({
    titleColor: "#6615e8",
    background: "#ebdeff",
    width: "100%",
    height: "600px",
    border: "2px solid #9e19e0"
  });

  const getTitle = () => {
    return `Thread ${chatWithUser?.getName()}`;
  };

  return chatWithUser && parentMessage ? (
    <CometChatThreadedMessages
      parentMessage={parentMessage}
      bubbleView={bubbleView}
      title={getTitle()}
      threadedMessagesStyle={threadedMessagesStyle}
    />
  ) : null;
}

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. Example In this example, we are overriding the onClose of the ThreadedMesssage Component.

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

const bubbleView = () => {
  return <div>your custom bubble view</div>;
};

export function ThreadedMessagesDemo() {
  const [parentMessage, setParentMessage] = React.useState<CometChat.BaseMessage>();
  const [chatWithUser, setChatWithUser] = React.useState<CometChat.User>()

  React.useEffect(() => {
    CometChat.getUser("uid").then((user) => {
        setChatWithUser(user);
    })
    CometChat.getMessageDetails("parent Id").then((message)=>{
        setParentMessage(message)
    })
}, []);

  const getonClose = () => {
    console.log("your custom on close action");
   }

  return chatWithUser && parentMessage ? (
    <CometChatThreadedMessages
      parentMessage={parentMessage}
      bubbleView={bubbleView}
      onClose:getonClose
    />
  ) : null;
}

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. ThreadedMessages does not have its own Filters. However, you can filter the messages list in ThreadedMessages Component using MessageListConfiguration. Example In this example, we are filtering messages based on the ParentMessageID and searching for messages that contain the keyword “hi”.

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

const bubbleView = () => {
  return <div>your custom bubble view</div>;
};

export function ThreadedMessagesDemo() {
  const [parentMessage, setParentMessage] = React.useState<CometChat.BaseMessage>();
  const [chatWithUser, setChatWithUser] = React.useState<CometChat.User>()

  React.useEffect(() => {
    CometChat.getUser("uid").then((user) => {
        setChatWithUser(user);
    })
    CometChat.getMessageDetails("parent Id").then((message)=>{
        setParentMessage(message)
    })
}, []);

  return chatWithUser && parentMessage ? (
    <CometChatThreadedMessages
      parentMessage={parentMessage}
      bubbleView={bubbleView}
      messageListConfiguration={new MessageListConfiguration({
        messagesRequestBuilder: new CometChat.MessagesRequestBuilder().setParentMessageId(546).setSearchKeyword("hi").setLimit(1)
      })}
    />
  ) : null;
}

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 ThreadedMessages Component does not emit any events of its own.

Customization

To fit your app’s design requirements, you can customize the appearance of the conversation 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.

1. threadedMessagesStyle

To modify the styling, you can apply the ThreadedMessageStyle to the ThreadedMessage Component using the threadedMessagesStyle property.

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

const bubbleView = () => {
  return <div>your custom bubble view</div>;
};

export function ThreadedMessagesDemo() {
  const [parentMessage, setParentMessage] = React.useState<CometChat.BaseMessage>();
  const [chatWithUser, setChatWithUser] = React.useState<CometChat.User>()

  React.useEffect(() => {
    CometChat.getUser("uid").then((user) => {
        setChatWithUser(user);
    })
    CometChat.getMessageDetails("parent Id").then((message)=>{
        setParentMessage(message)
    })
}, []);
  const threadedMessagesStyle = new ThreadedMessagesStyle({
    background: "#ebdeff",
    width: "100%",
    height: "600px",
    border: "2px solid #9e19e0"
  });

  return chatWithUser && parentMessage ? (
    <CometChatThreadedMessages
      parentMessage={parentMessage}
      bubbleView={bubbleView}
      threadedMessagesStyle={threadedMessagesStyle}
    />
  ) : null;
}

The following properties are exposed by ThreadedMessagesStyle:

Methods	Description	Type
border	Used to set border	`border?: string,`
borderRadius	Used to set border radius	`borderRadius?: string;`
background	Used to set background colour	`background?: string;`
height	Used to set height	`height?: string;`
width	Used to set width	`width?: string;`
titleFont	used to customise the font of the title in the app bar	`titleFont?: string;`
titleColor	used to customise the color of the title in the app bar	`titleColor?: string;`
closeIconTint	used to set the color of the close icon in the app bar	`closeIconTint?: string;`

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

const bubbleView = () => {
  return <div>your custom bubble view</div>;
};

export function ThreadedMessagesDemo() {
  const [parentMessage, setParentMessage] = React.useState<CometChat.BaseMessage>();
  const [chatWithUser, setChatWithUser] = React.useState<CometChat.User>()

  React.useEffect(() => {
    CometChat.getUser("uid").then((user) => {
        setChatWithUser(user);
    })
    CometChat.getMessageDetails("parent Id").then((message)=>{
        setParentMessage(message)
    })
  }, []);
  const getTitle = () => {
    return `Thread of ${chatWithUser?.getName()}`;
  };

  return chatWithUser && parentMessage ? (
    <CometChatThreadedMessages
      parentMessage={parentMessage}
      bubbleView={bubbleView}
      title={getTitle()}
      closeIconURL="your custom close icon url"
    />
  ) : null;
}

Below is a list of customizations along with corresponding code snippets

Property	Description	Code
parentMessage report	Used to to set the message for which the replies need to be fetched	`parentMessage={parentMessage}`
Hide MessageComposer	Used to toggle visibility for CometChatMessageComposer, default false	`hideMessageComposer={true}`
title	Used to set title in the app bar	`title={getTitle()}`
closeIconURL	Used to set the icon to exit the widget	`closeIconURL="your custom close icon url"`

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.

BubbleView

By using bubbleView, You can set parent message bubble view inside ThreadedMessage Component. Example Default

Custom

In this example, we will set parent message bubble view using bubbleView and apply custom styles on it.

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

const bubbleView = () => {
    const listItemStyle = new ListItemStyle({
        width: "150px",
        height: "100%",
        border: "2px solid #6615e8",
        borderRadius:"12px",
        titleColor:"#ffffff",
        background:"rgb(104, 81, 214)"
      });
    return(
        <cometchat-list-item title ={(parentMessage as CometChat.TextMessage).getText()} listItemStyle={JSON.stringify(listItemStyle)} />
    )
  };

export function ThreadedMessagesDemo() {
  const [parentMessage, setParentMessage] = React.useState<CometChat.BaseMessage>();
  const [chatWithUser, setChatWithUser] = React.useState<CometChat.User>()

  React.useEffect(() => {
    CometChat.getUser("uid").then((user) => {
        setChatWithUser(user);
    })
    CometChat.getMessageDetails("parent Id").then((message)=>{
        setParentMessage(message)
    })
  }, []);

  return chatWithUser && parentMessage ? (
    <CometChatThreadedMessages
      parentMessage={parentMessage}
      bubbleView={bubbleView}
    />
  ) : null;
}

MessageActionView

By utilizing the messageActionView method, you can assign custom actions to the parent message bubble view inside the ThreadedMessage Component. Example

In this example, we are setting mock Chat Bot button as message action view in ThreadedMessages Component.

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

 const messageActionView = () =>{
    return (
        <div style={{ height: '30px', width: '70px', background: '#a46efa', borderRadius: '20px', display: 'flex', justifyContent: 'center', alignItems: 'center'}}>
            <button style={{ height: '20px', width: '50px', background: '#a46efa', border: 'none', display: 'flex', justifyContent: 'center', alignItems: 'center', cursor:"pointer",color:'#ffffff'  }}>
                chatbot
                <img src="custom image" style={{ height: 'auto', width: '100%', maxWidth: '100%', maxHeight: '100%', borderRadius: '50%'}} alt="bot" />
            </button>
        </div>
    )
  }

  const bubbleView = () => {
    const listItemStyle = new ListItemStyle({
        width: "150px",
        height: "100%",
        border: "2px solid #6615e8",
        borderRadius:"12px",
        titleColor:"#ffffff",
        background:"rgb(104, 81, 214)"
      });
    return(
        <cometchat-list-item title ={(parentMessage as CometChat.TextMessage).getText()} listItemStyle={JSON.stringify(listItemStyle)} />
    )
  };

export function ThreadedMessagesDemo() {
  const [parentMessage, setParentMessage] = React.useState<CometChat.BaseMessage>();
  const [chatWithUser, setChatWithUser] = React.useState<CometChat.User>()

  React.useEffect(() => {
    CometChat.getUser("uid").then((user) => {
        setChatWithUser(user);
    })
    CometChat.getMessageDetails("parent Id").then((message)=>{
        setParentMessage(message)
    })
  }, []);

  return chatWithUser && parentMessage ? (
    <CometChatThreadedMessages
      parentMessage={parentMessage}
      bubbleView={bubbleView}
      messageActionView={messageActionView()}
    />
  ) : null;
}

MessageListView

You can set your custom message list view using the messageListView property. But keep in mind, by using this you will override the default message ListView functionality.

messageListView = { CustomListItem };

Example Default

Custom

ThreadedMessagesDemo.tsx

import React from "react";
import { CometChat } from "@cometchat/chat-sdk-javascript";
import {
  CometChatMessageList,
  CometChatThreadedMessages,
  MessageListAlignment,
  MessageListStyle,
} from "@cometchat/chat-uikit-react";

function ThreadedMessagesDemo() {
  const [parentMessage, setParentMessage] =
    React.useState<CometChat.BaseMessage>();
  const [chatWithUser, setChatWithUser] = React.useState<CometChat.User>();

  React.useEffect(() => {
    CometChat.getUser("uid").then((user) => {
      setChatWithUser(user);
    });
    CometChat.getMessageDetails("parent Id").then((message) => {
      setParentMessage(message);
    });
  }, []);

  const messageListStyle = new MessageListStyle({
    background: "#fdf2ff",
    border: "1px solid #d608ff",
    borderRadius: "20px",
    loadingIconTint: "red",
    nameTextColor: "pink",
    threadReplyTextColor: "green",
  });
  const CustomListItem = React.useMemo(
    (
      user?: CometChat.User,
      group?: CometChat.Group,
      parentMessage?: CometChat.BaseMessage
    ) => (
      <div style={{ height: "500px" }}>
        <CometChatMessageList
          user={chatUser!}
          messageListStyle={messageListStyle}
          alignment={MessageListAlignment.left}
        />
      </div>
    ),
    []
  );

  return (
    <>
      <CometChatThreadedMessages
        parentMessage={parentMessage}
        messageListView={CustomListItem}
      />
    </>
  );
}

export default ThreadedMessagesDemo;

MessageComposerView

You can set your custom Message Composer view using the messageComposerView property. But keep in mind, by using this you will override the default message composer functionality. Example

messageComposerView={CustomComposerView}

Default

Custom

ThreadedMessagesDemo.tsx

import React from "react";
import { CometChat } from "@cometchat/chat-sdk-javascript";
import {
  CometChatMessageComposer,
  CometChatThreadedMessages,
  AuxiliaryButtonAlignment,
  MessageComposerStyle,
} from "@cometchat/chat-uikit-react";

function ThreadedMessagesDemo() {
  const [parentMessage, setParentMessage] =
    React.useState<CometChat.BaseMessage>();
  const [chatWithUser, setChatWithUser] = React.useState<CometChat.User>();

  React.useEffect(() => {
    CometChat.getUser("uid").then((user) => {
      setChatWithUser(user);
    });
    CometChat.getMessageDetails("parent Id").then((message) => {
      setParentMessage(message);
    });
  }, []);

  const messageComposerStyle = new MessageComposerStyle({
    AIIconTint: "#ec03fc",
    attachIcontint: "#ec03fc",
    background: "#fffcff",
    border: "2px solid #b30fff",
    borderRadius: "20px",
    inputBackground: "#e2d5e8",
    textColor: "#ff299b",
    sendIconTint: "#ff0088",
  });
  const CustomComposerView = React.useMemo(
    (
      user?: CometChat.User,
      group?: CometChat.Group,
      parentMessage?: CometChat.BaseMessage
    ) => (
      <div>
        <CometChatMessageComposer
          messageComposerStyle={messageComposerStyle}
          auxiliaryButtonAlignment={AuxiliaryButtonAlignment.left}
          text="Enter your text here"
        />
      </div>
    ),
    []
  );

  return (
    <>
      <CometChatThreadedMessages
        parentMessage={parentMessage}
        messageComposerView={CustomComposerView}
      />
    </>
  );
}

export default ThreadedMessagesDemo;

Configuration

Configurations offer the ability to customize the properties of each individual component within a Composite Component. The ThreadedMessages is a Composite Component, and it has a distinct set of configurations for each of its components as follows.

MessageList

If you want to customize the properties of the MessageList Component inside ThreadedMessages Component, you need use the MessageListConfiguration object.

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

export function ThreadedMessagesDemo() {
  const [parentMessage, setParentMessage] = React.useState<CometChat.BaseMessage>();
  const [chatWithUser, setChatWithUser] = React.useState<CometChat.User>()

  React.useEffect(() => {
    CometChat.getUser("uid").then((user) => {
        setChatWithUser(user);
    })
    CometChat.getMessageDetails("parent Id").then((message)=>{
        setParentMessage(message)
    })
  }, []);

  return chatWithUser && parentMessage ? (
    <CometChatThreadedMessages
      parentMessage={parentMessage}
      messageListConfiguration={new MessageListConfiguration({
        //properties of message list
      })}
    />
  ) : null;
}

The MessageListConfiguration provides access to all the Action, Filters, Styles, Functionality, and Advanced properties of the MessageList component.

Please note that the properties marked with the report symbol are not accessible within the Configuration Object.

Example

In this example, we will be changing the list alignment and modifying the message list styles in the MessageList component using MessageListConfiguration.

import React from "react";
import { CometChatThreadedMessages, MessageListConfiguration, MessageListStyle, MessageListAlignment } from "@cometchat/chat-uikit-react";
import {CometChat} from "@cometchat/chat-sdk-javascript";

export function ThreadedMessagesDemo() {
  const [parentMessage, setParentMessage] = React.useState<CometChat.BaseMessage>();
  const [chatWithUser, setChatWithUser] = React.useState<CometChat.User>()

  React.useEffect(() => {
    CometChat.getUser("uid").then((user) => {
        setChatWithUser(user);
    })
    CometChat.getMessageDetails("parent Id").then((message)=>{
        setParentMessage(message)
    })
  }, []);
  const messageListStyle = new MessageListStyle({
    background:"transparent",
    border:"1px solid black",
    borderRadius:"20px",
    height:"100%",
    width:"100%",
    loadingIconTint:"red",
    nameTextColor:"pink",
    threadReplyTextColor:"green",
})
  return chatWithUser && parentMessage ? (
    <CometChatThreadedMessages
      parentMessage={parentMessage}
      messageListConfiguration={new MessageListConfiguration({
        alignment: MessageListAlignment.left,
        messageListStyle:messageListStyle
      })}
    />
  ) : null;
}

MessageComposer

If you want to customize the properties of the MessageComposer Component inside ThreadedMessages Component, you need use the MessageComposerConfiguration object.

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

export function ThreadedMessagesDemo() {
  const [parentMessage, setParentMessage] = React.useState<CometChat.BaseMessage>();
  const [chatWithUser, setChatWithUser] = React.useState<CometChat.User>()

  React.useEffect(() => {
    CometChat.getUser("uid").then((user) => {
        setChatWithUser(user);
    })
    CometChat.getMessageDetails("parent Id").then((message)=>{
        setParentMessage(message)
    })
  }, []);

  return chatWithUser && parentMessage ? (
    <CometChatThreadedMessages
      parentMessage={parentMessage}
      messageComposerConfiguration={new MessageComposerConfiguration({
        //properties of message composer
      })}
    />
  ) : null;
}

The MessageComposerConfiguration provides access to all the Action, Filters, Styles, Functionality, and Advanced properties of the MessageComposer component.

Please note that the properties marked with the report symbol are not accessible within the Configuration Object.

Example

In this example, we’ll be adding a custom header view and customizing some properties of the MessageComposer component using MessageComposerConfiguration.

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

export function ThreadedMessagesDemo() {
  const [parentMessage, setParentMessage] = React.useState<CometChat.BaseMessage>();
  const [chatWithUser, setChatWithUser] = React.useState<CometChat.User>()

  React.useEffect(() => {
    CometChat.getUser("uid").then((user) => {
        setChatWithUser(user);
    })
    CometChat.getMessageDetails("parent Id").then((message)=>{
        setParentMessage(message)
    })
  }, []);
  const messageComposerStyle = new MessageComposerStyle({
  AIIconTint: "#ff006f",
  attachIcontint:"#ec03fc",
  background:"#fffcff",
  border:"2px solid #b30fff",
  borderRadius:"20px",
  inputBackground:"#e2d5e8",
  textColor:"#ff299b",
  sendIconTint:"#ff0088",
  })
  const getHeaderView = () => {
    return (
        <div style={{ height: '40px', width: '100px', background: '#a46efa', borderRadius: '20px', display: 'flex', justifyContent: 'center', alignItems: 'center',  margin:'10px'}}>
            <button style={{ height: '40px', width: '40px', background: '#a46efa', border: 'none', display: 'flex', justifyContent: 'center', alignItems: 'center', cursor:"pointer"  }}>
                <img src="custom image" style={{ height: 'auto', width: '100%', maxWidth: '100%', maxHeight: '100%', borderRadius: '50%'}} alt="bot" />
                <span>Chat Bot</span>
            </button>
        </div>
    )
  }

  return chatWithUser && parentMessage ? (
    <CometChatThreadedMessages
      parentMessage={parentMessage}
      messageComposerConfiguration={new MessageComposerConfiguration({
        headerView:getHeaderView()
        messageComposerStyle:messageComposerStyle
      })}
    />
  ) : null;
}

​Overview

​Usage

​Integration

​Actions

​Filters

​Events

​Customization

​Style

1. threadedMessagesStyle

​Functionality

​Advanced

​BubbleView

​MessageActionView

​MessageListView

​MessageComposerView

​Configuration

​MessageList

​MessageComposer

Overview

Usage

Integration

Actions

Filters

Events

Customization

Style

Functionality

Advanced

BubbleView

MessageActionView

MessageListView

MessageComposerView

Configuration

MessageList

MessageComposer