mirror of
https://github.com/facebook/react-native.git
synced 2025-11-01 09:14:26 +00:00
Héctor RamosandFacebook Github Bot
9ec9567390
Differential Revision: D6261799 fbshipit-source-id: 269e151c5d136c1d508d9f2a060c0c670d0fe0f2
135 lines
1.9 KiB
Markdown
135 lines
1.9 KiB
Markdown
---
|
|
id: switch
|
|
title: Switch
|
|
layout: docs
|
|
category: components
|
|
permalink: docs/switch.html
|
|
next: tabbarios
|
|
previous: statusbar
|
|
---
|
|
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...](docs/viewproptypes.html#props)
|
|
- [`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 |
|
|
|
|
|
|
|
|
|
|
|
|
|