Message Template - CometChat Docs

Overview

MessageTemplate provides you with the capability to define and customize both the structure and the behavior of the Message Bubble. It acts as a schema or design blueprint for the creation of a variety of Message Bubble components, allowing you to manage the appearance and interactions of Message Bubble within your application effectively and consistently.

Structure

The Message Bubble structure can typically be broken down into the following views:

Leading view: This is where the sender’s avatar is displayed. It’s typically on the left of the Message Bubble for messages from others and on the right for messages from the current user.
Header view: This displays the sender’s name and is especially useful in group chats where multiple users are sending messages.
Reply view: This view can be used to extend the Message Bubble with additional elements. It’s typically placed above the Content view.
Content view: This is the core of the Message Bubble where the message content (text, images, videos, etc.) is displayed.
Bottom view: This view can be used to extend the Message Bubble with additional elements, such as link previews or a ‘load more’ button for long messages. It’s typically placed beneath the Content view.
Thread view: This is where the thread reply icon and reply counts are displayed. It’s located below the footer view.
Footer view: This is where the reactions are displayed. It’s located at the bottom of the Message Bubble.
Status Info view: This is where the timestamp of the message and its delivery or read status are displayed. It’s located inside the Message Bubble just below the content view.

Properties

MessageTemplate provides you with methods that allow you to alter various properties of the Message Bubble. These properties include aspects such as the type and category of a message, the appearance and behavior of the header, content, and footer sections of the message bubble,

type Using type you can set the type of CometChatMessage, This will map your MessageTemplate to the corresponding CometChatMessage. You can set the MessageTemplates Type using the following code snippet.
category Using category you can set the category of a MessageTemplate. This will create a MessageTemplate with the specified category and link it with a CometChatMessage of the same category. Please refer to our guide on Message Categories for a deeper understanding of message categories.
headerView The headerView method allows you to assign a custom header view to the Message Bubble. By default, it is configured to display the sender’s name.
contentView The contentView method allows you to assign a custom content view to the Message Bubble. By default, it displays the Text Bubble, Image Bubble, File Bubble, Audio Bubble, or Video Bubble depending on the message type.
footerView The footerView method allows you to assign a custom Footer view to the Message Bubble. By default it shows thr reactions for the message bubble.
bottomView The bottomView method allows you to assign a custom Bottom view to the Message Bubble. By defuault is has buttons such as link previews or a ‘load more’ button for long messages.
bubbleView The bubbleView method allows you to assign a custom Bubble view to the Message Bubble. By default, headerView, contentView, statusInfoView and footerView together form a message bubble.
statusInfoView The statusInfoView method allows you to assign a custom status info view to the Message Bubble. By default, it displays the receipt and timestamp.
options The options lets you set the list of actions that a user can perform on a message. This includes actions like reacting to, editing, or deleting a message.

Customization

Let’s dive into how you can use the properties of MessageTemplate to customize an existing template or add a new one to the MessageList component. The first step is to fetch the list of existing templates when you want to modify or add to them. This can be done using the getAllMessageTemplates() method from the DataSource of the CometChatUIKit class.

let definedTemplates = CometChatUIKit.getDataSource().getAllMessageTemplates();

Existing Templates

You will need to first get the MessageTemplate object for the type of message you want to customize. You will be customizing the text message bubble here. The code snippet to get the Text MessageTemplate is as follows.

import {
  CometChatUIKit,
  CometChatUIKitConstants,
} from "@cometchat/chat-uikit-react";

let allTemplates: CometChatMessageTemplate[] =
  CometChatUIKit.getDataSource().getAllMessageTemplates();
for (let i = 0; i < allTemplates.length; i++) {
  if (allTemplates[i].type === CometChatUIKitConstants.MessageTypes.text) {
    //customize allTemplates[i]
  }
}

You will be using Message List component using the templates prop of CometChatMessageList component.

import { CometChatMessageList } from "@cometchat/uikit-react";

