# Display components

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

<!-- interactive demo: gen-ui-tool-based -->

## What is this? [#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.

<Tabs items={['page.tsx', 'chart.tsx']}>
  <Tab value="page.tsx">
  ```tsx
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
});

````
</Tab>
<Tab value="chart.tsx">
```tsx
import { z } from "zod";
import { ResponsiveContainer, BarChart, XAxis, YAxis, Tooltip, Bar } from "recharts";

export const ChartProps = z.object({
  title: z.string(),
  data: z.array(z.object({ label: z.string(), value: z.number() })),
});

export function Chart({ title, data }: z.infer<typeof ChartProps>) {
  return (
    <div>
      <h3>{title}</h3>
      <ResponsiveContainer width="100%" height={300}>
        <BarChart data={data}>
          <XAxis dataKey="label" /><YAxis /><Tooltip />
          <Bar dataKey="value" fill="#6366f1" />
        </BarChart>
      </ResponsiveContainer>
    </div>
  );
}
````

  </Tab>
</Tabs>

## When should I use this? [#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 [#how-it-works-in-code]

<Steps>
  <Step>
    ### Nothing to wire on the agent

    AG2's AG-UI stream surfaces frontend-registered tools to the model on every
    run, so the agent declares none of its own. A component registered with
    `useComponent` reaches the model through the AG-UI request payload, and the
    model calls it by name. Leave `tools` empty when the only tools in play
    are frontend ones.

    ```python title="src/agents/chart_agent.py"
    from ag2 import Agent
    from ag2.ag_ui import AGUIStream
    from ag2.config import OpenAIResponsesConfig

    chart_agent = Agent(
        name="chart_agent",
        prompt=SYSTEM_PROMPT,
        config=OpenAIResponsesConfig(model="gpt-6-luna"),
        tools=[],
    )

    chart_stream = AGUIStream(chart_agent)
    ```

  </Step>
  <Step>
    ### 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 `prompt` and say what it is for.

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

  </Step>
</Steps>

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.

```typescript title="src/app/demos/gen-ui-tool-based/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 [#without-parameters]

For simple components that don't need typed parameters, leave out
`parameters`. The component then accepts any props:

```tsx
useComponent({
  name: "showGreeting",
  render: ({ message }: { message: string }) => (
    <div className="rounded border p-3 bg-blue-50">
      <p>{message}</p>
    </div>
  ),
});
```

## Scoping to an agent [#scoping-to-an-agent]

In multi-agent setups, pass `agentId` to scope a component to one agent:

```tsx
useComponent({
  name: "renderProfile",
  parameters: z.object({ userId: z.string() }),
  render: ProfileCard,
  agentId: "support-agent",
});
```

<IntegrationGrid path="render-only" />
