`@react-native-picker/picker`

![npm version](https://www.npmjs.com/package/@react-native-picker/picker)
![Build](https://github.com/react-native-picker/picker/actions) !Supports Android, iOS, MacOS, and Windows !MIT License ![Lean Core Extracted](https://github.com/facebook/react-native/issues/23313)

| 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 |

For Managed Workflow users using Expo 37

This component is not supported in the managed workflow for expo sdk 37. Please import the Picker from react-native.
See more info here

Getting started

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

$ 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.


Windows (expand for details)
#### Windows
Usage in Windows without autolinking requires the following extra steps:

##### Add the ReactNativePicker project to your solution.

1. Open the solution in Visual Studio 2019 2. Right-click Solution icon in Solution Explorer > Add > Existing Project SelectD:\dev\RNTest\node_modules\@react-native-picker\picker\windows\ReactNativePicker\ReactNativePicker.vcxproj

##### windows/myapp.sln Add a reference toReactNativePicker to your main application project. From Visual Studio 2019:

Right-click main application project > Add > Reference... CheckReactNativePicker from Solution Projects.

##### app.cpp Add#include "winrt/ReactNativePicker.h" to the headers included at the top of the file.

Add PackageProviders().Append(winrt::ReactNativePicker::ReactPackageProvider()); before InitializeComponent();.

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

`pod install`


   React Native below 0.60 (Link and Manual Installation)
The following steps are only necessary if you are working with a version of React Native lower than 0.60
$3

$ react-native link @react-native-picker/picker

`$3`

#### iOS

1. In XCode, in the project navigator, right click Libraries ➜ Add Files to [your project's name]2. Go tonode_modules ➜ @react-native-picker/picker and add RNCPicker.xcodeproj3. In XCode, in the project navigator, select your project. AddlibRNCPicker.a to your project's Build Phases ➜ Link Binary With Libraries4. Run your project (Cmd+R)<

#### Android

1. Open application file (android/app/src/main/java/[...]/MainApplication.java) - Addimport com.reactnativecommunity.picker.RNCPickerPackage;to the imports at the top of the file - Addnew RNCPickerPackage() to the list returned by the getPackages()method 2. Append the following lines toandroid/settings.gradle:`include ':@react-native-picker_picker' project(':@react-native-picker_picker').projectDir = new File(rootProject.projectDir, '../node_modules/@react-native-picker/picker/android')`3. Insert the following lines inside the dependencies block inandroid/app/build.gradle:`implementation project(path: ':@react-native-picker_picker')`#### MacOS

`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

---

`Reference`

`Props`

`$3`

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

* itemValue: the valueprop 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 |

`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`

$3

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

---

Reference

Props

$3

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

---

$3

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

---

$3

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

---

$3

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

`@react-native-picker/picker`

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

Supported Versions

For Managed Workflow users using Expo 37

This component is not supported in the managed workflow for expo sdk 37. Please import the Picker from react-native.
See more info here

Getting started

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

$ 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.


Windows (expand for details)
#### Windows
Usage in Windows without autolinking requires the following extra steps:

##### Add the ReactNativePicker project to your solution.

##### windows/myapp.sln Add a reference toReactNativePicker to your main application project. From Visual Studio 2019:

Right-click main application project > Add > Reference... CheckReactNativePicker from Solution Projects.

##### app.cpp Add#include "winrt/ReactNativePicker.h" to the headers included at the top of the file.

Add PackageProviders().Append(winrt::ReactNativePicker::ReactPackageProvider()); before InitializeComponent();.

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

`pod install`


   React Native below 0.60 (Link and Manual Installation)
The following steps are only necessary if you are working with a version of React Native lower than 0.60
$3

$ react-native link @react-native-picker/picker

`$3`

#### iOS

#### Android

`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

---

`Reference`

`Props`

`$3`

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

* itemValue: the valueprop 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`

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

`$3`

| Type | Required | Platform | | --------- | -------- | -------- | | function | no | Android |

`$3`

| Type | Required | Platform | | --------- | -------- | -------- | | function | no | Android |

`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`

$3

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

---

Reference

Props

$3

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

---

$3

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

---

$3

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

---

$3

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

react-native-picker-label-transformed

@react-native-picker/picker

Supported Versions

For Managed Workflow users using Expo 37

Getting started

$3

$3

$3

RTL Support

Usage

$3

Reference

Props

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

Methods

$3

$3

PickerItemProps

$3

$3

$3

$3

$3

$3

$3

$3

Reference

Props

$3

$3

$3

$3

react-native-picker-label-transformed

@react-native-picker/picker

Supported Versions

For Managed Workflow users using Expo 37

Getting started

$3

$3

$3

RTL Support

Usage

$3

Reference

Props

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

Methods

$3

$3

PickerItemProps

$3

$3

$3

$3

$3

$3

`@react-native-picker/picker`

`$3`

`RTL Support`

`Usage`

`$3`

`Reference`

`Props`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`Methods`

`$3`

`$3`

`PickerItemProps`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`@react-native-picker/picker`

`$3`

`RTL Support`

`Usage`

`$3`

`Reference`

`Props`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`Methods`

`$3`

`$3`

`PickerItemProps`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`