Skip to content
Agent UI
PrimitivesCancelledBadge

Cancelled Badge

Inline notice that marks a response the user cancelled.

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

tsx

Installation

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

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

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 { CancelledBadge } from "@agent-ui/react";
 
<CancelledBadge message="Response cancelled" />

API reference

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

API reference for this component
NameTypeDefaultDescription
messagestring"Response cancelled"Badge copy.
classNamestring—Inherits every native div attribute, including id, aria-*, data-*, onClick, and style.
Use it with the rest of the library

CancelledBadge 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