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



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.

To disable the switch the disabled prop is used.

See also

Name Type Description
checked Boolean Whether the switch is checked. Optional.
disabled Boolean Whether the switch is be disabled. Optional.
input-id String Specify the id attribute of the inner <input> component. This is useful when using <label for="..."> components. Optional.
modifier String The appearance of the switch. Optional.
Name Description
material Material Design switch
Name Description
change Fired when the switch is toggled.

Fired when the switch is toggled.

Name Type Description
event Object Event object.
event.switch Object Switch object.
event.value Boolean Current value.
event.isInteractive Boolean True if the change was triggered by the user clicking on the 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.