<CometChatMessageList user={chatUser} templates={templates} />;

HeaderView

The headerView method of MessageTemplate allows you to add custom views to the header of your message bubbles. In the example below, we will add a custom header view of every text message in the MessageList.

import React, { useEffect, useState } from "react";
import {
  CometChatMessageList,
  CometChatUIKit,
  CometChatUIKitConstants,
} from "@cometchat/chat-uikit-react";
import { CometChat } from "@cometchat/chat-sdk-javascript";

const CustomMessageTemplate = () => {
  const [templates, setTemplates] = React.useState<CometChatMessageTemplate[]>(
    []
  );
  const [chatGroup, setChatGroup] = React.useState<CometChat.Group>();

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

    let definedTemplates: CometChatMessageTemplate[] =
      CometChatUIKit.getDataSource().getAllMessageTemplates();
    const template = definedTemplates.map((templates) => {
      if (
        templates.type === CometChatUIKitConstants.MessageTypes.text &&
        templates.category === CometChatUIKitConstants.MessageCategory.message
      ) {
        templates.headerView = (message: CometChat.BaseMessage) =>
          getHeaderView(message);
        return templates;
      }
      return templates;
    });
    setTemplates(template);
  }, []);

  const getHeaderView = (message: CometChat.BaseMessage) => {
    return <> {message.getSender().getName()} • 🗓️ In meeting</>;
  };

  return (
    <div>
      {chatGroup && (
        <CometChatMessageList group={chatGroup} templates={templates} />
      )}
    </div>
  );
};

export { CustomMessageTemplate };

Contentview

The contentview method of MessageTemplate allows you to add a custom view to the content of your message bubbles. In the example below, we will add a custom layout to the content view of every text message in the MessageList.

import React from "react";
import {
  CometChatMessageList,
  CometChatUIKit,
  CometChatUIKitConstants,
  CometChatMessageTemplate,
} from "@cometchat/chat-uikit-react";
import { CometChat } from "@cometchat/chat-sdk-javascript";
import bannerImage from "../../assets/banner.svg";

const CustomMessageTemplate = () => {
  const [templates, setTemplates] = React.useState<CometChatMessageTemplate[]>(
    []
  );
  const [chatGroup, setChatGroup] = React.useState<CometChat.Group>();

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

    let definedTemplates: CometChatMessageTemplate[] =
      CometChatUIKit.getDataSource().getAllMessageTemplates();
    const CUSTOM_MESSAGE_TYPE = "customType";
    let customMessageTemplate = new CometChatMessageTemplate({
      type: CUSTOM_MESSAGE_TYPE,
      category: CometChatUIKitConstants.MessageCategory.custom,
      contentView: (message: CometChat.BaseMessage) => getContentView(message),
    });
    definedTemplates.push(customMessageTemplate);
    setTemplates(definedTemplates);
  }, []);

  const getContentView = (message: CometChat.BaseMessage) => {
    return (
      <div className="content-view">
        <div className="content-view__header">
          <img
            className="content-view__header-banner"
            src={bannerImage}
            alt=""
          />
        </div>
        <div className="content-view__body">
          <div>
            <div className="content-view__body-title">Blazer Casual</div>
            <div className="content-view__body-description">
              Men's Tailored Regular Fit Blazer
            </div>
          </div>
          <div>
            <div className="content-view__body-price">
              $37.99{" "}
              <span className="content-view__body-price-old">$74.00</span>
            </div>
            <div className="content-view__body-delivery-type">
              Free Delivery
            </div>
          </div>
        </div>
        <div className="content-footer">Buy now</div>
      </div>
    );
  };

  const getMessageRequestBuilder = () => {
    const CUSTOM_MESSAGE_TYPE = "customType";
    let categories = CometChatUIKit.getDataSource().getAllMessageCategories();
    categories.push(CometChatUIKitConstants.MessageCategory.custom);
    let types = CometChatUIKit.getDataSource().getAllMessageTypes();
    types.push(CUSTOM_MESSAGE_TYPE);
    return new CometChat.MessagesRequestBuilder()
      .setCategories(categories)
      .setTypes(types)
      .hideReplies(true)
      .setLimit(30);
  };

  return (
    <div>
      {chatGroup && (
        <CometChatMessageList
          group={chatGroup}
          templates={templates}
          messagesRequestBuilder={getMessageRequestBuilder()}
        />
      )}
    </div>
  );
};

