Switch

<Switch> is a UI component that lets users toggle between two states.

<Switch checked="true" />

<Switch checked="true" />

<switch
  checked={switchValue}
  onCheckedChange={(args) => {
    setSwitchValue(args.value)
  }}
></switch>

<switch
  on:checkedChange={handleChange}
  checked={switchValue()}
></switch>

<switch bind:checked={switchValue}/>

<Switch v-model="switchValue" />

Examples ​

Styling a Switch ​

<Switch checked="true"
  color="#BFCDAC"
  backgroundColor="green"
  offBackgroundColor="#DC493D"
/>

Props ​

checked ​

checked: boolean

Gets or sets the state switch.

Defaults to false.

offBackgroundColor ​

offBackgroundColor: Color

Gets or sets the off-state background color.

See Color.

...Inherited ​

For additional inherited properties, refer to the API Reference.

Events ​

checkedChange ​

on('checkedChange', (args: PropertyChangeData) => {
  const switch = args.object as Switch
  console.log('Switch checked:', args.value)
})

See PropertyChangeData.

Native component ​

• Android: android.widget.Switch
• iOS: UISwitch