# Toggle

Toggle/switch component with on/off labels



<ComponentPreview base="opentui" 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/opentui-toggle
    ```
  </TabsContent>

  <TabsContent value="manual">
    <Steps>
      <Step>
        Copy and paste the following code into your project.
      </Step>

      <ComponentSource base="opentui" 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`       |