Skip to content
UI
On this page

Switch

Provides a switch with two states.

Overview

Copy the source into your project. Import the parts that you need. Styles use local StyleX declarations and shared theme tokens. You can change the source without a wrapper or replacement package.

Preview

Labeled on/off switch

Installation

Run the init command from your project root first. The CLI configures StyleX and installs shared files and dependencies.

Run from your project root. The CLI installs required components, shared files, and packages. Previews may need additional components. The CLI keeps existing files.

Usage

Use Switch for a setting that takes effect immediately.

Pair it with a label that describes the setting, not the current state. checked and onCheckedChange control the state. defaultChecked supplies the initial state.

The track is 37px by 18px with an 8px thumb. It uses blue when checked and neutral colors when off. The coarse-pointer target is at least 44px.

Import from the local file installed by the CLI.

API reference

The generator reads the component TypeScript source. Only component and Base UI props appear below. The Required column shows whether you must supply a property. It does not mean you must use the component.

View API reference