export { CustomMessageTemplate };

BottomView

The bottomView method of MessageTemplate allows you to add a custom button view to your message bubbles. In the example below, we will add a custom bottom view to every text message in the MessageList.

import React, { useEffect, useState } from "react";
import {
  CometChatMessageList,
  CometChatUIKit,
  CometChatUIKitConstants,
} from "@cometchat/chat-uikit-react";
import { CometChat } from "@cometchat/chat-sdk-javascript";

const CustomMessageTemplate = () => {
  const [templates, setTemplates] = React.useState<CometChatMessageTemplate[]>(
    []
  );
  const [chatGroup, setChatGroup] = React.useState<CometChat.Group>();

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

    let definedTemplates: CometChatMessageTemplate[] =
      CometChatUIKit.getDataSource().getAllMessageTemplates();
    const template = definedTemplates.map((templates) => {
      if (
        templates.type === CometChatUIKitConstants.MessageTypes.text &&
        templates.category === CometChatUIKitConstants.MessageCategory.message
      ) {
        templates.bottomView = (message: CometChat.BaseMessage) =>
          getBottomView(message);
        return templates;
      }
      return templates;
    });
    setTemplates(template);
  }, []);

  const getBottomView = (message: CometChat.BaseMessage) => {
    return (
      <div className="bottom-view">
        <span className="error-icon"> </span> According to guidelines you cannot
        share contact
      </div>
    );
  };

  return (
    <div>
      {chatGroup && (
        <CometChatMessageList group={chatGroup} templates={templates} />
      )}
    </div>
  );
};

export { CustomMessageTemplate };

FooterView

The footerView method of MessageTemplate allows you to add a footer view to your message bubbles. In the example below, we will add a custom footer view to every text message in the MessageList.

import React, { useEffect, useState } from "react";
import {
  CometChatMessageList,
  CometChatUIKit,
  CometChatUIKitConstants,
} from "@cometchat/chat-uikit-react";
import { CometChat } from "@cometchat/chat-sdk-javascript";

const CustomMessageTemplate = () => {
  const [templates, setTemplates] = React.useState<CometChatMessageTemplate[]>(
    []
  );
  const [chatGroup, setChatGroup] = React.useState<CometChat.Group>();

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

    let definedTemplates: CometChatMessageTemplate[] =
      CometChatUIKit.getDataSource().getAllMessageTemplates();
    const template = definedTemplates.map((templates) => {
      if (
        templates.type === CometChatUIKitConstants.MessageTypes.text &&
        templates.category === CometChatUIKitConstants.MessageCategory.message
      ) {
        templates.footerView = (message: CometChat.BaseMessage) =>
          getFooterView(message);
        return templates;
      }
      return templates;
    });
    setTemplates(template);
  }, []);

  const getFooterView = (message: CometChat.BaseMessage) => {
    if (message.getReactions().length > 0) {
      return (
        <>
          <CometChatReactions messageObject={message} />
        </>
      );
    } else {
      return null;
    }
  };

  return (
    <div>
      {chatGroup && (
        <CometChatMessageList group={chatGroup} templates={templates} />
      )}
    </div>
  );
};

export { CustomMessageTemplate };

BubbleView

The bubbleView method of MessageTemplate allows you to add a bubble view to your message bubbles. In the example below, we will add a custom bubble view to the text message in the MessageList.

