Skip to content
MIZU.

Switch

A tactile binary setting whose thumb tracks the state.

View .md

Live — this one is real

Usage

tsx
import { Switch } from "mizu-ui";

export function Example() {
  return (
    <Switch label="Email notifications" name="notifications" defaultChecked />
  );
}

Source & setup

Add this component to your project with the shadcn CLI. The command copies its source into your configured UI directory, with base.css, Mizu’s tokens, and the stylesheets that hold its rules. Each rule lives in one stylesheet, so components you add together never repeat CSS. In a project without a components.json, run npx shadcn@latest init 0xuser64bit/mizu/preset first: plain init installs shadcn’s theme into your global CSS. Then load the fonts.

sh
npx shadcn@latest add 0xuser64bit/mizu/switch

Every component imports from its own path, its name in kebab case. Its source, forms/Fields.tsx, also holds FormField, TextField, TextArea, SelectField, Checkbox, SearchField and PasswordField. Each has its own command and path; adding one after this copies only its small entry file. To paste the example, replace its mizu-ui import with:

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

For npm imports, import mizu-ui/styles.css once. Fonts are optional via mizu-ui/fonts.css. Override --mizu-* tokens or use className for local styling. Uses native React and CSS; install the package peers for root imports. A Client Component: its source starts with “use client”.

Inspect forms/Fields.tsx

Source is included in the npm package under src/forms/Fields.tsx.

Open full source ↗

Props

PropTypeDefaultDescription
labelstring—Setting name.
...inputInputHTMLAttributes—Native checked/defaultChecked, disabled, onChange and ref.

Accessibility

A native checkbox with role=switch. Space toggles; visible focus follows the thumb.

Motion

CSS transitions explain state changes. Reduced motion removes travel.

Works alongside

DateRangeFieldOneTimeCodeFormFieldTextField