feat: render voice recording preview in a dedicated slot

Author: MartinCupela

src/components/MessageInput/AttachmentPreviewList/AttachmentPreviewList.tsx

@@ -13,7 +13,6 @@ import {
   UnsupportedAttachmentPreview as DefaultUnknownAttachmentPreview,
   type UnsupportedAttachmentPreviewProps,
 } from './UnsupportedAttachmentPreview';
-import { type VoiceRecordingPreviewProps } from './VoiceRecordingPreview';
 import {
   FileAttachmentPreview as DefaultFileAttachmentPreview,
   type FileAttachmentPreviewProps,
@@ -40,7 +39,6 @@ export type AttachmentPreviewListProps = {
   ImageAttachmentPreview?: ComponentType<ImageAttachmentPreviewProps>;
   UnsupportedAttachmentPreview?: ComponentType<UnsupportedAttachmentPreviewProps>;
   VideoAttachmentPreview?: ComponentType<MediaAttachmentPreviewProps>;
-  VoiceRecordingPreview?: ComponentType<VoiceRecordingPreviewProps>;
 };
 
 export const AttachmentPreviewList = ({
@@ -50,7 +48,6 @@ export const AttachmentPreviewList = ({
   ImageAttachmentPreview = MediaAttachmentPreview,
   UnsupportedAttachmentPreview = DefaultUnknownAttachmentPreview,
   VideoAttachmentPreview = MediaAttachmentPreview,
-  VoiceRecordingPreview = DefaultAudioAttachmentPreview,
 }: AttachmentPreviewListProps) => {
   const messageComposer = useMessageComposer();
 
@@ -79,16 +76,9 @@ export const AttachmentPreviewList = ({
       )}
       {attachments.map((attachment) => {
         if (isScrapedContent(attachment)) return null;
-        if (isLocalVoiceRecordingAttachment(attachment)) {
-          return (
-            <VoiceRecordingPreview
-              attachment={attachment}
-              handleRetry={messageComposer.attachmentManager.uploadAttachment}
-              key={attachment.localMetadata.id || attachment.asset_url}
-              removeAttachments={messageComposer.attachmentManager.removeAttachments}
-            />
-          );
-        } else if (isLocalAudioAttachment(attachment)) {
+        // Voice recordings are rendered in the dedicated slot above (VoiceRecordingPreviewSlot)
+        if (isLocalVoiceRecordingAttachment(attachment)) return null;
+        if (isLocalAudioAttachment(attachment)) {
           return (
             <AudioAttachmentPreview
               attachment={attachment}

src/components/MessageInput/AttachmentPreviewList/VoiceRecordingPreviewSlot.tsx

@@ -0,0 +1,38 @@
+import type { ComponentType } from 'react';
+import React from 'react';
+import { isLocalVoiceRecordingAttachment } from 'stream-chat';
+import { useAttachmentsForPreview, useMessageComposer } from '../hooks';
+import { AudioAttachmentPreview } from './AudioAttachmentPreview';
+import type { VoiceRecordingPreviewProps } from './VoiceRecordingPreview';
+
+export type VoiceRecordingPreviewSlotProps = {
+  /** Custom UI component for each voice recording preview in the slot; defaults to AudioAttachmentPreview */
+  VoiceRecordingPreview?: ComponentType<VoiceRecordingPreviewProps>;
+};
+
+/**
+ * Dedicated slot for voice recording preview(s), rendered apart from the main attachment preview list
+ */
+export const VoiceRecordingPreviewSlot = ({
+  VoiceRecordingPreview = AudioAttachmentPreview,
+}: VoiceRecordingPreviewSlotProps) => {
+  const messageComposer = useMessageComposer();
+  const { attachments } = useAttachmentsForPreview();
+
+  const voiceAttachments = attachments.filter(isLocalVoiceRecordingAttachment);
+  const firstVoice = voiceAttachments[0];
+  if (!firstVoice) return null;
+
+  return (
+    <div
+      className='str-chat__message-composer-voice-preview-slot'
+      data-testid='voice-preview-slot'
+    >
+      <VoiceRecordingPreview
+        attachment={firstVoice}
+        handleRetry={messageComposer.attachmentManager.uploadAttachment}
+        removeAttachments={messageComposer.attachmentManager.removeAttachments}
+      />
+    </div>
+  );
+};

src/components/MessageInput/AttachmentPreviewList/index.ts

@@ -7,3 +7,7 @@ export type { UploadAttachmentPreviewProps as AttachmentPreviewProps } from './t
 export type { UnsupportedAttachmentPreviewProps } from './UnsupportedAttachmentPreview';
 export type { MediaAttachmentPreviewProps } from './MediaAttachmentPreview';
 export type { VoiceRecordingPreviewProps } from './VoiceRecordingPreview';
+export {
+  VoiceRecordingPreviewSlot,
+  type VoiceRecordingPreviewSlotProps,
+} from './VoiceRecordingPreviewSlot';

src/components/MessageInput/MessageInputFlat.tsx

@@ -4,7 +4,10 @@ import {
   AttachmentSelector as DefaultAttachmentSelector,
   SimpleAttachmentSelector,
 } from './AttachmentSelector/AttachmentSelector';
-import { AttachmentPreviewList as DefaultAttachmentPreviewList } from './AttachmentPreviewList';
+import {
+  AttachmentPreviewList as DefaultAttachmentPreviewList,
+  VoiceRecordingPreviewSlot as DefaultVoiceRecordingPreviewSlot,
+} from './AttachmentPreviewList';
 import { AudioRecorder as DefaultAudioRecorder } from '../MediaRecorder';
 import { EditedMessagePreview as DefaultEditedMessagePreview } from './EditedMessagePreview';
 import { QuotedMessagePreview as DefaultQuotedMessagePreview } from './QuotedMessagePreview';
@@ -55,6 +58,7 @@ const MessageComposerPreviews = () => {
     EditedMessagePreview = DefaultEditedMessagePreview,
     LinkPreviewList = DefaultLinkPreviewList,
     QuotedMessagePreview = DefaultQuotedMessagePreview,
+    VoiceRecordingPreviewSlot = DefaultVoiceRecordingPreviewSlot,
   } = useComponentContext();
 
   const messageComposer = useMessageComposer();
@@ -97,6 +101,7 @@ const MessageComposerPreviews = () => {
       ) : (
         <QuotedMessagePreview />
       )}
+      <VoiceRecordingPreviewSlot />
       <AttachmentPreviewList />
       <LinkPreviewList />
     </div>

src/components/MessageInput/__tests__/AttachmentPreviewList.test.js

@@ -118,14 +118,13 @@ describe('AttachmentPreviewList', () => {
       expect(screen.getByTitle(`file-upload-${state}`)).toBeInTheDocument();
       expect(screen.getByTitle(`image-upload-${state}`)).toBeInTheDocument();
       expect(screen.getByTitle(`audio-attachment-${state}`)).toBeInTheDocument();
-      expect(
-        screen.getByTitle(`voice-recording-attachment-${state}`),
-      ).toBeInTheDocument();
+      // Voice recordings are rendered in VoiceRecordingPreviewSlot above the list (REACT-794)
       expect(screen.getByTitle(`video-attachment-${state}`)).toBeInTheDocument();
     },
   );
 
-  describe.each(['audio', 'file', 'image', 'unsupported', 'voiceRecording', 'video'])(
+  // voiceRecording is rendered in VoiceRecordingPreviewSlot (REACT-794), not in AttachmentPreviewList
+  describe.each(['audio', 'file', 'image', 'unsupported', 'video'])(
     '%s attachments rendering',
     (type) => {
       const customAttachment = {
@@ -143,7 +142,6 @@ describe('AttachmentPreviewList', () => {
         image: generateImageAttachment,
         unsupported: () => customAttachment,
         video: generateVideoAttachment,
-        voiceRecording: generateVoiceRecordingAttachment,
       };
 
       it('retries upload on upload button click', async () => {
@@ -265,7 +263,6 @@ describe('AttachmentPreviewList', () => {
           image: 'ImageAttachmentPreview',
           unsupported: 'UnsupportedAttachmentPreview',
           video: 'MediaAttachmentPreview',
-          voiceRecording: 'VoiceRecordingPreview',
         };
         const title = `${type}-attachment`;
         const id = `${type}-id`;

src/components/MessageInput/index.ts

@@ -8,6 +8,7 @@ export type {
   AttachmentPreviewProps,
   UnsupportedAttachmentPreviewProps,
   VoiceRecordingPreviewProps,
+  VoiceRecordingPreviewSlotProps,
 } from './AttachmentPreviewList';
 export * from './CommandChip';
 export * from './CooldownTimer';

src/components/MessageInput/styling/AttachmentPreview.scss

@@ -73,6 +73,24 @@
 
   --str-chat__attachment-preview-file-fatal-error-color: var(--color-accent-error);
 
+  .str-chat__message-composer-voice-preview-slot {
+    display: flex;
+    align-items: center;
+    width: 100%;
+    padding: var(--spacing-xxs);
+    min-width: 0;
+
+    .str-chat__attachment-preview-audio {
+      width: 100%;
+      min-width: 0;
+      max-width: none;
+
+      .str-chat__attachment-preview-file__data {
+        width: 100%;
+      }
+    }
+  }
+
   .str-chat__attachment-preview-list {
     @include utils.component-layer-overrides('attachment-preview-list');
     padding: var(--spacing-xxs);
@@ -309,6 +327,5 @@
     height: var(--button-visual-height-md);
     width: var(--button-visual-height-md);
     border: 1px solid var(--control-play-control-border);
-    background-color: var(--control-play-control-bg);
   }
 }

src/context/ComponentContext.tsx

@@ -51,6 +51,7 @@ import type {
   TypingIndicatorProps,
   UnreadMessagesNotificationProps,
   UnreadMessagesSeparatorProps,
+  VoiceRecordingPreviewSlotProps,
 } from '../components';
 
 import type {
@@ -79,6 +80,8 @@ export type ComponentContextValue = {
   AttachmentPreviewList?: React.ComponentType<AttachmentPreviewListProps>;
   /** Custom UI component to control adding attachments to MessageInput, defaults to and accepts same props as: [AttachmentSelector](https://github.com/GetStream/stream-chat-react/blob/master/src/components/MessageInput/AttachmentSelector.tsx) */
   AttachmentSelector?: React.ComponentType;
+  /** Custom UI component for the dedicated voice recording preview slot above composer attachments (REACT-794), defaults to and accepts same props as: [VoiceRecordingPreviewSlot](https://github.com/GetStream/stream-chat-react/blob/master/src/components/MessageInput/AttachmentPreviewList/VoiceRecordingPreviewSlot.tsx) */
+  VoiceRecordingPreviewSlot?: React.ComponentType<VoiceRecordingPreviewSlotProps>;
   /** Custom UI component for contents of attachment selector initiation button */
   AttachmentSelectorInitiationButtonContents?: React.ComponentType;
   /** Custom UI component to display AudioRecorder in MessageInput, defaults to and accepts same props as: [AudioRecorder](https://github.com/GetStream/stream-chat-react/blob/master/src/components/MessageInput/AudioRecorder.tsx) */