import React, { useEffect, useState } from "react";
import {
  CometChatMessageList,
  CometChatUIKit,
  CometChatUIKitConstants,
  CometChatMessageTemplate,
  Receipts,
  MessageBubbleAlignment,
  CometChatUIKitLoginListener,
  MessageReceiptUtils,
  isMessageSentByMe
} from "@cometchat/chat-uikit-react";
import { CometChat } from "@cometchat/chat-sdk-javascript";
import readIcon from "../../assets/message-read.svg";
import sentIcon from "../../assets/message-sent.svg";
import deliveredIcon from "../../assets/message-delivered.svg";

const CustomMessageTemplate = () => {
  const [templates, setTemplates] = React.useState<CometChatMessageTemplate[]>(
    []
  );
  const [chatGroup, setChatGroup] = React.useState<CometChat.Group>();

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

    let definedTemplates =
      CometChatUIKit.getDataSource().getAllMessageTemplates();
    const template = definedTemplates.map((templates) => {
      if (
        templates.type === CometChatUIKitConstants.MessageTypes.text &&
        templates.category === CometChatUIKitConstants.MessageCategory.message
      ) {
        templates.bubbleView = (
          message: CometChat.BaseMessage,
          alignment: MessageBubbleAlignment
        ) => getBubbleView(message, alignment);
        return templates;
      }
      return templates;
    });
    setTemplates(template);
  }, []);

  const formatTime = (timestamp: number): string => {
    const date = new Date(timestamp * 1000); // Convert to milliseconds
    const hours = date.getHours();
    const minutes = date.getMinutes();
    const period = hours >= 12 ? "PM" : "AM";
    const formattedHours = hours % 12 || 12;
    const formattedMinutes = minutes < 10 ? "0" + minutes : minutes;
    return `${formattedHours}:${formattedMinutes} ${period}`;
  };

  const getBubbleView = (
    message: CometChat.BaseMessage,
    alignment: MessageBubbleAlignment
  ) => {
    const isSentByMe = isMessageSentByMe(
      message,
      CometChatUIKitLoginListener.getLoggedInUser()!
    );

    let textMessage = "";
    if (message instanceof CometChat.TextMessage) {
      textMessage = message.getText();
    }

    const receipt = MessageReceiptUtils.getReceiptStatus(message);
    let status = sentIcon;

    if (receipt === Receipts.delivered) {
      status = deliveredIcon;
    } else if (receipt === Receipts.read) {
      status = readIcon;
    } else {
      status = sentIcon;
    }

    return (
      <div
        className={`bubble-view ${
          isSentByMe ? "bubble-view__outgoing" : "bubble-view__incoming"
        } `}
      >
        <div className="bubble-view__content">
          <div className="bubble-view__content__text">{textMessage}</div>
          <div className="triangle"></div>
        </div>
        <div className="bubble-view__content__time">
          {formatTime(message.getSentAt())}
          {isSentByMe && <img src={status} alt="" width="16px" height="16px" />}
        </div>
      </div>
    );
  };

  return (
    <div>
      {chatGroup && (
        <CometChatMessageList group={chatGroup} templates={templates} />
      )}
    </div>
  );
};

export { CustomMessageTemplate };

StatusInfoView

The statusInfoView method of MessageTemplate allows you to add a status info view to your message bubbles. In the example below, we will add a custom status info view to every text message in the MessageList.

import React, { useEffect, useState } from "react";
import {
  CometChatMessageList,
  CometChatUIKit,
  CometChatUIKitConstants,
} from "@cometchat/chat-uikit-react";
import { CometChat } from "@cometchat/chat-sdk-javascript";

