Skip to content

docs(ui-kit/react): add multi attachment and plural media bubble docs for v7#424

Open
PrajwalDhuleCC wants to merge 3 commits into
mainfrom
docs/multi-attachment-react-uikit-v7
Open

docs(ui-kit/react): add multi attachment and plural media bubble docs for v7#424
PrajwalDhuleCC wants to merge 3 commits into
mainfrom
docs/multi-attachment-react-uikit-v7

Conversation

@PrajwalDhuleCC

Copy link
Copy Markdown
Contributor
  • Add Audios Bubble component documentation with playback controls and batch positioning
  • Add Files Bubble component documentation with download and preview capabilities
  • Add Images Bubble component documentation with gallery and batch rendering
  • Add Videos Bubble component documentation with inline playback and streaming
  • Add Voice Note Bubble component documentation with waveform visualization
  • Update Message Composer guide to reference multi-attachment staging
  • Update Message List guide to document batch grouping and positioning
  • Update Migration Property Changes guide with bubble component mappings
  • Include AI Integration Quick Reference for each new component
  • Add CSS selectors and prop tables for consistent styling reference

Description

Related Issue(s)

Type of Change

  • Documentation correction/update
  • New documentation
  • Improvement to existing documentation
  • Typo fix
  • Other (please specify)

Checklist

  • I have read the CONTRIBUTING document
  • My branch name follows the naming convention
  • My changes follow the documentation style guide
  • I have checked for spelling and grammar errors
  • All links in my changes are valid and working
  • My changes are accurately described in this pull request

Additional Information

Screenshots (if applicable)

… for v7

- Add Audios Bubble component documentation with playback controls and batch positioning
- Add Files Bubble component documentation with download and preview capabilities
- Add Images Bubble component documentation with gallery and batch rendering
- Add Videos Bubble component documentation with inline playback and streaming
- Add Voice Note Bubble component documentation with waveform visualization
- Update Message Composer guide to reference multi-attachment staging
- Update Message List guide to document batch grouping and positioning
- Update Migration Property Changes guide with bubble component mappings
- Include AI Integration Quick Reference for each new component
- Add CSS selectors and prop tables for consistent styling reference
@mintlify

mintlify Bot commented Jul 9, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
cometchat 🟢 Ready View Preview Jul 9, 2026, 3:59 PM

@raj-dubey1

Copy link
Copy Markdown
Contributor

📋 Docs review — 🔴 Request changes

Reviewed this PR for docs-breakage and content accuracy, cross-checked against the implementing UIKit PR cometchat-team/uikit-react#2335 (ENG-36866).

Verdict: Request changes. Structurally safe and prop tables are accurate — but one documented prop (enableMultipleAttachments on CometChatMessageList) describes behavior that doesn't exist in the code, repeated across 7 files.


🔴 P0 (content) — enableMultipleAttachments documented as a CometChatMessageList prop that doesn't exist

The docs repeatedly state that CometChatMessageList has an enableMultipleAttachments prop which, when false, renders the legacy singular bubbles. The code implements no such thing. Three independent confirmations against #2335:

  1. CometChatMessageList.types.ts and CometChatMessageList.tsx — the prop is absent. It exists only on CometChatMessageComposer, where it controls the staging tray / batched send — not bubble rendering.
  2. CometChatImagePlugin.renderBubble() unconditionally creates CometChatImagesBubble — no flag, no branch to the legacy bubble. Its own comment: "The legacy single-attachment CometChatImageBubble remains available as a deprecated standalone component." CometChatAudioPlugin routes voice_noteVoiceNoteBubble, else → AudiosBubble — again no such flag.
  3. Neither the plugins nor the bubble renderer reference enableMultipleAttachments at all.

Reader impact: a TypeScript user copying <CometChatMessageList enableMultipleAttachments={false}> gets a compile error (prop not in CometChatMessageListProps); a JS user gets a silent no-op and still sees plural bubbles. Anyone migrating v6→v7 to keep the old bubbles is told to flip a switch that isn't wired.

Occurrences to fix (7 files):

  • migration-property-changes.mdx:83 (under CometChatMessageList → New Props)
  • message-list.mdx (new ### enableMultipleAttachments section + AI-ref entry)
  • images-bubble.mdx:36, 200-202
  • audios-bubble.mdx:34, 184
  • videos-bubble.mdx:35, 194
  • files-bubble.mdx:34, 190
  • voice-note-bubble.mdx:34, 40

Fix: either (a) drop the MessageList prop + all "when false, legacy bubbles render" claims (describe the plural bubbles as the default plugin behavior and the legacy ones as deprecated standalone components), or (b) if that toggle is intended, add it to CometChatMessageList + the plugins in the code PR first. The composer-side enableMultipleAttachments docs are correct and should stay.


🔸 P2 — leftover screenshot placeholders (9)

{/* TODO: Add screenshot… */} / {/* TODO: Add Storybook embed… */} remain in images-bubble.mdx:45,74, videos-bubble.mdx:46,77, audios-bubble.mdx:52,83, files-bubble.mdx:45,90, voice-note-bubble.mdx:52. They're MDX comments (invisible to readers), but every new page ships with no images.

🔸 P2 — batchPosition documents behavior not yet wired

The 5 bubble .tsx files declare batchPosition in their prop types but none consume it — the plugin passes it in, but the documented corner-radius effects don't render yet. Consider softening to "reserved for batch corner-radius styling."


✅ What passed (verified against #2335)

  • Build safe: 0 unresolved nav refs; all 5 new bubble pages added to docs.json; 0 broken links; 0 orphans. Legacy pages linked to (image-bubble, audio-bubble, video-bubble, file-bubble) all exist.
  • Component names exact, including the (correct) singular CometChatVoiceNoteBubble.
  • Prop tables accurate vs. each .types.ts: images has placeholderImage + onImageClicked; videos has onVideoClicked (no placeholderImage); audios/files have neither — docs match exactly, no hallucinated props.
  • CSS selectors verified: images-bubble matches CometChatImagesBubble.css; all 8 voice-note-bubble selectors exist in the real CometChatAudioBubble.css.
  • Composer doc is correct: it removed the non-existent maxAttachments/maxFileSize props and documents the real enableMultipleAttachments (default true), disableDragAndDrop (default false), allowedFileTypes — all match CometChatMessageComposer.types.ts.

🤖 Automated docs review (Claude Code), cross-checked against the implementing code PR.

…MultipleAttachments in message list as it's no longer present
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Development

Successfully merging this pull request may close these issues.

2 participants