Inputs & controlsstable

    Switch

    A component for displaying switches.

    Follow the installation and quick start below to use Switch in your project, or read the complete setup guide.

    Accessible by designLight & darkCopy. Customize. Ship.
    On this page
    Live previewFluid
    Interactive exampleReact / TypeScript / Tailwind CSS
    ADD TO YOUR PROJECT

    Installation

    1. Initialize once

    Run from an existing React project with Node.js 18 or later. Skip this step if the project already has u-lib.json. Initialization copies the shared stylesheet and adds its import to your application entry.

    npx @scriptwithahmad/u-lib@0.2.2 init

    2. Add Switch and example components

    This command includes the UI components used by this page's usage examples. The CLI copies editable source into your components directory and installs each component's dependencies. Existing source files are preserved.

    npx @scriptwithahmad/u-lib@0.2.2 add switch label

    Choose the tab for your package manager. Yarn commands require modern Yarn; Yarn Classic users can use npx. Use --dry-run to preview changes. See the installation guide for custom paths, JavaScript output and package-import alternatives.

    USE IN YOUR APP

    Quick start

    Copy this example into src/Example.tsx (or Example.tsx at the project root when you do not use src). Imports assume the default CLI paths. From a nested file such as src/app/page.tsx, adjust ./components to ../components. Keep the client directive in Next.js when using state or event handlers.

    switch-example.tsx
    "use client";
    
    import { Switch } from "./components/ui/switch";
    
    export default function UsageDemo() {
      return (
        <>
    <Switch onCheckedChange={(checked) => console.log(checked)} />
        </>
      );
    }

    Provide a visible label or aria-label. Use checked and onCheckedChange together for a controlled switch.

    Keep the shared stylesheet imported once. Replace sample image URLs and data with your own. Examples may use layout utilities beyond the precompiled component styles; compile added Tailwind classes in your app or replace them with your own CSS. Customize local source or className, and preserve accessible names and keyboard behavior.

    BUILD WITH IT

    Usage examples

    3 examples

    Try each example, then switch to Code to copy its complete implementation. These catalog snippets use the website's @/components/ui alias; replace it with your local generated path as shown in Quick start.

    01

    Basic Usage

    Use the Switch component for toggle actions

    Basic Usage

    Loading example…

    02

    With Label

    Combine with label for better accessibility

    With Label

    Loading example…

    03

    Sizes

    Choose a small (32 × 20), medium (40 × 24), or large (48 × 28) switch. Medium is the default.

    Sizes

    Loading example…

    THE API

    Props & configuration

    Reference

    Everything you need to fine-tune this component.

    Props and configuration
    PropTypeDefaultDescription
    size"sm" | "md" | "lg"mdThe switch dimensions; the thumb and travel scale together.
    checkedboolean—The controlled checked state
    defaultCheckedbooleanfalseThe default checked state
    onCheckedChange(checked: boolean) => void—Called when the checked state changes