const CustomMessageTemplate = () => {
  const [templates, setTemplates] = React.useState<CometChatMessageTemplate[]>(
    []
  );
  const [chatGroup, setChatGroup] = React.useState<CometChat.Group>();

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

    let definedTemplates: CometChatMessageTemplate[] =
      CometChatUIKit.getDataSource().getAllMessageTemplates();
    const template = definedTemplates.map((templates) => {
      if (
        templates.type === CometChatUIKitConstants.MessageTypes.text &&
        templates.category === CometChatUIKitConstants.MessageCategory.message
      ) {
        templates.statusInfoView = (message: CometChat.BaseMessage) =>
          getStatusInfo(message);
        return templates;
      }
      return templates;
    });
    setTemplates(template);
  }, []);

  const formatTime = (timestamp: number): string => {
    const date = new Date(timestamp * 1000); // Convert to milliseconds
    const hours = date.getHours();
    const minutes = date.getMinutes();
    const period = hours >= 12 ? "PM" : "AM";
    const formattedHours = hours % 12 || 12;
    const formattedMinutes = minutes < 10 ? "0" + minutes : minutes;
    return `${formattedHours}:${formattedMinutes} ${period}`;
  };

  const getStatusInfo = (message: CometChat.BaseMessage) => {
    if (message instanceof CometChat.TextMessage) {
      const timestamp = message.getSentAt();
      const formattedTime = formatTime(timestamp);
      return <div className="status-info">{formattedTime}</div>;
    } else {
      return null;
    }
  };

  return (
    <div>
      {chatGroup && (
        <CometChatMessageList group={chatGroup} templates={templates} />
      )}
    </div>
  );
};

export { CustomMessageTemplate };

Options

The options method in the MessageTemplate allows you to customize the options that appear in the action sheet when a message is long-pressed. By default, CometChat UI Kit provides a set of options like “Thread Reply”, “Copy” ,“Edit”, and “Delete”. However, if you wish to override or modify these options, you can use the options method and pass a list of CometChatActionsIcon. This list of options will replace the default set.

import React, { useEffect, useState } from "react";
import {
  CometChatMessageList,
  CometChatUIKit,
  CometChatUIKitConstants,
  CometChatMessageTemplate,
  CometChatActionsIcon,
} from "@cometchat/chat-uikit-react";
import { CometChat } from "@cometchat/chat-sdk-javascript";

const CustomMessageTemplate = () => {
  const [templates, setTemplates] = useState<CometChatMessageTemplate[]>(
    []
  );
  const [chatGroup, setChatGroup] = useState<CometChat.Group>();

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

    let definedTemplates: CometChatMessageTemplate[] =
      CometChatUIKit.getDataSource().getAllMessageTemplates();
    const template = definedTemplates.map((templates) => {
      if (
        templates.type === CometChatUIKitConstants.MessageTypes.text &&
        templates.category === CometChatUIKitConstants.MessageCategory.message
      ) {
        templates.options = (
          loggedInUser: CometChat.User,
          message: CometChat.BaseMessage,
          group?: CometChat.Group
        ) => getCustomOptions(loggedInUser, message, chatGroup);
        return templates;
      }
      return templates;
    });
    setTemplates(template);
  }, []);

  const getCustomOptions = (
    loggedInUser: CometChat.User,
    message: CometChat.BaseMessage,
    group?: CometChat.Group
  ) => {
    const defaultOptions: any =
      CometChatUIKit.getDataSource().getMessageOptions(
        loggedInUser,
        message,
        chatGroup
      );
    const myView: any = new CometChatActionsIcon({
      id: "refresh",
      title: "Refresh",
      iconURL: "", // Add your custom icon URL
      onClick: () => console.log("custom action"),
    });
    defaultOptions.splice(1, 0, myView);
    return defaultOptions;
  };

  return (
    <div>
      {chatGroup && (
        <CometChatMessageList group={chatGroup} templates={templates} />
      )}
    </div>
  );
};

export { CustomMessageTemplate };

New Templates

You can create an entirely new template for custom messages is one of the powerful features of CometChat’s MessageTemplate.

