Skip to content
Agent UI
Compose primitivesToolButton

Tool Button

Icon-only round button with active state and accessible label.

ToolButton ships with a full API table, a copyable example, and accessibility notes.

tsx

Installation

Install the package once, then import ToolButton from its direct entry point or from the root.

bash
pnpm add @agent-ui/react
tsx
import { ToolButton } from "@agent-ui/react";

Tailwind CSS v4 users: add @source "../node_modules/@agent-ui/react/src" to the global stylesheet so the library utilities are generated.

Usage

The example below is the same code that renders the preview. Copy it, swap in your own handlers, and ship.

tsx
import { ToolButton } from "@agent-ui/react";
 
<ToolButton label="Attach file"><Paperclip /></ToolButton>

API reference

Every prop ToolButton accepts, its type, default, and behaviour.

API reference for this component
NameTypeDefaultDescription
labelstring—Accessible name.
activebooleanfalsePressed styling and aria-pressed.
classNamestring—Merged with the round button recipe.
Use it with the rest of the library

ToolButton composes with MessageList, ChatShell, useChat, and the provider compose blocks. Browse the full reference or see all components in the gallery.

3 lines · copy-ready