Display components
Register React components that your agent can render in the chat.
What is this?
A display component is a React component that your agent can call as a tool. When the agent calls the tool, CopilotKit renders your component directly in the chat with the tool's arguments as props. You do not write a handler, and the user does not need to do anything.
import { useComponent } from "@copilotkit/react-core/v2";
import { Chart, ChartProps } from "./chart";
useComponent({
name: "showChart",
description: "Populate data and show the user a chart",
parameters: ChartProps,
render: Chart
});
When should I use this?
Use a display component when you want to:
- Display rich UI (cards, charts, tables) inline in the chat
- Show structured data from agent responses
- Render previews, status indicators, or visual feedback
- Let the agent present information beyond plain text
How it works in code
Nothing to wire on the agent
The AG-UI hosting layer merges the request's tool definitions into the tool
list the model sees, so the agent declares none of its own. A tool
registered with useFrontendTool, or a component registered with
useComponent, reaches the model by name. Leave tools empty when the
only tools in play are frontend ones.
using Microsoft.Agents.AI;
using Microsoft.Extensions.AI;
public AIAgent CreateChartAgent()
{
return new ChatClientAgent(
_openAiClient.GetChatClient("gpt-6-luna").AsIChatClient(),
name: "ChartAgent",
instructions: SystemPrompt,
tools: []);
}Tell the model when to call it
This is the part that is easy to miss. The tool arrives on every run, but a
model with no instruction about it will answer in prose and never call it.
Name the tool in instructions and say what it is for.
private const string SystemPrompt = """
You are a data visualization assistant.
When the user asks for a chart, call render_bar_chart with a concise
title, description, and data array of {label, value} items.
Keep final chat responses brief.
""";The display component receives the tool's arguments as typed props and mounts inline in the chat. Below is the bar chart from the demo. The agent sends the data, and the component draws it.
useComponent({
name: "render_bar_chart",
description: "Display a bar chart with labeled numeric values.",
parameters: barChartPropsSchema,
render: BarChart,
});Ask the agent for a chart, for example Show me a bar chart of quarterly sales for Q1, Q2, Q3, Q4. The chart renders in the chat with the data
that the agent filled in.
Without parameters
For simple components that don't need typed parameters, leave out
parameters. The component then accepts any props:
useComponent({
name: "showGreeting",
render: ({ message }: { message: string }) => (
<div className="rounded border p-3 bg-blue-50">
<p>{message}</p>
</div>
),
});Scoping to an agent
In multi-agent setups, pass agentId to scope a component to one agent:
useComponent({
name: "renderProfile",
parameters: z.object({ userId: z.string() }),
render: ProfileCard,
agentId: "support-agent",
});How is this guide?