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

Switch

Copy Markdown

A switch for toggling a binary state.

DocsAPI

PreviewCode

Airplane mode

Installation#

CLIManual

pnpmbunnpmyarn

pnpm dlx shadcn@latest add @shark/switch

Usage#

import { Switch } from "@/components/ui/switch";

<Switch />

Controlled#

Use the checked and onCheckedChange props to control the switch state programmatically.

PreviewCode

Enable notifications

❌

States#

Invalid#

Use the invalid prop on the Field or in the Switch component to mark the switch as invalid.

PreviewCode

Accept terms and conditions

Examples#

Disabled#

Use the disabled prop to disable the switch.

PreviewCode

Marketing emails

With Description#

Use FieldDescription to add a description to the switch.

PreviewCode

Share across devices

Focus is shared across devices, and turns off when you leave the app.

Card Style#

Use a card-style layout with the switch for a more prominent display.

PreviewCode

Enable notifications

You can enable or disable notifications at any time.

Form Integration#

Integrate the switch into a form with proper validation and error handling.

PreviewCode

Terms and conditions

Please read the terms and conditions carefully.

I agree to the terms

SubmitReset

Customizing Size#

The switch size is controlled by the [--size-*] CSS variable.

PreviewCode

API Reference#

Switch#

Toggle switch for on/off state. Use with a form control.

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

[

Previous page

Steps ](/docs/components/steps)[

Next page

Table ](/docs/components/table)

On This Page

InstallationUsageControlledStatesInvalidExamplesDisabledWith DescriptionCard StyleForm IntegrationCustomizing SizeAPI ReferenceSwitch