Collaborative Document Bubble

AI Integration Quick Reference

Field	Value
Component	`CometChatCollaborativeDocumentBubble`
Package	`@cometchat/chat-uikit-react`
Import	`import { CometChatCollaborativeDocumentBubble } from "@cometchat/chat-uikit-react";`
CSS root class	`.cometchat-collaborative-bubble`
Primary output	`onButtonClick: (url: string) => void` — opens the document URL (defaults to `window.open`)
Prerequisites	App wrapped in `CometChatProvider` with valid credentials + a logged-in user; plus the Collaborative Document extension enabled in the Dashboard
Stitching	None — self-extracting from the SDK message
Full props	See Props

Overview

CometChatCollaborativeDocumentBubble renders a collaborative document card — a banner image, a title, a subtitle, and an “Open Document” button. It is self-extracting: pass the SDK message and the bubble reads the document URL from the message’s extension metadata (@injected.extensions.document.document_url), so it works standalone. Clicking the button opens the document (by default in a new window).

Requires the Collaborative Document extension enabled in the CometChat Dashboard. Document messages (extension_document) — and the injected document_url this bubble reads — are only produced once the extension is turned on for your app. Without it the composer cannot create documents and this bubble never renders. See the Collaborative Document guide to enable it, and the Plugins overview for how the UI Kit auto-routes document messages to this bubble.

Live Preview — interact with the collaborative document bubble.Open in Storybook ↗

Usage

import { CometChat } from "@cometchat/chat-sdk-javascript";
import { CometChatCollaborativeDocumentBubble } from "@cometchat/chat-uikit-react";

function DocumentMessage({ message }: { message: CometChat.BaseMessage }) {
  return <CometChatCollaborativeDocumentBubble message={message} />;
}

Props

message

The collaborative-document message. The bubble extracts the URL from its metadata. Required.


Type	`CometChat.BaseMessage`
Required	Yes

alignment

Override incoming/outgoing alignment. Defaults to sender-vs-logged-in-user.


Type	`"left" \| "right"`
Default	derived

onButtonClick

Click handler for the action button. Receives the document URL. Defaults to window.open.


Type	`(url: string) => void`
Default	`window.open`

disabled

Disable the action button (e.g. for a thread header preview).


Type	`boolean`
Default	`false`

className

Additional CSS class applied to the root element.


Type	`string`
Default	`undefined`

CSS Selectors

Target	Selector
Root	`.cometchat-collaborative-bubble`
Document modifier	`.cometchat-collaborative-bubble--document`
Incoming / outgoing	`.cometchat-collaborative-bubble--incoming` / `.cometchat-collaborative-bubble--outgoing`
Banner image	`.cometchat-collaborative-bubble__banner-image`
Title	`.cometchat-collaborative-bubble__body-content-name`
Subtitle	`.cometchat-collaborative-bubble__body-content-description`
Open button	`.cometchat-collaborative-bubble__button`

Next Steps

Collaborative Document Plugin

Plugin behavior, context menu, and conversation preview

Enable Collaborative Document (Dashboard)

Turn on the extension that produces these messages

Collaborative Whiteboard Bubble

Render collaborative whiteboard messages

Message Bubble

The wrapper that hosts bubble content

Theming

Customize colors, fonts, and spacing

​Overview

​Usage

​Props

​message

​alignment

​onButtonClick

​disabled

​className

​CSS Selectors

​Next Steps

Collaborative Document Plugin

Enable Collaborative Document (Dashboard)

Collaborative Whiteboard Bubble

Message Bubble

Theming

Overview

Usage

Props

message

alignment

onButtonClick

disabled

className

CSS Selectors

Next Steps