<Switch />

Switch component. The switch can be toggled both by dragging and tapping. Will automatically displays a Material Design switch on Android devices.

Tutorial

Switches

A switch is an UI element that can be used to toggle between two states.

The state of a switch in Onsen UI can be changed both by dragging the knob and by tapping on the switch.

To make the switch enabled by default you can use the checked prop just like with radio buttons and checkboxes.

<Switch checked={this.state.checked} onChange={this.handleChange} />

To disable the switch the disabled prop is used.

Props

Name Type Description
onChange function Called when the value of the switch changes (checked/unchecked) Optional.
checked bool Whether the switch is checked. Optional.
disabled bool If set, the switch is disabled. Optional.
inputId string Specify the id attribute of the inner <input> element. This is useful when using <label for="..."> elements. Optional.

Preset Modifiers

Name Description
material Material Design switch

Need Help?

If you have any questions, use our Community Forum or talk to us on Discord chat. The Onsen UI team and your peers in the community will work together to help solve your issues.

For bug reports and feature requests use our GitHub Issues page.