Switch
Native checkbox with switch semantics and focus styles. Import from @agent-ui/react or a direct subpath. Tailwind CSS v4 theme tokens are required.
Switch ships with a full API table, a copyable example, and accessibility notes.
Installation
Install the package once, then import Switch from its direct entry point or from the root.
pnpm add @agent-ui/reactimport { Switch } from "@agent-ui/react/switch";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.
import { Switch } from "@agent-ui/react"; <label><Switch defaultChecked /> Stream responses</label>API reference
Every prop Switch accepts, its type, default, and behaviour.
| Name | Type | Default | Description |
|---|---|---|---|
| checked | boolean | — | Configuration exposed through the component's public React props. |
| defaultChecked | boolean | — | Configuration exposed through the component's public React props. |
| onChange | (next: unknown) => void | — | Controlled state change callback. |
| disabled | boolean | — | Configuration exposed through the component's public React props. |
Accessibility
Switch 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