examples/v2/docs/reference/copilot-chat-assistant-message.mdx
CopilotChatAssistantMessage is the default component used by CopilotChatMessageView to render AI assistant responses. It handles markdown rendering, feedback collection, and tool call display.
The CopilotChatAssistantMessage component:
CopilotChatAssistantMessage provides slots for customizing each part of the message:
graph LR
AM[CopilotChatAssistantMessage] --> markdownRenderer
AM --> toolbar
AM --> copyButton
AM --> thumbsUpButton
AM --> thumbsDownButton
AM --> readAloudButton
AM --> regenerateButton
AM --> toolCallsView
| Slot | Description |
|---|---|
markdownRenderer | Renders the message content with markdown support |
toolbar | Container for action buttons |
copyButton | Button to copy message content |
thumbsUpButton | Positive feedback button |
thumbsDownButton | Negative feedback button |
readAloudButton | Text-to-speech button |
regenerateButton | Button to regenerate the response |
toolCallsView | Renders tool call executions |
Customize assistant messages through the messageView.assistantMessage slot on CopilotChat:
<CopilotChat
messageView={{
assistantMessage: {
className: "bg-slate-50 rounded-xl p-4",
onThumbsUp: (message) => trackFeedback(message.id, "positive"),
onThumbsDown: (message) => trackFeedback(message.id, "negative"),
},
}}
/>
CopilotChatAssistantMessage provides callbacks for user feedback:
<CopilotChat
messageView={{
assistantMessage: {
onThumbsUp: (message) => {
analytics.track("positive_feedback", {
messageId: message.id,
content: message.content,
});
},
onThumbsDown: (message) => {
analytics.track("negative_feedback", {
messageId: message.id,
content: message.content,
});
},
onRegenerate: (message) => {
console.log("Regenerating:", message.id);
},
onReadAloud: (message) => {
speechSynthesis.speak(new SpeechSynthesisUtterance(message.content));
},
},
}}
/>
| Callback | Signature | Description |
|---|---|---|
onThumbsUp | (message: AssistantMessage) => void | Called when user clicks thumbs up |
onThumbsDown | (message: AssistantMessage) => void | Called when user clicks thumbs down |
onRegenerate | (message: AssistantMessage) => void | Called when user requests regeneration |
onReadAloud | (message: AssistantMessage) => void | Called when user clicks read aloud |
CopilotChatAssistantMessage uses the slot system. Each slot accepts four types of values:
Control visibility and styling of the toolbar:
<CopilotChat
messageView={{
assistantMessage: {
toolbar: "bg-gray-50 rounded-lg p-2",
},
}}
/>
To hide the entire toolbar:
<CopilotChat
messageView={{
assistantMessage: {
toolbarVisible: false,
},
}}
/>
Customize specific toolbar buttons:
<CopilotChat
messageView={{
assistantMessage: {
copyButton: "text-blue-500 hover:text-blue-700",
thumbsUpButton: "text-green-500 hover:text-green-700",
thumbsDownButton: "text-red-500 hover:text-red-700",
readAloudButton: "text-purple-500 hover:text-purple-700",
regenerateButton: "text-orange-500 hover:text-orange-700",
},
}}
/>
Hide buttons by returning null:
<CopilotChat
messageView={{
assistantMessage: {
readAloudButton: () => null,
regenerateButton: () => null,
},
}}
/>
Note: thumbsUpButton and thumbsDownButton only show when their respective callbacks (onThumbsUp, onThumbsDown) are provided.
Customize how message content is rendered:
<CopilotChat
messageView={{
assistantMessage: {
markdownRenderer: {
className: "prose prose-lg dark:prose-invert",
},
},
}}
/>
Customize how tool executions are displayed:
<CopilotChat
messageView={{
assistantMessage: {
toolCallsView: "bg-gray-100 rounded-lg p-3",
},
}}
/>
To completely replace the assistant message component:
import { CopilotChatAssistantMessage } from "@copilotkit/react-core";
function CustomAssistantMessage({ message, isRunning, ...props }) {
return (
<div className="flex gap-3 items-start">
<Avatar src="/ai-avatar.png" />
<div className="flex-1">
<CopilotChatAssistantMessage
message={message}
isRunning={isRunning}
className="bg-white shadow-sm rounded-xl p-4"
{...props}
/>
</div>
</div>
);
}
<CopilotChat
messageView={{
assistantMessage: CustomAssistantMessage,
}}
/>;
For full layout control, use the children render function:
function CustomAssistantMessage(props) {
return (
<CopilotChatAssistantMessage {...props}>
{({ markdownRenderer, toolbar, toolCallsView, message }) => (
<div className="flex gap-4 p-4 bg-gradient-to-r from-blue-50 to-purple-50 rounded-xl">
<div className="flex-1">
<div className="text-sm text-gray-500 mb-1">AI Assistant</div>
{markdownRenderer}
{toolCallsView}
<div className="mt-2 border-t pt-2">{toolbar}</div>
</div>
</div>
)}
</CopilotChatAssistantMessage>
);
}
<CopilotChat
messageView={{
assistantMessage: CustomAssistantMessage,
}}
/>;
The render function receives:
| Property | Type | Description |
|---|---|---|
markdownRenderer | ReactElement | The rendered markdown content |
toolbar | ReactElement | The action buttons toolbar |
toolCallsView | ReactElement | Tool call display |
copyButton | ReactElement | Copy button |
thumbsUpButton | ReactElement | Thumbs up button |
thumbsDownButton | ReactElement | Thumbs down button |
readAloudButton | ReactElement | Read aloud button |
regenerateButton | ReactElement | Regenerate button |
message | AssistantMessage | The message data |
isRunning | boolean | Whether AI is generating |
toolbarVisible | boolean | Whether toolbar should show |
<CopilotChat
messageView={{
assistantMessage: {
onThumbsUp: (message) => {
analytics.track("ai_feedback", {
type: "positive",
messageId: message.id,
messageLength: message.content?.length,
timestamp: new Date().toISOString(),
});
},
onThumbsDown: (message) => {
analytics.track("ai_feedback", {
type: "negative",
messageId: message.id,
messageLength: message.content?.length,
timestamp: new Date().toISOString(),
});
},
},
}}
/>
Show only the copy button:
<CopilotChat
messageView={{
assistantMessage: {
thumbsUpButton: () => null,
thumbsDownButton: () => null,
readAloudButton: () => null,
regenerateButton: () => null,
},
}}
/>
<CopilotChat
messageView={{
assistantMessage: {
className: "bg-white shadow-md rounded-2xl p-6 border border-gray-100",
markdownRenderer: "prose prose-blue max-w-none",
toolbar: "mt-4 pt-4 border-t border-gray-100",
},
}}
/>