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

Add a stub for each frontend tool

The LlamaIndex AG-UI router (llama_index.protocols.ag_ui) gives the model only the tools you pass to get_ag_ui_workflow_router. It does not read the tool list CopilotKit sends with each run. So a tool registered with useFrontendTool, useComponent, or useHumanInTheLoop reaches the model only when frontend_tools holds a stub with the same name and arguments.

agent.py
from typing import Annotated

from llama_index.llms.openai import OpenAI
from llama_index.protocols.ag_ui.router import get_ag_ui_workflow_router


def change_background(
    background: Annotated[str, "CSS background value. Prefer gradients."],
) -> str:
    """Change the background color/gradient of the chat area."""
    return f"Background changed to {background}"


agentic_chat_router = get_ag_ui_workflow_router(
    llm=OpenAI(model="gpt-6-luna"),
    frontend_tools=[change_background],
    system_prompt=(
        "You are a helpful assistant. "
        "Change the UI background when asked (via frontend tool)."
    ),
)

The browser runs the tool, so the stub body is never called. A missing stub fails quietly: the model never sees the tool and answers in prose.

Tell the model when to call it

Even with the stub in place, a model with no instruction about the tool tends to answer in prose. Name the tool in system_prompt and say what it is for.

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?