# 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>
    ### Install the LangGraph Python SDK

    <InstallPythonSDK />

  </Step>
  <Step>
    ### Wire CopilotKit middleware into your graph

    Frontend tools registered with `useFrontendTool` are forwarded to your
    agent at runtime. `CopilotKitMiddleware` is the bridge — drop it into
    `create_agent`'s `middleware` list and the LLM sees the forwarded tool
    definitions on every turn.

~~~~python title="frontend_tools.py"
from langchain.agents import create_agent
from langchain_openai import ChatOpenAI
from copilotkit import CopilotKitMiddleware

graph = create_agent(
    model=ChatOpenAI(reasoning_effort="none", model="gpt-6-luna"),
    tools=[],
    middleware=[CopilotKitMiddleware()],
    system_prompt="You are a helpful, concise assistant.",
)
~~~~

  </Step>
  <Step>
    ### Using a custom graph instead of `create_agent`

    `CopilotKitMiddleware` only works with `create_agent`. In a graph where you
    define the nodes and edges yourself, the forwarded tools sit in
    `state["copilotkit"]["actions"]`, and the model can call them only after
    you bind them. Inherit your state from `CopilotKitState`:

    ```python title="agent.py"
    from copilotkit import CopilotKitState

    class AgentState(CopilotKitState):
        pass
    ```

    Then bind the actions to the model in your agent node:

    ```python title="agent.py"
    from langchain_core.runnables import RunnableConfig
    from langchain_openai import ChatOpenAI

    async def agent_node(state: AgentState, config: RunnableConfig):
        # Access the tools from the copilotkit property
        tools = state.get("copilotkit", {}).get("actions", [])
        model = ChatOpenAI(model="gpt-6-luna", reasoning_effort="none").bind_tools(tools)

        # ...
    ```

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