Toggle
A component for displaying toggles.
Follow the installation and quick start below to use Toggle in your project, or read the complete setup guide.
On this page
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 init2. Add Toggle 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 toggleChoose 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.
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.
"use client";
import { Toggle } from "./components/ui/toggle";
import { useState } from "react";
const ToggleUi = () => {
const [isOn, setIsOn] = useState(false as boolean);
// toggle related fun(c)
const handleToggleChange = (checked: boolean) => {
setIsOn(checked);
};
return (
<div className="flex items-center gap-2 p-4">
<Toggle
aria-label="Underline text"
pressed={isOn}
variant="outline"
onPressedChange={handleToggleChange}
>
U
</Toggle>
<Toggle
aria-label="Disabled underline toggle"
pressed={false}
variant="outline"
disabled
>
U
</Toggle>
</div>
);
};
export default ToggleUi;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.
Usage 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.
Basic Usage
A complete toggle example. Copy this into a client component.
Loading example…
Props & configuration
Everything you need to fine-tune this component.
| Prop | Type | Default | Description |
|---|---|---|---|
pressed | boolean | — | Controlled pressed state. |
onPressedChange | (pressed: boolean) => void | — | Called when the pressed state changes. |
variant | "default" | "outline" | default | Toggle visual style. |
size | "default" | "sm" | "lg" | default | Toggle size. |
disabled | boolean | false | Disables interaction. |
