On this page

Switch

---
import { Switch } from "@/components/starwind/switch";
---

<Switch id="demo-switch" label="Switch" />

Installation

pnpx starwind@latest add switch

npx starwind@latest add switch

yarn dlx starwind@latest add switch

Usage

variant

Default

Primary

Secondary

Info

Success

Warning

Error

---
import { Switch } from "@/components/starwind/switch";
---

<Switch id="default" label="Default" variant="default" checked />
<Switch id="primary" label="Primary" variant="primary" checked />
<Switch id="secondary" label="Secondary" variant="secondary" checked />
<Switch id="info" label="Info" variant="info" checked />
<Switch id="success" label="Success" variant="success" checked />
<Switch id="warning" label="Warning" variant="warning" checked />
<Switch id="error" label="Error" variant="error" checked />

size

Small

Medium

Large

---
import { Switch } from "@/components/starwind/switch";
---

<Switch id="small" label="Small" size="sm" />
<Switch id="medium" label="Medium" size="md" />
<Switch id="large" label="Large" size="lg" />

Event Handling

Whenever toggled, the switch emits a starwind-switch:change event. This can be listened to in order to update the UI based on the event.detail.checked value.

Switch Event Test

Test Switch

Switch is currently: off

---
import { Switch } from "@/components/starwind/switch";
---

<div class="mt-8 space-y-4">
  <h2 class="text-xl font-semibold">Switch Event Test</h2>

  <div class="space-y-4">
    <Switch id="test-switch" label="Test Switch" variant="primary" />

    <div id="status-display" class="text-muted-foreground text-sm">
      Switch is currently: <span class="text-foreground font-medium">off</span>
    </div>
  </div>
</div>

<script>
  import type { SwitchChangeEvent } from "@/components/starwind/switch";

  const testSwitch = document.querySelector("#test-switch") as HTMLElement;
  const statusDisplay = document.querySelector("#status-display span");

  testSwitch.addEventListener("starwind-switch:change", (e: Event) => {
    const event = e as SwitchChangeEvent;
    if (event.detail.switchId === "test-switch" && statusDisplay) {
      statusDisplay.textContent = event.detail.checked ? "on" : "off";
    }
  });
</script>

The event emission happens on state change and looks like:

const event = new CustomEvent<SwitchChangeEvent["detail"]>("starwind-switch:change", {
  detail: {
    checked: newState, // boolean
    switchId: this.switchButton.id,
  },
  bubbles: true,
  cancelable: true,
});

this.switchButton.dispatchEvent(event);

API Reference

Prop	Type	Default
id	`string`	Required
label	`string`	-
checked	`boolean`	`false`
padding	`number`	size-based*
size	`"sm"` \| `"md"` \| `"lg"`	`"md"`
variant	`"default"` \| `"primary"` \| `"secondary"` \| `"info"` \| `"success"` \| `"warning"` \| `"error"`	`"default"`

*Default padding is determined by size: sm = 2.5px, md = 3px, lg = 4px

This component also accepts all standard HTML attributes for <button> elements, except for role, type, and aria-checked.

Changelog

v1.1.0

tailwind-variants now implemented. This uses tailwind-merge under the hood to merge Tailwind classes without style conflicts, allowing you to override any existing classes using the “class” prop.