docs(ui-kit/angular): document Card Message rendering#417
Conversation
Render-only Card Message support in the Angular UIKit. - components/cometchat-card-bubble.mdx: new developer card bubble reference (render-only contract, inputs, onCardAction/ccCardActionClicked, fallback) - guides/card-messages.mdx: new guide — three delivery paths (developer, persisted agent, streaming agent) and the card action vocabulary - events.mdx: add ccCardActionClicked and onCardMessageReceived - docs.json: register the new pages in the Angular nav Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Docs review — ✅ Approve (one publish item to confirm)Angular UIKit card docs — two new pages + an events row (4 files, +483/-0), the Angular sibling of the React v6/v7 card PRs. Well-constructed and structurally clean. Approving with one thing to confirm before it ships (below). ✅ What passed
🟠 Confirm before merge (publish gap)
Verification noteThe Angular UIKit source isn't in my workspace and the card feature is unreleased on npm, so Docs are solid; just gate the merge on the 🤖 Automated docs review (Mintlify link/redirect/content checks + npm package/type verification). |
jitvarpatil
left a comment
There was a problem hiding this comment.
Docs review — ✅ Approve (one publish item to confirm)
Angular UIKit card docs — two new pages + an events row (4 files, +483/-0), the Angular sibling of the React v6/v7 card PRs. Well-constructed and structurally clean. Approving with one thing to confirm before it ships (below).
✅ What passed
- Structure: both new pages wired into nav; 0 nav breaks, 0 broken internal links (all 8 resolve). (The 1 orphan
/ui-kit/angular/2.0/javascript-2-0-overviewis a pre-existing legacy page — out of scope.) - Content: consistent render-only framing ("never sends or creates cards," dedicated "render-only contract" section), detailed and internally coherent (
CometChatCardView/CometChatCardAction/CometChatCardThemeModefrom the renderer,cardJsonstring input, AOT-typing guidance). No placeholders/TODOs. Mirrors the verified React v6 pattern (#418). - Partial API confirmation:
CometChatMessageEvents.onCardMessageReceivedis present in the published@cometchat/chat-uikit-angular5.0.3 types.
🟠 Confirm before merge (publish gap)
@cometchat/cards-angularis not yet published on npm (registry returns "not found"), yet the docs importCometChatCardView/CometChatCardAction/CometChatCardThemeModefrom it and link tohttps://www.npmjs.com/package/@cometchat/cards-angular(currently 404s).- The card-rendering API (
CometChatCardBubble,CometChatUIEvents.ccCardActionClicked,ICardActionEvent) is not in the latest published UIKit (5.0.3) — it's an unreleased version. - Please confirm both publish with this release (renderer package + card-enabled UIKit version), otherwise the install/import examples and the npm link will be broken for readers.
Verification note
The Angular UIKit source isn't in my workspace and the card feature is unreleased on npm, so CometChatCardBubble / ccCardActionClicked / the @cometchat/cards-angular exports couldn't be independently verified — they mirror the verified React v6 equivalents (strong signal), but worth a quick author/SDK-team sanity check on the exact names.
Docs are solid; just gate the merge on the @cometchat/cards-angular publish.
🤖 Automated docs review (Mintlify link/redirect/content checks + npm package/type verification).
- Subscribe on the event Subject directly (ccCardActionClicked / onCardMessageReceived .subscribe) with ngOnDestroy cleanup, instead of the subscribeOn* helper methods — matching the rest of the Angular docs. - Correct the component class name to CometChatCardBubbleComponent in prose and tables (import examples were already correct). - State fallback behavior per surface (developer / agent / streaming) rather than a single "every surface" order. - Agent no-elements fallback is getAssistantMessageData().getText(). - Clarify payload serialization (objects via JSON.stringify; an already-string payload passes through unchanged). Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
8c6fbd6 to
7ecd83c
Compare
…nent - campaigns.mdx: how campaigns deliver card notifications via the in-app feed - components/notification-feed.mdx: CometChatNotificationFeedComponent reference (inputs/outputs, template slots, style, filtering, automatic behaviors) - docs.json: register both pages in the Angular nav Modeled on the React campaigns docs but aligned to the Angular implementation (cometchat-team/uikit-angular#517): (itemClick)/(actionClick)/(backClick) outputs, TemplateRef slots, style input, scrollToItemId; no compound sub-components, hook, itemView, or mark-all-read. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Render-only Card Message support in the Angular UIKit.
Description
Related Issue(s)
Type of Change
Checklist
Additional Information
Screenshots (if applicable)