Docs
   Switch
Switch
A control that allows the user to toggle between checked and not checked.
								Loading...
  	<script lang="ts">
  import { Label } from "$lib/components/ui/label/index.js";
  import { Switch } from "$lib/components/ui/switch/index.js";
</script>
 
<div class="flex items-center space-x-2">
  <Switch id="airplane-mode" />
  <Label for="airplane-mode">Airplane Mode</Label>
</div>
 	<script lang="ts">
  import { Label } from "$lib/components/ui/label/index.js";
  import { Switch } from "$lib/components/ui/switch/index.js";
</script>
 
<div class="flex items-center space-x-2">
  <Switch id="airplane-mode" />
  <Label for="airplane-mode">Airplane Mode</Label>
</div>
 Installation
	npx shadcn-svelte@latest add switch
 Usage
	<script lang="ts">
  import { Switch } from "$lib/components/ui/switch";
</script>
 
<Switch />
 Examples
Form
								Loading...
  	<script lang="ts" context="module">
  import { z } from "zod";
  export const formSchema = z.object({
    marketing_emails: z.boolean().default(false).optional(),
    security_emails: z.boolean().default(true)
  });
  export type FormSchema = typeof formSchema;
</script>
 
<script lang="ts">
  import { browser } from "$app/environment";
  import { page } from "$app/stores";
  import * as Form from "$lib/components/ui/form/index.js";
  import SuperDebug, {
    type SuperValidated,
    type Infer,
    superForm
  } from "sveltekit-superforms";
  import { Switch } from "$lib/components/ui/switch/index.js";
  import { zodClient } from "sveltekit-superforms/adapters";
  import { toast } from "svelte-sonner";
  let data: SuperValidated<Infer<FormSchema>> = $page.data.switch;
  export { data as form };
 
  const form = superForm(data, {
    validators: zodClient(formSchema),
    onUpdated: ({ form: f }) => {
      if (f.valid) {
        toast.success("You submitted" + JSON.stringify(f.data, null, 2));
      } else {
        toast.error("Please fix the errors in the form.");
      }
    }
  });
 
  const { form: formData, enhance } = form;
</script>
 
<form method="POST" action="/?/switch" class="w-full space-y-6" use:enhance>
  <fieldset>
    <legend class="mb-4 text-lg font-medium"> Email Notifications </legend>
    <div class="space-y-4">
      <Form.Field
        {form}
        name="marketing_emails"
        class="flex flex-row items-center justify-between rounded-lg border p-4"
      >
        <Form.Control let:attrs>
          <div class="space-y-0.5">
            <Form.Label>Marketing emails</Form.Label>
            <Form.Description>
              Receive emails about new products, features, and more.
            </Form.Description>
          </div>
          <Switch
            includeInput
            {...attrs}
            bind:checked={$formData.marketing_emails}
          />
        </Form.Control>
      </Form.Field>
      <Form.Field
        {form}
        name="security_emails"
        class="flex flex-row items-center justify-between rounded-lg border p-4"
      >
        <Form.Control let:attrs>
          <div class="space-y-0.5">
            <Form.Label>Security emails</Form.Label>
            <Form.Description>
              Receive emails about your account security.
            </Form.Description>
          </div>
          <Switch
            {...attrs}
            aria-readonly
            disabled
            includeInput
            bind:checked={$formData.security_emails}
          />
        </Form.Control>
      </Form.Field>
    </div>
  </fieldset>
  <Form.Button>Submit</Form.Button>
  {#if browser}
    <SuperDebug data={$formData} />
  {/if}
</form>
 	<script lang="ts" context="module">
  import { z } from "zod";
  export const formSchema = z.object({
    marketing_emails: z.boolean().default(false).optional(),
    security_emails: z.boolean().default(true)
  });
  export type FormSchema = typeof formSchema;
</script>
 
<script lang="ts">
  import { browser } from "$app/environment";
  import { page } from "$app/stores";
  import * as Form from "$lib/components/ui/form/index.js";
  import SuperDebug, {
    type SuperValidated,
    type Infer,
    superForm
  } from "sveltekit-superforms";
  import { Switch } from "$lib/components/ui/switch/index.js";
  import { zodClient } from "sveltekit-superforms/adapters";
  import { toast } from "svelte-sonner";
  let data: SuperValidated<Infer<FormSchema>> = $page.data.switch;
  export { data as form };
 
  const form = superForm(data, {
    validators: zodClient(formSchema),
    onUpdated: ({ form: f }) => {
      if (f.valid) {
        toast.success("You submitted" + JSON.stringify(f.data, null, 2));
      } else {
        toast.error("Please fix the errors in the form.");
      }
    }
  });
 
  const { form: formData, enhance } = form;
</script>
 
<form method="POST" action="/?/switch" class="w-full space-y-6" use:enhance>
  <fieldset>
    <legend class="mb-4 text-lg font-medium"> Email Notifications </legend>
    <div class="space-y-4">
      <Form.Field
        {form}
        name="marketing_emails"
        class="flex flex-row items-center justify-between rounded-lg border p-4"
      >
        <Form.Control let:attrs>
          <div class="space-y-0.5">
            <Form.Label>Marketing emails</Form.Label>
            <Form.Description>
              Receive emails about new products, features, and more.
            </Form.Description>
          </div>
          <Switch
            includeInput
            {...attrs}
            bind:checked={$formData.marketing_emails}
          />
        </Form.Control>
      </Form.Field>
      <Form.Field
        {form}
        name="security_emails"
        class="flex flex-row items-center justify-between rounded-lg border p-4"
      >
        <Form.Control let:attrs>
          <div class="space-y-0.5">
            <Form.Label>Security emails</Form.Label>
            <Form.Description>
              Receive emails about your account security.
            </Form.Description>
          </div>
          <Switch
            {...attrs}
            aria-readonly
            disabled
            includeInput
            bind:checked={$formData.security_emails}
          />
        </Form.Control>
      </Form.Field>
    </div>
  </fieldset>
  <Form.Button>Submit</Form.Button>
  {#if browser}
    <SuperDebug data={$formData} />
  {/if}
</form>
 On This Page