React Nativenext

The Basics

Guides

Guides (iOS)

Guides (Android)

Contributing

components

APIs

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.

@keyword checkbox @keyword toggle

Props #

ViewPropTypes props... #

disabled?: bool #

If true the user won't be able to toggle the switch. Default value is false.

onTintColor?: color #

Background color when the switch is turned on.

onValueChange?: function #

Invoked with the new value when the value changes.

testID?: string #

Used to locate this view in end-to-end tests.

thumbTintColor?: color #

Color of the foreground switch grip.

tintColor?: color #

Border color on iOS and background color on Android when the switch is turned off.

value?: bool #

The value of the switch. If true the switch will be turned on. Default value is false.

Improve this page by sending a pull request!

← PrevNext →