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
Props
The value of the switch. If true the switch will be turned on.
Invoked when the user tries to change the value of the switch. Receives the new value as an argument.
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.If true, the user won’t be able to toggle the switch.
Color of the foreground switch grip. If this is set on iOS, the switch grip will lose its drop shadow.
Custom colors for the switch track.iOS Note: When the switch value is false, the track shrinks into the border. If you want to change the color of the background exposed by the shrunken track, use
ios_backgroundColor.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).Platform: iOS
Deprecated Props
Background color when the switch is turned on.Deprecated: Use
trackColor insteadPlatform: iOSColor of the foreground switch grip.Deprecated: Use
thumbColor insteadPlatform: iOSBackground color when the switch is turned off.Deprecated: Use
trackColor insteadPlatform: iOSControlled Component
Switch is a controlled component, which means you must manage its state:value prop in response to onValueChange, the switch will not respond to user input.
Styling
Basic Styling
Custom Colors
Platform Differences
iOS
- Native iOS switch with system styling
- Supports
ios_backgroundColorfor the exposed background - Track shrinks into a border when value is false
- Grip has a subtle drop shadow (removed if custom
thumbColoris set)
Android
- Material Design switch component
- Uses
trackColorfor the track in both states thumbColoraffects the circular button color- No drop shadow on the grip
Accessibility
Switch automatically has theswitch accessibility role. You can enhance accessibility with: