Toggle

Overview

Copy the source into your project, then import the parts you need. Styles use local StyleX declarations and shared theme tokens. You can change the source without wrapping or replacing a package.

Installation

Run bunx @yopem-ui/cli init from your project root first. The CLI configures StyleX and installs shared files and dependencies.

bunx @yopem-ui/cli init

bunx @yopem-ui/cli add toggle

Run from your project root. The CLI installs required components, shared files, and packages. Previews may need additional components. Existing files are preserved. To refresh installed source, use update; locally edited files need an explicit --force to overwrite.

bunx @yopem-ui/cli update toggle

Preview

import { Toggle } from "@registry/components/ui/toggle"

export function Preview() {
  return <Toggle>Toggle</Toggle>
}

Usage

Use Toggle for a pressed or unpressed action such as bold formatting.

Use pressed and onPressedChange for controlled state. A toggle is not a checkbox replacement when collecting form data.

Import from the local file installed by the CLI.

"use client"

import { Toggle } from "@/components/ui/toggle"

export function Preview() {
  return <Toggle aria-label="Bold">Bold</Toggle>
}

API reference

Generated from canonical TypeScript source. Only component and Base UI props appear below. Required marks a required property, not a required component.