feat: Improve message template view

package.json

@@ -70,8 +70,8 @@
   },
   "dependencies": {
     "@sendbird/chat": "^4.14.2",
-    "@sendbird/react-uikit-message-template-view": "0.0.1-alpha.79",
-    "@sendbird/uikit-tools": "0.0.1-alpha.79",
+    "@sendbird/react-uikit-message-template-view": "0.0.2",
+    "@sendbird/uikit-tools": "0.0.2",
     "css-vars-ponyfill": "^2.3.2",
     "date-fns": "^2.16.1",
     "dompurify": "^3.0.1"

src/modules/Channel/components/Message/hooks/useIsElementInViewport.ts

@@ -1,17 +1,27 @@
-import React, { useLayoutEffect, useState } from 'react';
+import React, { useCallback, useEffect, useState } from 'react';
 
-export const useIsElementInViewport = (elementRef: React.MutableRefObject<any>) => {
+export const useIsElementInViewport = (): [React.RefCallback<HTMLDivElement>, boolean] => {
   const [isVisible, setIsVisible] = useState(false);
+  const [element, setElement] = useState(null);
 
-  useLayoutEffect(() => {
-    const observer = new IntersectionObserver((entries: IntersectionObserverEntry[]) => {
+  const ref = useCallback((node) => {
+    if (node !== null) setElement(node);
+  }, []);
+
+  useEffect(() => {
+    if (!element) return;
+
+    const observer = new IntersectionObserver((entries) => {
       const [entry] = entries;
-      if (entry) setIsVisible(entry.isIntersecting);
+      setIsVisible(entry.isIntersecting);
     });
 
-    if (elementRef.current) observer.observe(elementRef.current);
-    return () => observer.disconnect();
-  }, [elementRef.current]);
+    observer.observe(element);
+
+    return () => {
+      observer.disconnect();
+    };
+  }, [element]);
 
-  return isVisible;
+  return [ref, isVisible];
 };

src/modules/Channel/components/Message/hooks/useLazyImageLoader.ts

@@ -1,10 +1,10 @@
-import React, { useRef } from 'react';
+import { RefCallback, useRef } from 'react';
 import { useIsElementInViewport } from './useIsElementInViewport';
 
-export const useLazyImageLoader = (elementRef: React.MutableRefObject<any>) => {
+export const useLazyImageLoader = (): [RefCallback<HTMLDivElement>, boolean] => {
   const isLoaded = useRef(false);
-  const isVisible = useIsElementInViewport(elementRef);
+  const [ref, isVisible] = useIsElementInViewport();
 
   if (isVisible) isLoaded.current = true;
-  return isLoaded.current;
+  return [ref, isLoaded.current];
 };

src/types.ts

@@ -87,9 +87,4 @@ export interface UploadedFileInfoWithUpload {
 
 export type SendbirdTheme = 'light' | 'dark';
 
-export enum MessageContentMiddleContainerType {
-  DEFAULT = 'default',
-  WIDE = 'wide',
-}
-
 export type HTMLTextDirection = 'ltr' | 'rtl';

src/ui/ChannelAvatar/__tests__/ChannelAvatar.spec.js

@@ -17,7 +17,7 @@ describe('ui/ChannelAvatar', () => {
     expect(container.getElementsByClassName(targetClassName)[0].className).toContain(targetClassName);
   });
 
-  it('should render an avatar broadcastChannel with url', function() {
+  it('should render an avatar broadcastChannel with non default url', function() {
     const targetClassName = "sendbird-chat-header--avatar--broadcast-channel";
     const coverUrl = '123';
     render(<ChannelAvatar channel={{ isBroadcast: true, coverUrl }} />);

src/ui/ContextMenu/index.scss

@@ -4,6 +4,10 @@
   display: inline;
 }
 
+.sendbird-message-content__sendbird-ui-container-type__default__header-container .sendbird-context-menu {
+  display: flex;
+}
+
 .sendbird__offline {
   .sendbird-dropdown__menu .sendbird-dropdown__menu-item {
     cursor: not-allowed;

src/ui/ContextMenu/index.tsx

@@ -84,7 +84,6 @@ export default function ContextMenu({
   return (
     <div
       className="sendbird-context-menu"
-      style={{ display: 'inline' }}
       onClick={onClick}
     >
       {menuTrigger?.(() => setShowMenu(!showMenu))}

src/ui/ImageRenderer/index.tsx

@@ -61,9 +61,8 @@ const ImageRenderer = ({
   shadeOnHover,
   isUploaded = true,
 }: ImageRendererProps): ReactElement => {
-  const ref = useRef(null);
-  const isLoaded = useLazyImageLoader(ref);
-  const internalUrl = isLoaded ? url : null;
+  const [ref, isVisible] = useLazyImageLoader();
+  const internalUrl = isVisible ? url : null;
 
   const [defaultComponentVisible, setDefaultComponentVisible] = useState(false);
   const [placeholderVisible, setPlaceholderVisible] = useState(true);

src/ui/MessageContent/MessageBody/index.tsx

@@ -4,7 +4,7 @@ import {
   CoreMessageType,
   getUIKitMessageType, getUIKitMessageTypes, isTemplateMessage, isMultipleFilesMessage,
   isOGMessage, isSendableMessage,
-  isTextMessage, isThumbnailMessage, isVoiceMessage, isFormMessage,
+  isTextMessage, isThumbnailMessage, isVoiceMessage, isFormMessage, isValidTemplateMessageType,
 } from '../../../utils';
 import { BaseMessage, FileMessage, MultipleFilesMessage, UserMessage } from '@sendbird/chat/message';
 import OGMessageItemBody from '../../OGMessageItemBody';
@@ -23,21 +23,20 @@ import { match } from 'ts-pattern';
 import TemplateMessageItemBody from '../../TemplateMessageItemBody';
 import type { OnBeforeDownloadFileMessageType } from '../../../modules/GroupChannel/context/GroupChannelProvider';
 import FormMessageItemBody from '../../FormMessageItemBody';
+import { MESSAGE_TEMPLATE_KEY } from '../../../utils/consts';
 
 export type CustomSubcomponentsProps = Record<
   'ThumbnailMessageItemBody' | 'MultipleFilesMessageItemBody',
   Record<string, any>
 >;
 
 const MESSAGE_ITEM_BODY_CLASSNAME = 'sendbird-message-content__middle__message-item-body';
-export type RenderedTemplateBodyType = 'failed' | 'composite' | 'simple';
 
 export interface MessageBodyProps {
   className?: string;
   channel: Nullable<GroupChannel>;
   message: CoreMessageType;
   showFileViewer?: (bool: boolean) => void;
-  onTemplateMessageRenderedCallback?: (renderedTemplateBodyType: RenderedTemplateBodyType) => void;
   onMessageHeightChange?: () => void;
   onBeforeDownloadFileMessage?: OnBeforeDownloadFileMessageType;
 
@@ -55,7 +54,6 @@ export const MessageBody = (props: MessageBodyProps) => {
     channel,
     showFileViewer,
     onMessageHeightChange,
-    onTemplateMessageRenderedCallback,
     onBeforeDownloadFileMessage,
 
     mouseHover,
@@ -76,6 +74,14 @@ export const MessageBody = (props: MessageBodyProps) => {
   const isOgMessageEnabledInGroupChannel = channel?.isGroupChannel() && config.groupChannel.enableOgtag;
   const isFormMessageEnabledInGroupChannel = channel?.isGroupChannel() && config.groupChannel.enableFormTypeMessage;
 
+  const renderUnknownMessageItemBody = () => <UnknownMessageItemBody
+    className={className}
+    message={message}
+    isByMe={isByMe}
+    mouseHover={mouseHover}
+    isReactionEnabled={isReactionEnabledInChannel}
+  />;
+
   return match(message)
     .when((message) => isFormMessageEnabledInGroupChannel && isFormMessage(message),
       () => (
@@ -85,15 +91,22 @@ export const MessageBody = (props: MessageBodyProps) => {
           form={message.messageForm}
         />
       ))
-    .when(isTemplateMessage, () => (
-      <TemplateMessageItemBody
+    .when(isTemplateMessage, () => {
+      const templatePayload = message.extendedMessagePayload[MESSAGE_TEMPLATE_KEY];
+      if (!isValidTemplateMessageType(templatePayload)) {
+        config.logger?.error?.(
+          'TemplateMessageItemBody: invalid type value in message.extendedMessagePayload.message_template.',
+          templatePayload,
+        );
+        return renderUnknownMessageItemBody();
+      }
+      return <TemplateMessageItemBody
         className={className}
         message={message as BaseMessage}
         isByMe={isByMe}
         theme={config?.theme as SendbirdTheme}
-        onTemplateMessageRenderedCallback={onTemplateMessageRenderedCallback}
-      />
-    ))
+      />;
+    })
     .when((message) => isOgMessageEnabledInGroupChannel
       && isSendableMessage(message)
       && isOGMessage(message), () => (
@@ -163,15 +176,9 @@ export const MessageBody = (props: MessageBodyProps) => {
         {...customSubcomponentsProps['ThumbnailMessageItemBody'] ?? {}}
       />
     ))
-    .otherwise((message) => (
-      <UnknownMessageItemBody
-        className={className}
-        message={message}
-        isByMe={isByMe}
-        mouseHover={mouseHover}
-        isReactionEnabled={isReactionEnabledInChannel}
-      />
-    ));
+    .otherwise(() => {
+      return renderUnknownMessageItemBody();
+    });
 };
 
 export default MessageBody;

src/ui/MessageContent/MessageContentForTemplateMessage.tsx

@@ -0,0 +1,115 @@
+import React, { ReactElement } from 'react';
+import Label, { LabelColors, LabelTypography } from '../Label';
+import { classnames } from '../../utils/utils';
+import format from 'date-fns/format';
+import { MessageTemplateData, TemplateType } from '../TemplateMessageItemBody/types';
+import { MessageComponentRenderers, MessageContentProps } from './index';
+import useSendbirdStateContext from '../../hooks/useSendbirdStateContext';
+import { uiContainerType } from '../../utils';
+import { useLocalization } from '../../lib/LocalizationContext';
+import { MESSAGE_TEMPLATE_KEY } from '../../utils/consts';
+
+type MessageContentForTemplateMessageProps = MessageContentProps & MessageComponentRenderers & {
+  isByMe: boolean;
+  displayThreadReplies: boolean;
+  mouseHover: boolean;
+  isMobile: boolean;
+  isReactionEnabledInChannel: boolean;
+  hoveredMenuClassName: string;
+  templateType: TemplateType | null;
+  useReplying: boolean;
+};
+
+export function MessageContentForTemplateMessage(props: MessageContentForTemplateMessageProps): ReactElement {
+  const {
+    channel,
+    message,
+    showFileViewer,
+    onMessageHeightChange,
+    onBeforeDownloadFileMessage,
+
+    renderSenderProfile,
+    renderMessageHeader,
+    renderMessageBody,
+
+    isByMe,
+    displayThreadReplies,
+    mouseHover,
+    isMobile,
+    isReactionEnabledInChannel,
+    hoveredMenuClassName,
+    templateType,
+    useReplying,
+  } = props;
+
+  const { config } = useSendbirdStateContext();
+  const { dateLocale } = useLocalization();
+
+  const uiContainerTypeClassName = uiContainerType[templateType] ?? '';
+
+  const senderProfile = renderSenderProfile({
+    ...props,
+    chainBottom: false,
+    className: '',
+    isByMe,
+    displayThreadReplies,
+  });
+  const messageHeader = renderMessageHeader(props);
+  const messageBody = renderMessageBody({
+    message,
+    channel,
+    showFileViewer,
+    onMessageHeightChange,
+    mouseHover,
+    isMobile,
+    config,
+    isReactionEnabledInChannel,
+    isByMe,
+    onBeforeDownloadFileMessage,
+  });
+
+  const timeStamp = <Label
+    className={classnames(
+      'sendbird-message-content__middle__body-container__created-at',
+      'right',
+      hoveredMenuClassName,
+      uiContainerTypeClassName,
+    )}
+    type={LabelTypography.CAPTION_3}
+    color={LabelColors.ONBACKGROUND_2}
+  >
+    {format(message?.createdAt || 0, 'p', {
+      locale: dateLocale,
+    })}
+  </Label>;
+
+  const templateData: MessageTemplateData = message.extendedMessagePayload?.[MESSAGE_TEMPLATE_KEY] as MessageTemplateData;
+  const { profile = true, time = true, nickname = true } = templateData?.container_options ?? {};
+  const hasContainerHeader = profile || nickname;
+
+  return (
+    <div className="sendbird-message-content__sendbird-ui-container-type__default__root">
+      {
+        !isByMe
+        && hasContainerHeader
+        && !useReplying
+        && (
+          <div className="sendbird-message-content__sendbird-ui-container-type__default__header-container">
+            <div
+              className="sendbird-message-content__sendbird-ui-container-type__default__header-container__left__profile">
+              {profile && senderProfile}
+            </div>
+            {nickname && messageHeader}
+          </div>
+        )
+      }
+      {messageBody}
+      {
+        (!isByMe && time)
+        && <div className="sendbird-message-content__sendbird-ui-container-type__default__bottom">
+          {timeStamp}
+        </div>
+      }
+    </div>
+  );
+}

src/ui/MessageContent/__tests__/__snapshots__/MessageContent.spec.js.snap

@@ -3,15 +3,14 @@
 exports[`ui/MessageContent should do a snapshot test of the MessageContent DOM 1`] = `
 <DocumentFragment>
   <div
-    class="classname-for-snapshot sendbird-message-content incoming "
+    class="classname-for-snapshot sendbird-message-content incoming"
   >
     <div
       class="sendbird-message-content__left incoming"
       data-testid="sendbird-message-content__left"
     >
       <div
         class="sendbird-context-menu"
-        style="display: inline;"
       >
         <div
           class="sendbird-message-content__left__avatar sendbird-avatar"