The latest SMUI v3 beta had a lot of changes, and these docs haven't been caught up yet. You should check out the demo page's code to see the latest usage.

Basic Usage

<FormField>
  <Switch bind:checked={selected} />
  <span slot="label">Switch me.</span>
</FormField>

<script>
  import Switch from '@smui/switch';
  import FormField from '@smui/form-field';

  let selected = false;
</script>

Exports

(default)

A switch.

Props / Defaults

use: [] - An array of Svelte actions and/or arrays of an action and its options.
class: '' - A CSS class string.
disabled: false - Whether the input is disabled.
group: (uninitialised) - The selected values of a group of switches as an array.
checked: (uninitialised) - A boolean, whether the switch is checked. This is used instead of group for a single switch.
value : null - The value of a switch in a group of switches.
valueKey : (uninitialised) - If value is not a string, this should be supplied as well, and should be a unique key.

Forwarded Props

input$ - Props forwarded to the input element.

Functions

getId - Get the HTML ID of the element.

More Information

See Switches in the Material design spec.

See Switch in MDC-Web for information about the upstream library's architecture.

Keywords

FAQs

What is @smui/switch?

Is @smui/switch popular?

Is @smui/switch well maintained?

Package last updated on 16 Apr 2021

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

@smui/switch

Svelte Material UI - Switch

Installation

Demo

Whoa There, These Docs are Outdated

Basic Usage