Skip to main content
Version: 0.87

Switch

Renders a boolean input.

This is a controlled component that requires an onValueChange callback that updates the value prop in order for the component to reflect user actions. If the value prop is not updated, the component will continue to render the supplied value prop instead of the expected result of any user actions.

Exampleโ€‹


Reference

Propsโ€‹

View Propsโ€‹

Inherits View Props.


disabledโ€‹

If true the user won't be able to toggle the switch.

TypeDefault
boolfalse

ios_backgroundColor
iOS
โ€‹

On iOS, custom color for the background. This background color can be seen either when the switch value is false or when the switch is disabled (and the switch is translucent).

Type
color

onChangeโ€‹

Invoked when the user tries to change the value of the switch. Receives the change event as an argument. If you want to only receive the new value, use onValueChange instead.

Type
function

onValueChangeโ€‹

Invoked when the user tries to change the value of the switch. Receives the new value as an argument. If you want to instead receive an event, use onChange.

Type
function

refโ€‹

A ref setter that will be assigned an element node when mounted.