---
title: Switch
description: A control that indicates whether a setting is on or off.

links:
  doc: https://base-ui.com/react/components/switch#api-reference
---

## Preview

<ComponentPreview name="p-switch-1" />

## Installation

<CodeTabs>

<TabsList>
  <TabsTab value="cli">CLI</TabsTab>
  <TabsTab value="manual">Manual</TabsTab>
</TabsList>
<TabsPanel value="cli">

```bash
npx @olyx/cli@latest add switch
```

</TabsPanel>

<TabsPanel value="manual">

<Steps>

<Step>Install the following dependencies:</Step>

```bash
npm install @base-ui/react
```

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

<ComponentSource name="switch" title="components/ui/switch.tsx" />

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

</Steps>

</TabsPanel>

</CodeTabs>

## Usage

```tsx
import { Switch } from "@/components/ui/switch"
```

```tsx
<Switch />
```

## API Reference

### Switch

Styled wrapper for `Switch.Root` from Base UI with built-in thumb. Size is controlled via the `--track-size` CSS variable.

## Examples

For accessible labelling and validation, prefer using the `Field` component to wrap checkboxes. See the related example: [Switch field](/ui/docs/components/field#switch-field).

### Disabled

<ComponentPreview name="p-switch-2" />

### With Description

<ComponentPreview name="p-switch-3" />

### Customizing Size

The switch size is controlled by the `--track-size` CSS variable. By default, the switch uses `36px`. You can customize the size by overriding this CSS variable on the component using inline styles or a custom class.

<ComponentPreview name="p-switch-6" />

### Card Style

<ComponentPreview name="p-switch-4" />

### Form Integration

<ComponentPreview name="p-switch-5" />