Sections

• Introduction
• Installation
• Styling
• Colors
• Forms
• Skills
• RTL
• LLMs.txt
• Changelog

Components

• Accordion
• Action Bar
• Alert Dialog
• Alert
• Announcement
• Aspect Ratio
• Autocomplete
• Avatar
• Badge
• Bottom Navigation
• Breadcrumb
• Button Group
• Button
• Calendar
• Card
• Carousel
• Chart
• Checkbox
• Circular Progress
• Circular Slider
• Clipboard
• Collapsible
• Color Picker
• Combobox
• Command
• Context Menu
• Data List
• Date InputNew
• Date Picker
• Dialog
• DrawerUpdated
• Editable
• Field
• File Upload
• FloatUpdated
• Floating Panel
• Frame
• Hint
• Hover Card
• Image Cropper
• Input Group
• Input OTP
• Input
• Item
• Kbd
• Link Overlay
• Listbox
• Marquee
• Menu
• Native Select
• Number Input
• Pagination
• Password Input
• Popover
• Progress
• Prose
• QR Code
• Radio Group
• Rating
• Resizable
• Scroll Area
• Segment Group
• Select
• Separator
• Sheet
• Sidebar
• Signature Pad
• Skeleton
• Skip Nav
• Slider
• Spinner
• StatusUpdated
• Steps
• Switch
• Table
• Tabs
• Tags Input
• Textarea
• Timer
• Toast
• Toggle Group
• Toggle Tooltip
• Toggle
• Tooltip
• Tour
• Tree View

Utilities

• Client Only
• Download Trigger
• Format
• Highlight
• Hitbox
• JSON Tree View
• Presence
• Show
• Swap

Forms

• Formisch
• React Hook Form
• TanStack Form

Hooks

• useIsMobile

Toggle

Copy Markdown

Two-state button that can be toggled on or off.

DocsAPI

PreviewCode

Toggle

Installation#

CLIManual

pnpmbunnpmyarn

pnpm dlx shadcn@latest add @shark/toggle

Usage#

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

<Toggle>
  <ToggleIndicator />
</Toggle>

Controlled#

Use the pressed and onPressedChange props to control the toggle state programmatically.

PreviewCode

Toggle

❌

States#

Disabled#

Use the disabled prop to disable the toggle.

PreviewCode

Disabled

Variants#

Default#

PreviewCode

Toggle

Outline#

PreviewCode

Toggle

Sizes#

Small#

PreviewCode

Small

Medium#

PreviewCode

Medium

Large#

PreviewCode

Large

Examples#

Icon Group#

Use multiple toggles with icons for toolbar-style controls.

PreviewCode

API Reference#

Toggle#

Toggle button for on/off or selected state. Use asChild for custom elements.

ToggleIndicator#

Icon or indicator shown when toggle is active. Omitted when used as child.

For a complete list of props, see the Ark UI documentation.

[

Previous page

Toggle Tooltip ](/docs/components/toggle-tooltip)[

Next page

Tooltip ](/docs/components/tooltip)

On This Page

InstallationUsageControlledStatesDisabledVariantsDefaultOutlineSizesSmallMediumLargeExamplesIcon GroupAPI ReferenceToggleToggleIndicator