2017-11-08 00:34:50 +00:00
---
id: switch
title: Switch
layout: docs
category: components
permalink: docs/switch.html
next: tabbarios
previous: statusbar
---
Renders a boolean input.
2017-11-09 17:47:50 +00:00
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.
2017-11-08 00:34:50 +00:00
@keyword checkbox
@keyword toggle
### Props
Migrate to new documentation format
Summary:
Now that the Component and API docs are no longer auto-generated, we need to consolidate on a new format for our jsdoc comments. Any help from the community will be appreciated.
In this initial pull request, we'll be tackling the following docs:
- `AccessibilityInfo`, an API doc.
- `ActivityIndicator`, a Component doc.
- `View`, a Component doc.
This top comment will serve as a style guide, and when in doubt, please refer to the individual commits in this PR.
Each commit should update a single component or API, along with any relevant markdown files.
- Documentation in the JavaScript source files should be succinct. Any verbosity should be moved over to the markdown docs in the website...
- ...by adding a link to the relevant method/prop on the website to every comment block.
- Avoid markdown style links in JavaScript source files, opt for plain old URIs.
Let code document itself:
- If a method is Flow typed, the comment block does not need to repeat this information.
- If a param can be one of several values, and the type definition is easily determined from the code, the values should not be repeated in the comment block. Again, move this to the markdown doc if not present already.
Closes https://github.com/facebook/react-native/pull/16790
Differential Revision: D6353840
Pulled By: hramos
fbshipit-source-id: 9712c459acc33092aae9909f3dd0b58a00b26afc
2017-11-17 00:44:29 +00:00
- [View props... ](docs/view.html#props )
2017-11-08 00:34:50 +00:00
- [`disabled` ](docs/switch.html#disabled )
- [`onTintColor` ](docs/switch.html#ontintcolor )
- [`onValueChange` ](docs/switch.html#onvaluechange )
- [`testID` ](docs/switch.html#testid )
- [`thumbTintColor` ](docs/switch.html#thumbtintcolor )
- [`tintColor` ](docs/switch.html#tintcolor )
- [`value` ](docs/switch.html#value )
---
# Reference
## Props
### `disabled`
If true the user won't be able to toggle the switch.
Default value is false.
| Type | Required |
| - | - |
| bool | No |
---
### `onTintColor`
Background color when the switch is turned on.
| Type | Required |
| - | - |
| [color ](docs/colors.html ) | No |
---
### `onValueChange`
Invoked with the new value when the value changes.
| Type | Required |
| - | - |
| function | No |
---
### `testID`
Used to locate this view in end-to-end tests.
| Type | Required |
| - | - |
| string | No |
---
### `thumbTintColor`
Color of the foreground switch grip.
| Type | Required |
| - | - |
| [color ](docs/colors.html ) | No |
---
### `tintColor`
Border color on iOS and background color on Android when the switch is turned off.
| Type | Required |
| - | - |
| [color ](docs/colors.html ) | No |
---
### `value`
The value of the switch. If true the switch will be turned on.
Default value is false.
| Type | Required |
| - | - |
| bool | No |
