Display components
Register React components that your agent can render in the chat.
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
Install the CopilotKit LangGraph SDK
npm install @copilotkit/sdk-jsWire CopilotKit state + tools into your graph
Frontend tools registered with useFrontendTool arrive on the agent's
state at state.copilotkit.actions. Use CopilotKitStateAnnotation to
expose that channel on your graph, then call
convertActionsToDynamicStructuredTools(...) inside your chat node to
bind the LLM to those actions.
import type { RunnableConfig } from "@langchain/core/runnables";
import { SystemMessage } from "@langchain/core/messages";
import { MemorySaver, START, StateGraph } from "@langchain/langgraph";
import { ChatOpenAI } from "@langchain/openai";
import {
convertActionsToDynamicStructuredTools,
CopilotKitStateAnnotation,
} from "@copilotkit/sdk-js/langgraph";
// CopilotKit forwards frontend tools to the agent via
// `state.copilotkit.actions`. `CopilotKitStateAnnotation` adds that
// channel to your graph's state; `convertActionsToDynamicStructuredTools`
// turns the forwarded action schemas into LangChain tools you can bind
// at model-invocation time.
const AgentStateAnnotation = CopilotKitStateAnnotation;
export type AgentState = typeof AgentStateAnnotation.State;
const SYSTEM_PROMPT = "You are a helpful, concise assistant.";
async function runChatNode(
state: AgentState,
config: RunnableConfig,
model: ChatOpenAI,
) {
const modelWithTools = model.bindTools!([
...convertActionsToDynamicStructuredTools(state.copilotkit?.actions ?? []),
]);
const response = await modelWithTools.invoke(
[new SystemMessage({ content: SYSTEM_PROMPT }), ...state.messages],
config,
);
return { messages: response };
}
async function chatNode(state: AgentState, config: RunnableConfig) {
return runChatNode(
state,
config,
new ChatOpenAI({
modelKwargs: { reasoning_effort: "none" },
temperature: 0,
model: "gpt-6-luna",
}),
);
}
function compileGraph(node: typeof chatNode) {
return new StateGraph(AgentStateAnnotation)
.addNode("chat_node", node)
.addEdge(START, "chat_node")
.addEdge("chat_node", "__end__")
.compile({ checkpointer: new MemorySaver() });
}
export const graph = compileGraph(chatNode);Call a frontend tool from a node with no model
A node does not need a model to call a frontend tool. Return an
AIMessage with a tool_calls entry. This example calls the
change_background tool that the frontend above registers. When the run
ends, CopilotKit runs the matching useFrontendTool handler in the
browser. Then it starts a follow-up run with the result as a
ToolMessage. Route that run to a node that reads the result, so the
graph does not call the tool again:
import { randomUUID } from "node:crypto";
import { AIMessage, ToolMessage } from "@langchain/core/messages";
import { END, START, StateGraph } from "@langchain/langgraph";
import { CopilotKitStateAnnotation } from "@copilotkit/sdk-js/langgraph";
type AgentState = typeof CopilotKitStateAnnotation.State;
// Ask the frontend to run `change_background`. No model call.
async function requestBackground(state: AgentState) {
return {
messages: [
new AIMessage({
content: "",
tool_calls: [
{
id: randomUUID(),
name: "change_background",
args: { background: "linear-gradient(135deg, #1e3a8a, #9333ea)" },
type: "tool_call",
},
],
}),
],
};
}
// Runs on the follow-up run, after the frontend returns the tool result.
async function confirm(state: AgentState) {
const result = state.messages.at(-1);
return {
messages: [new AIMessage(`The frontend returned: ${result?.content}`)],
};
}
export const graph = new StateGraph(CopilotKitStateAnnotation)
.addNode("request_background", requestBackground)
.addNode("confirm", confirm)
.addConditionalEdges(START, (state: AgentState) => {
const last = state.messages.at(-1);
return last && ToolMessage.isInstance(last)
? "confirm"
: "request_background";
})
.addEdge("request_background", END)
.addEdge("confirm", END)
.compile();The tool call must be in the graph state. copilotkitEmitToolCall alone
only streams the call. At the end of the run, the messages from the graph
state replace the streamed ones, so the handler never runs.
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.
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?