Display components

Register React components that your agent can render in the chat.

Tool-Based Generative UI

Waking up the demo

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

On every run the AG-UI Strands adapter registers a proxy tool in the agent's tool registry for each tool the request carries, so the agent declares none of its own. A component registered with useComponent reaches the model by name, and the browser executes the call.

src/agents/chart_agent.py
from strands import Agent
from strands.models.openai import OpenAIModel

from ag_ui_strands import StrandsAgent

strands_agent = Agent(
    model=OpenAIModel(model_id="gpt-6-luna"),
    system_prompt=SYSTEM_PROMPT,
    tools=[],
)

agui_agent = StrandsAgent(
    agent=strands_agent,
    name="chart_agent",
    description="Renders charts from data.",
)

A backend tool that already owns the name wins: the adapter never replaces a native tool with a proxy. Keep the useComponent name distinct from every tool in 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 system_prompt and say what it is for.

src/agents/chart_agent.py
SYSTEM_PROMPT = (
    "You are a data visualization assistant.\n"
    "When the user asks for a chart, call the frontend `render_bar_chart` "
    "tool with a concise title and a `data` array of `{label, value}` "
    "items.\n"
    "Keep chat responses brief and let the chart do the talking."
)

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.

page.tsx
  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?