import React, { useEffect, useState } from "react";
import {
  CometChatMessageList,
  CometChatUIKit,
  CometChatUIKitConstants,
  CometChatMessageTemplate,
  MessageReceiptUtils,
  isMessageSentByMe,
  Receipts,
  CometChatUIKitLoginListener,
} from "@cometchat/chat-uikit-react";
import { CometChat } from "@cometchat/chat-sdk-javascript";
import readIcon from "../../assets/message-read.svg";
import sentIcon from "../../assets/message-sent.svg";
import deliveredIcon from "../../assets/message-delivered.svg";

const CustomMessageTemplate = () => {
  const [templates, setTemplates] = React.useState<CometChatMessageTemplate[]>(
    []
  );
  const [chatGroup, setChatGroup] = React.useState<CometChat.Group>();

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

    let definedTemplates =
      CometChatUIKit.getDataSource().getAllMessageTemplates();
    const CUSTOM_MESSAGE_TYPE = "customType";
    let customMessageTemplate = new CometChatMessageTemplate({
      type: CUSTOM_MESSAGE_TYPE,
      category: CometChatUIKitConstants.MessageCategory.custom,
      contentView: (message: CometChat.BaseMessage) => getContentView(message),
    });
    definedTemplates.push(customMessageTemplate);
    setTemplates(definedTemplates);
  }, []);

  const formatTime = (timestamp: number): string => {
    const date = new Date(timestamp * 1000); // Convert to milliseconds
    const hours = date.getHours();
    const minutes = date.getMinutes();
    const period = hours >= 12 ? "PM" : "AM";
    const formattedHours = hours % 12 || 12;
    const formattedMinutes = minutes < 10 ? "0" + minutes : minutes;
    return `${formattedHours}:${formattedMinutes} ${period}`;
  };

  const getContentView = (message: CometChat.BaseMessage) => {
    const isSentByMe = isMessageSentByMe(
      message,
      CometChatUIKitLoginListener.getLoggedInUser()!
    );

    const receipt = MessageReceiptUtils.getReceiptStatus(message);
    let status = sentIcon;

    if (receipt === Receipts.delivered) {
      status = deliveredIcon;
    } else if (receipt === Receipts.read) {
      status = readIcon;
    } else {
      status = sentIcon;
    }

    return (
      <div
        className={`content-view ${
          isSentByMe
            ? "cometchat-message-bubble-outgoing "
            : "cometchat-message-bubble-incoming"
        } `}
      >
        <div className="content-view__header">
          <CometChatListItem
            title={message.getSender().getName()}
            avatarURL={message.getSender().getAvatar()}
          />
          <div className="content-view__header-time">
            {formatTime(message.getSentAt())}
            {isSentByMe && (
              <img src={status} alt="" height="16px" width="16px" />
            )}
          </div>
        </div>
        <div className="content-view__footer">
          <div className="content-view__footer-add-contact">Add Contact</div>
          <div className="content-view__footer-message">Message</div>
        </div>
      </div>
    );
  };

  const getMessageRequestBuilder = () => {
    const CUSTOM_MESSAGE_TYPE = "customType";
    let categories = CometChatUIKit.getDataSource().getAllMessageCategories();
    categories.push(CometChatUIKitConstants.MessageCategory.custom);
    let types = CometChatUIKit.getDataSource().getAllMessageTypes();
    types.push(CUSTOM_MESSAGE_TYPE);
    return new CometChat.MessagesRequestBuilder()
      .setCategories(categories)
      .setTypes(types)
      .hideReplies(true)
      .setLimit(30);
  };

  return (
    <div>
      {chatGroup && (
        <CometChatMessageList
          group={chatGroup}
          templates={templates}
          messagesRequestBuilder={getMessageRequestBuilder()}
        />
      )}
    </div>
  );
};

export { CustomMessageTemplate };

​Overview

​Structure

​Properties

​Customization

​Existing Templates

​HeaderView

​Contentview

​BottomView

​FooterView

​BubbleView

​StatusInfoView

​Options

​New Templates