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
Take the forwarded tools off the Flow's state
A Flow owns its own model call, so unlike a chat agent it has to hand the
forwarded tools to the model itself. Type the Flow on CopilotKitState and
read state.copilotkit.actions — that is where a tool registered with
useFrontendTool or a component registered with useComponent arrives.
from crewai.flow.flow import Flow, start
from litellm import acompletion
from ag_ui_crewai import CopilotKitState, copilotkit_stream
class ChartFlow(Flow[CopilotKitState]):
@start()
async def chat(self) -> None:
actions = self.state.copilotkit.actions or None
response = await copilotkit_stream(
await acompletion(
model="openai/gpt-6-luna",
messages=[
{"role": "system", "content": SYSTEM_PROMPT},
*self.state.messages,
],
tools=actions,
parallel_tool_calls=False,
stream=True,
)
)
self.state.messages.append(response.choices[0].message)Wrap the call in copilotkit_stream so the tool call reaches the browser as
it streams. A Flow that returns only when the model is finished renders
nothing until the turn ends.
Decide when the component is required
The Flow controls tool_choice, which is the lever a chat agent does not
have. Forcing the call on the user's turn and leaving it on auto
afterwards is what renders the component immediately and still lets the run
end: the follow-up turn is plain narration once the browser has returned the
result.
on_user_turn = bool(
self.state.messages and self.state.messages[-1].get("role") == "user"
)
tool_choice = "required" if actions and on_user_turn else "auto"Leaving tool_choice on auto for every turn is the usual reason a Flow
answers in prose and the component never appears.
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?