Toggle

Switches a single button between pressed and unpressed states.

Installation

Install Toggle from Oros with shadcn CLI 4.13.0.

pnpm dlx shadcn@4.13.0 add @oros/toggle

Usage

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

Open the Source tab in the preview for a complete working example.

Anatomy

Export	Responsibility
Toggle	The root component that owns the primary structure and state.
toggleVariants	Returns the component's class variants for compatible compositions.

API Reference

Toggle exports 2 named entries. Component exports accept the props of their underlying HTML element or Base UI component, plus an optional className, unless the source defines a more focused type.

Toggle Component
toggleVariants Utility

Accessibility

Provide Toggle with a visible label or an equivalent programmatic accessible name.
Expose disabled, required, selected, and invalid states through the component API instead of color alone, and keep keyboard focus visible.

Source

Toggle uses the standard shadcn API and is distributed through Oros. Installing it adds the component source and required dependencies to your app. The Source tab above shows a complete usage example.

Textarea Toggle Group