@react-native-picker/picker

 !Supports Android, iOS, MacOS, and Windows !MIT License 

| Android | iOS | PickerIOS | Windows | MacOS |
| --- | --- | --- | --- | --- |
| | | | |

Supported Versions

| @react-native-picker/picker | react-native | react-native-windows |
| --- | --- | --- |
| >= 2.0.0 | 0.61+ | 0.64+ |
| >= 1.16.0 | 0.61+ | 0.61+ |
| >= 1.2.0 | 0.60+ or 0.59+ with Jetifier | N/A |
| >= 1.0.0 | 0.57 | N/A |

Getting started

$ npm install @react-native-picker/picker --save

or

$ yarn add @react-native-picker/picker

$3

As react-native@0.60 and above supports autolinking there is no need to run the linking process.
Read more about autolinking here. This is supported by react-native-windows@0.64 and above.

#### iOS
CocoaPods on iOS needs this extra step:

``
npx pod-install
`

#### Android
No additional step is required.

#### MacOS
CocoaPods on MacOS needs this extra step (called from the MacOS directory)

`
pod install
`

RTL Support

you need to add android:supportsRtl="true" to AndroidManifest.xml
`xml
...
android:supportsRtl="true">
`

Usage

Import Picker from @react-native-picker/picker:

`javascript
import {Picker} from '@react-native-picker/picker';
`

Create state which will be used by the Picker:

`javascript
const [selectedLanguage, setSelectedLanguage] = useState();
`

Add Picker like this:

`javascript
selectedValue={selectedLanguage}
onValueChange={(itemValue, itemIndex) =>
setSelectedLanguage(itemValue)
}>



`

If you want to open/close picker programmatically on android (available from version 1.16.0+), pass ref to Picker:

`javascript
const pickerRef = useRef();

function open() {
pickerRef.current.focus();
}

function close() {
pickerRef.current.blur();
}

return ref={pickerRef}
selectedValue={selectedLanguage}
onValueChange={(itemValue, itemIndex) =>
setSelectedLanguage(itemValue)
}>



`

$3

* Inherited View props...

- onValueChange
- selectedValue
- style
- testID
- enabled
- mode
- prompt
- itemStyle
- selectionColor

---

Reference

Props

$3

Callback for when an item is selected. This is called with the following parameters:

* itemValue: the value prop of the item that was selected
* itemPosition: the index of the selected item in this picker

| Type | Required |
| -------- | -------- |
| function | No |

---

$3

Value matching value of one of the items. Can be a string or an integer.

| Type | Required |
| ---- | -------- |
| any | No |

---

$3

| Type | Required |
| --------------- | -------- |
| pickerStyleType | No |

---

$3

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

| Type | Required |
| ------ | -------- |
| string | No |

---

$3

If set to false, the picker will be disabled, i.e. the user will not be able to make a selection.

| Type | Required | Platform |
| ---- | -------- | -------- |
| bool | No | Android, Web, Windows |

---

$3

On Android, specifies how to display the selection items when the user taps on the picker:

* 'dialog': Show a modal dialog. This is the default.
* 'dropdown': Shows a dropdown anchored to the picker view

| Type | Required | Platform |
| -------------------------- | -------- | -------- |
| enum('dialog', 'dropdown') | No | Android |

---

$3

On Android, specifies color of dropdown triangle. Input value should be value that is accepted by react-native processColor function.

| Type | Required | Platform |
| ---------- | -------- | -------- |
| ColorValue | No | Android |

---

$3

On Android, specifies ripple color of dropdown triangle. Input value should be value that is accepted by react-native processColor function.

| Type | Required | Platform |
| ---------- | -------- | -------- |
| ColorValue | No | Android |

---

$3

Prompt string for this picker, used on Android in dialog mode as the title of the dialog.

| Type | Required | Platform |
| ------ | -------- | -------- |
| string | No | Android |

---

$3

Style to apply to each of the item labels.

| Type | Required | Platform |
| ---------------------------------- | -------- | -------- |
| text styles | No | iOS, Windows |

$3

On Android & iOS, used to truncate the text with an ellipsis after computing the text layout, including line wrapping,
such that the total number of lines does not exceed this number. Default is '1'

| Type | Required | Platform |
| ------- | -------- | -------- |
| number | No | Android, iOS |

$3

| Type | Required | Platform |
| --------- | -------- | -------- |
| function | No | Android |

$3

| Type | Required | Platform |
| --------- | -------- | -------- |
| function | No | Android |

$3

| Type | Required | Platform |
| ------- | -------- | -------- |
| ColorValue | No | iOS |

Methods

$3

Programmatically closes picker

$3

Programmatically opens picker

PickerItemProps

Props that can be applied to individual Picker.Item

$3

Displayed value on the Picker Item

| Type | Required |
| ------- | -------- |
| string | Yes |

$3

Actual value on the Picker Item

| Type | Required |
| ------- | -------- |
| number,string | Yes |

$3

Displayed color on the Picker Item

| Type | Required |
| ----------- | -------- |
| ColorValue | No |

$3

Displayed fontFamily on the Picker Item

| Type | Required |
| ------- | -------- |
| string | No |

$3

Style to apply to individual item labels.

| Type | Required | Platform |
| ------- | -------- | -------- |
| ViewStyleProp | No | Android |

$3

If set to false, the specific item will be disabled, i.e. the user will not be able to make a selection

@default: true

| Type | Required | Platform |
| ------- | -------- | -------- |
| boolean | No | Android |

$3

Sets the content description to the Picker Item

| Type | Required | Platform |
| ------ | -------- | -------- |
| string | No | Android |

$3

- Inherited View props...
- itemStyle
- onValueChange
- selectedValue
- selectionColor
- themeVariant`

---

Reference

Props

$3

| Type | Required |
| ---------------------------------- | -------- |
| text styles | No |

---

$3

| Type | Required |
| -------- | -------- |
| function | No |

---

$3

| Type | Required |
| ---- | -------- |
| any | No |

---

$3

| Type | Required | Platform |
| ------- | -------- | -------- |
| ColorValue | No | iOS |

---

$3

| Type | Required |
| ---- | -------- |
| enum('light', 'dark') | No |
"# picker"
"# picker"
# picker