# 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>
    ### 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.

    ```python title="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.

  </Step>
  <Step>
    ### 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.

  </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" />
