Utility
Terminal
Installation
$ pnpm dlx shadcn@latest add @termcn/ink/toggle
Usage
import { Toggle } from "@/components/ui/toggle";<Toggle checked={enabled} onChange={setEnabled} label="Dark mode" />API Reference
Toggle
| Prop | Type | Default |
|---|---|---|
checked | boolean | - |
onChange | (checked: boolean) => void | - |
label | string | - |
onLabel | string | "ON" |
offLabel | string | "OFF" |
id | string | - |
disabled | boolean | false |
checkedIcon | string | "●" |
uncheckedIcon | string | "○" |
borderStyle | "single" | "double" | "round" | "bold" | "singleDouble" | "doubleSingle" | "classic" | "round" |
paddingX | number | 1 |
Notes
Accessibility
termcn exposes the following behavior through Ink's terminal accessibility APIs. This is not a browser ARIA or general WCAG-conformance claim.
- Keyboard: Arrow keys move inside the composite;
Home/Endselect the first or last enabled item;Enter/Spaceactivate, select, or toggle;Escapecancels or closes an owned surface;Tab/Shift+Tabmove between termcn/Ink focus targets. - Focus and composition: Input is active only while the component's focus target is focused, enabled, active, and inside the topmost focus scope.
- Screen reader: Ink labels and semantic state expose the component without relying on visual styling alone.