Components

Toggle

Two-state button for toggling between on and off

Preview

Installation

Usage

Examples

Different Sizes

Display toggles in various sizes.

With Text

Include text labels within toggle buttons.

Outline Variant

Use outline styling for toggles.

Controlled

Manage toggle state externally.

Disabled State

Prevent interaction with disabled toggles.

API Reference

The Toggle component is built on top of Base UI's Toggle. All Base UI props are supported. The documentation below only covers custom props and modified defaults specific to our implementation.

For the complete Base UI API, see the Base UI Toggle documentation.

Custom Props

Prop