# Toggle

Toggle/switch component with on/off labels



<ComponentPreview base="ink" name="toggle-demo" />

Installation [#installation]

<CodeTabs>
  <TabsList>
    <TabsTrigger value="cli">
      Command
    </TabsTrigger>

    <TabsTrigger value="manual">
      Manual
    </TabsTrigger>
  </TabsList>

  <TabsContent value="cli">
    ```bash
    npx shadcn@latest add @termcn/ink/toggle
    ```
  </TabsContent>

  <TabsContent value="manual">
    <Steps>
      <Step>
        Install the following dependencies:
      </Step>

      ```bash
      npm install ink
      ```

      <Step>
        Copy and paste the following code into your project.
      </Step>

      <ComponentSource src="registry/bases/ink/ui/types.ts" title="components/ui/types.ts" />

      <ComponentSource src="registry/bases/ink/themes/default.ts" title="lib/terminal-themes/default.ts" />

      <ComponentSource src="registry/bases/ink/hooks/use-theme.ts" title="hooks/use-theme.ts" />

      <ComponentSource src="registry/bases/ink/hooks/use-unicode.ts" title="hooks/use-unicode.ts" />

      <ComponentSource src="registry/bases/ink/hooks/use-interaction.tsx" title="hooks/use-interaction.tsx" />

      <ComponentSource src="registry/bases/ink/lib/terminal-style.ts" title="lib/terminal-style.ts" />

      <ComponentSource src="registry/bases/ink/lib/terminal-symbols.ts" title="lib/terminal-symbols.ts" />

      <ComponentSource base="ink" name="toggle" title="components/ui/toggle.tsx" />

      <Step>
        Update the import paths to match your project setup.
      </Step>
    </Steps>
  </TabsContent>
</CodeTabs>

Usage [#usage]

```tsx
import { Toggle } from "@/components/ui/toggle";
```

```tsx
<Toggle checked={enabled} onChange={setEnabled} label="Dark mode" />
```

API Reference [#api-reference]

Toggle [#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 [#notes]

Accessibility [#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` / `End` select the first or last enabled item; `Enter` / `Space` activate, select, or toggle; `Escape` cancels or closes an owned surface; `Tab` / `Shift+Tab` move 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.