SSwitch <s-switch>

A toggle switch that turns a setting on or off. SSwitch is the typed Vue 3 wrapper for Shopify's Polaris <s-switch> web component.

import { SSwitch } from 'polaris-vue-elements'

Best practices

• Don't pair switches with a save button. A switch takes effect the moment it's toggled, so adding a save button leaves merchants unsure when their change actually applies.
• Make the setting obvious. Write a label that tells merchants what the switch controls and what on and off mean, so they don't have to flip it just to find out.
• Describe the consequences. Use details to explain what changes when the switch is toggled, especially for settings that affect important features or data, so merchants can decide with confidence.
• Group and order related switches. When a page has several switches, keep related settings together in a logical order so merchants can find and configure them easily.
• Explain why a switch is unavailable. When a switch is disabled because of permissions, dependencies or plan limits, tell merchants why, whether it's temporary, and what they need to do to unlock it.

<SSwitch label="Send order confirmation emails" details="Customers get an email as soon as they place an order." />

See Shopify's best practices for <s-switch> for the full guidance.

Example

On: false

<script setup>
import { ref } from 'vue'
import { SSwitch } from 'polaris-vue-elements'

const value = ref(false)
</script>

<template>
  <SSwitch label="Enable notifications" v-model="value" />
  <p>On: {{ value }}</p>
</template>

v-model

v-model on <SSwitch> binds to the checked property and listens for the change DOM event.

<SSwitch v-model="value" />

is equivalent to:

<SSwitch :checked="value" @change="value = $event.target.checked" />

Props

Prop	Type	Description
accessibilityLabel	string	A label used for users using assistive technologies like screen readers. When set, any children or label supplied will not be announced. This can also be used to display a control without a visual label, while still providing context to users using screen readers.
checked	boolean	Whether the control is active.
defaultChecked	boolean	Whether the control is active by default.
details	any	Additional text to provide context or guidance for the field. This text is displayed along with the field and its label to offer more information or instructions to the user. This will also be exposed to screen reader users.
disabled	boolean	Disables the control, disallowing any interaction.
error	any	Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.
label	any	Visual content to use as the control label.
labelAccessibilityVisibility	"visible" | "exclusive"	Changes the visibility of the component's label. - visible: the label is visible to all users. - exclusive: the label is visually hidden but remains in the accessibility tree.
name	string	An identifier for the control that is unique within the nearest containing Form component.
required	boolean	Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the error property.
value	string	The value used in form data when the control is checked.

Events

Event	Type
blur	FocusEvent
change	Event
input	Event

Listen for these with @blur-style listeners on <SSwitch>.