Switch - Skeleton

Label

<script lang="ts">
  import { Switch } from '@skeletonlabs/skeleton-svelte';
</script>

<Switch>
  <Switch.Control>
    <Switch.Thumb />
  </Switch.Control>
  <Switch.Label>Label</Switch.Label>
  <Switch.HiddenInput />
</Switch>

List

Label 1

Label 2

Label 3

<script lang="ts">
  import { Switch } from '@skeletonlabs/skeleton-svelte';
</script>

<div class="grid gap-2 w-full">
  {#each ['Label 1', 'Label 2', 'Label 3'] as label, i (label)}
    <Switch class="flex justify-between p-2">
      <Switch.Label>{label}</Switch.Label>
      <Switch.Control>
        <Switch.Thumb />
      </Switch.Control>
      <Switch.HiddenInput />
    </Switch>
    {#if i < 2}
      <hr class="hr" />
    {/if}
  {/each}
</div>

Icons

<script lang="ts">
  import { Switch } from '@skeletonlabs/skeleton-svelte';
  import Sun from '@lucide/svelte/icons/sun';
  import Moon from '@lucide/svelte/icons/moon';
</script>

<Switch>
  <Switch.Control>
    <Switch.Thumb>
      <Switch.Context>
        {#snippet children(ctx)}
          {#if ctx.api.checked}
            <Sun class="size-3 stroke-surface-50-950" />
          {:else}
            <Moon class="size-3 stroke-surface-950-50" />
          {/if}
        {/snippet}
      </Switch.Context>
    </Switch.Thumb>
  </Switch.Control>
  <Switch.HiddenInput />
</Switch>

API Reference

Root

cursor-pointer data-disabled:cursor-not-allowed data-disabled:opacity-50 flex gap-2

Property	Default	Type
`element`	-	Snippet<[{ attributes: Record<string, unknown>; }]> \| undefined Render the element yourself
`ids`	-	Partial<{ root: string; hiddenInput: string; control: string; label: string; thumb: string; }> \| undefined The ids of the elements in the switch. Useful for composition.
`label`	-	string \| undefined Specifies the localized strings that identifies the accessibility elements and their states
`disabled`	-	boolean \| undefined Whether the switch is disabled.
`invalid`	-	boolean \| undefined If `true`, the switch is marked as invalid.
`required`	-	boolean \| undefined If `true`, the switch input is marked as required,
`readOnly`	-	boolean \| undefined Whether the switch is read-only
`onCheckedChange`	-	((details: CheckedChangeDetails) => void) \| undefined Function to call when the switch is clicked.
`checked`	-	boolean \| undefined The controlled checked state of the switch
`defaultChecked`	-	boolean \| undefined The initial checked state of the switch when rendered. Use when you don't need to control the checked state of the switch.
`name`	-	string \| undefined The name of the input field in a switch (Useful for form submission).
`form`	-	string \| undefined The id of the form that the switch belongs to
`value`	"on"	string \| number \| undefined The value of switch input. Useful for form submission.
`dir`	"ltr"	"ltr" \| "rtl" \| undefined The document's text/writing direction.
`getRootNode`	-	(() => ShadowRoot \| Node \| Document) \| undefined A root node to correctly resolve document in custom environments. E.x.: Iframes, Electron.

RootContext

Property	Default	Type
`children`	-	Snippet<[SwitchRootContextType]>

Control

block preset-filled-surface-200-800 h-6 w-10 p-0.5 rounded-full flex justify-start data-[state=checked]:preset-filled-primary-500 data-focus:ring-2 data-focus:ring-surface-950-50

Property	Default	Type
`element`	-	Snippet<[{ attributes: Record<string, unknown>; }]> \| undefined Render the element yourself

Thumb

rounded-full block preset-filled-surface-50-950 h-full aspect-square transition-transform grid place-items-center data-[state=checked]:bg-surface-950-50 data-[state=checked]:translate-x-4 rtl:data-[state=checked]:-translate-x-4

Property	Default	Type
`element`	-	Snippet<[{ attributes: Record<string, unknown>; }]> \| undefined Render the element yourself

Label

Property	Default	Type
`element`	-	Snippet<[{ attributes: Record<string, unknown>; }]> \| undefined Render the element yourself

HiddenInput

Property	Default	Type
`element`	-	Snippet<[{ attributes: Record<string, unknown>; }]> \| undefined Render the element yourself