Toggle switches for binary on/off settings. Sizes: small, default, large. Colors use the shared theme palette.
Setup
<script lang="ts">
import { Toggle } from '.';
</script> Default toggle
<script lang="ts">
import { Toggle } from '.';
</script>
<Toggle>Toggle me</Toggle>
<Toggle checked>Checked</Toggle>
<Toggle disabled>Disabled</Toggle> Colors
Theme colors: primary (default), secondary, gray, red, orange, amber, yellow, lime, green, emerald, teal, cyan, sky, blue, indigo, violet, purple, fuchsia, pink, rose.
<script lang="ts">
import { Toggle } from '.';
</script>
<Toggle color="primary" checked>Primary</Toggle>
<Toggle color="green" checked>Green</Toggle>
<Toggle color="red" checked>Red</Toggle> Sizes
<script lang="ts">
import { Toggle } from '.';
</script>
<Toggle size="small">Small</Toggle>
<Toggle size="default">Default</Toggle>
<Toggle size="large">Large</Toggle> Off label snippet
<script lang="ts">
import { Toggle } from '.';
let on = $state(false);
</script>
<Toggle bind:checked={on}>
On
{#snippet offLabel()}
Off
{/snippet}
</Toggle> Accessibility
- Renders as a checkbox input with a visual switch; keep a visible label via
children. - Disabled state sets native
disabledand reduces opacity. - Announce state changes with clear on/off labels when both matter.
Props
| Prop | Type | Default | Description |
|---|---|---|---|
checked | boolean | — | Bindable on/off state |
color | theme color | primary | Track accent when checked |
size | small | default | large | default | Switch size |
children | Snippet | — | On-state / primary label |
offLabel | Snippet | — | Off-state label snippet |
classes | theme slots | — | Slot class overrides |
inputClass / spanClass | ClassValue | — | Input / track classes |
disabled / name / id / value | native | — | HTML input attrs |
...rest | HTML input attrs | — | Other input attributes |