Skip to content

docs(react): document Card Message rendering in the v7 UI Kit#421

Merged
ketanyekale merged 1 commit into
mainfrom
feature/ENG-36071-react-v7-card-messages-docs
Jul 6, 2026
Merged

docs(react): document Card Message rendering in the v7 UI Kit#421
ketanyekale merged 1 commit into
mainfrom
feature/ENG-36071-react-v7-card-messages-docs

Conversation

@aanshisingh-cometchat

Copy link
Copy Markdown
Contributor

Add documentation for the v7 React UI Kit card message feature (category "card"), rendered by the CometChatCardBubble plugin over the prebuilt CometChatCardView renderer:

  • components/card-bubble.mdx: new page for CometChatCardBubble (props, card actions, fallback behavior, CSS selectors) with the message hierarchy diagram
  • event-system.mdx: add the message/card-received SDK event and the ui:card/action UI event (Card Actions section + quick reference)
  • plugins/overview.mdx: add the built-in Card plugin row
  • components-overview.mdx: add the CometChatCardBubble row
  • docs.json: register the card-bubble page in the sidebar nav

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)

Add documentation for the v7 React UI Kit card message feature (category
"card"), rendered by the CometChatCardBubble plugin over the prebuilt
CometChatCardView renderer:

- components/card-bubble.mdx: new page for CometChatCardBubble (props,
  card actions, fallback behavior, CSS selectors) with the message
  hierarchy diagram
- event-system.mdx: add the message/card-received SDK event and the
  ui:card/action UI event (Card Actions section + quick reference)
- plugins/overview.mdx: add the built-in Card plugin row
- components-overview.mdx: add the CometChatCardBubble row
- docs.json: register the card-bubble page in the sidebar nav

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@mintlify

mintlify Bot commented Jul 3, 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 3, 2026, 1:04 PM

@jitvarpatil

Copy link
Copy Markdown
Contributor

Docs review — ✅ Approve

React v7 UIKit card-rendering docs — a new CometChatCardBubble component page (191 lines) + event-system card rows (5 files, +204/-1). All-new content, no deletions → no redirect risk. I verified the component, events, and package against the React UIKit card-message-rendering branch and npm — all correct.

✅ Verified

  • Structure: new card-bubble.mdx wired into nav; 0 build breaks, 0 orphans, 0 broken links; all internal links resolve.
  • API (against ENG-36540-card-message-rendering, React UIKit v7):
    • CometChatCardBubble — real exported component (src/index.ts).
    • ui:card/action event (used in CometChatAIAssistantBubble.tsx) and message/card-received (in useMessageListEvents.ts) — both real event keys (v7's hooks/string-event architecture, correctly used here).
    • @cometchat/cards-react renderer — a real dependency in the UIKit package.json and published on npm (1.0.0).
  • Content correctness: cards correctly framed as receive-only / render-only ("the UI Kit renders them, it does not send them"; "mirroring CometChatTextBubble"; "your app owns all action behavior"). Imports correct (CometChatCardBubble from @cometchat/chat-uikit-react, CometChat from @cometchat/chat-sdk-javascript).
  • No version drift (no hardcoded @7 pins) and no placeholders/TODOs.

Clean, well-sourced PR (companion to #420). Ready to merge. 🚀

🤖 Automated docs review (Mintlify link/redirect/content checks + API verification against @cometchat/chat-uikit-react v7 card branch and npm).

@jitvarpatil jitvarpatil left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Docs review — ✅ Approve

React v7 UIKit card-rendering docs — a new CometChatCardBubble component page (191 lines) + event-system card rows (5 files, +204/-1). All-new content, no deletions → no redirect risk. I verified the component, events, and package against the React UIKit card-message-rendering branch and npm — all correct.

✅ Verified

  • Structure: new card-bubble.mdx wired into nav; 0 build breaks, 0 orphans, 0 broken links; all internal links resolve.
  • API (against ENG-36540-card-message-rendering, React UIKit v7):
    • CometChatCardBubble — real exported component (src/index.ts).
    • ui:card/action event (used in CometChatAIAssistantBubble.tsx) and message/card-received (in useMessageListEvents.ts) — both real event keys (v7's hooks/string-event architecture, correctly used here).
    • @cometchat/cards-react renderer — a real dependency in the UIKit package.json and published on npm (1.0.0).
  • Content correctness: cards correctly framed as receive-only / render-only ("the UI Kit renders them, it does not send them"; "mirroring CometChatTextBubble"; "your app owns all action behavior"). Imports correct (CometChatCardBubble from @cometchat/chat-uikit-react, CometChat from @cometchat/chat-sdk-javascript).
  • No version drift (no hardcoded @7 pins) and no placeholders/TODOs.

Clean, well-sourced PR (companion to #420). Ready to merge. 🚀

🤖 Automated docs review (Mintlify link/redirect/content checks + API verification against @cometchat/chat-uikit-react v7 card branch and npm).

@ketanyekale ketanyekale merged commit a720260 into main Jul 6, 2026
4 of 5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

5 participants