Thread Header

Overview

CometChatThreadHeader is a Component that displays the parent message & number of replies of thread.

Usage

Integration

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

ThreadHeaderDemo.tsx

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

export function ThreadHeaderDemo() {
  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 Message Id").then((message) => {
      setParentMessage(message);
    });
  }, []);

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

App.tsx

import { ThreadHeaderDemo } from "./ThreadHeaderDemo";

export default function App() {
  return (
    <div className="App">
      <div>
        <ThreadHeaderDemo />
      </div>
    </div>
  );
}

---

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.

ThreadHeaderDemo.tsx

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

export function ThreadHeaderDemo() {
  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 Message Id").then((message) => {
      setParentMessage(message);
    });
  }, []);

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

  return chatWithUser && parentMessage ? (
    <CometChatThreadHeader
      parentMessage={parentMessage}
      onClose={handleClose}
    />
  ) : 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 ThreadHeader 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.

Example

ThreadHeaderDemo.tsx

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

export function ThreadHeaderDemo() {
  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 Message Id").then((message) => {
      setParentMessage(message);
    });
  }, []);

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

ThreadHeaderDemo.css

.cometchat .cometchat-thread-header {
  background-color: #edeafa;
}

.cometchat .cometchat-thread-header__reply-bar-count {
  color: #6852d6;
}

.cometchat .cometchat-thread-header__reply-bar-divider {
  color: #6852d6;
}

---

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.

ThreadHeaderDemo.tsx

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

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

export function ThreadHeaderDemo() {
  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 Message Id").then((message) => {
      setParentMessage(message);
    });
  }, []);

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

Below is a list of customizations along with corresponding code snippets

Property	Description	Code
Parent Message	Represents the parent message for displaying threaded conversations.	parentMessage={message}
Message Bubble View	A custom view for rendering the message bubble.	messageBubbleView={(message: CometChat.BaseMessage) => <>Custom Bubble View</>}
Template	Template for customizing the appearance of the message.	template={"PASS_CUSTOM_MESSAGE_TEMPLATE"}
Hide Date	Hides the visibility of the date header.	hideDate={true}
Hide Reply Count	Hides the visibility of the reply count.	hideReplyCount={true}
Show Scrollbar	Controls the visibility of the scrollbar in the component.	showScrollbar={true}
On Error	Callback function triggered when an error occurs.	onError={(error: CometChat.CometChatException) => console.log(error)}

Advanced

---

Separator DateTime Format

The separatorDateTimeFormat property allows you to customize the Date Separator timestamp displayed in the Threaded Message Preview.

Default Date Time Format:

new CalendarObject({
    today: `DD MMM, YYYY`,   // Example: "25 Jan, 2025"
    yesterday: `DD MMM, YYYY`, // Example: "25 Jan, 2025"
    otherDays: `DD MMM, YYYY`,  // Example: "25 Jan, 2025"
});

The following example demonstrates how to modify the Date Separator timestamp format using a custom CalendarObject.

TypeScript

import {
  CometChatThreadHeader,
  CalendarObject
} from "@cometchat/chat-uikit-react";

// Define a custom date format pattern
function getDateFormat() {
  const dateFormat = new CalendarObject({
    today: `hh:mm A`, // Example: "10:30 AM"
    yesterday: `[yesterday]`, // Example: "yesterday"
    otherDays: `DD/MM/YYYY`, // Example: "25/05/2025"
  });
  return dateFormat;
}

// Apply the custom format to the CometChatThreadHeader component
<CometChatThreadHeader separatorDateTimeFormat={getDateFormat()} />;

info

Fallback Mechanism

• If you do not pass any property in the CalendarObject, the component will first check the global configuration. If the property is also missing in the global configuration, it will fallback to the component's default formatting.

---

Message SentAt DateTime Format

The messageSentAtDateTimeFormat property allows you to customize the Message SentAt timestamp displayed in the Threaded Message Preview.

Default Date Time Format:

new CalendarObject({
    today: "hh:mm A" // Example: "12:00 PM"
    yesterday: "hh:mm A", // Example: "01:00 AM"
    otherDays: `hh:mm A`, // Example: "09:30 PM"
});

The following example demonstrates how to modify the Message SentAt timestamp format using a custom CalendarObject.

TypeScript

import {
  CometChatThreadHeader,
  CalendarObject
} from "@cometchat/chat-uikit-react";

// Define a custom date format pattern
function getDateFormat() {
  const dateFormat = new CalendarObject({
    today: `hh:mm A`, // Example: "10:30 AM"
    yesterday: `[yesterday]`, // Example: "yesterday"
    otherDays: `DD/MM/YYYY`, // Example: "25/05/2025"
  });
  return dateFormat;
}

// Apply the custom format to the CometChatThreadHeader component
<CometChatThreadHeader  messageSentAtDateTimeFormat={getDateFormat()} />;

info

Fallback Mechanism

• If you do not pass any property in the CalendarObject, the component will first check the global configuration. If the property is also missing in the global configuration, it will fallback to the component's default formatting.

---