A Picker component for React Native which emulates the native <select>
interfaces for iOS and Android
For iOS, by default we are wrapping an unstyled TextInput component. You can then pass down styles to customize it to your needs.
For Android, by default we are using the native Picker component. If you prefer, you can set useNativeAndroidPickerStyle
to false, which will also render an unstyled TextInput component. You can then pass down styles to customize it to your needs.
For either platform, you can alternatively pass down a child element of your choice that will be wrapped in a touchable area.
npm install react-native-picker-select
import RNPickerSelect from 'react-native-picker-select';
export const Dropdown = () => {
return (
<RNPickerSelect
onValueChange={(value) => console.log(value)}
items={[
{ label: 'Football', value: 'football' },
{ label: 'Baseball', value: 'baseball' },
{ label: 'Hockey', value: 'hockey' },
]}
/>
);
};
Component | React |
---|---|
>= 3.0.0 | >= 16.3 |
< 3.0.0 | < 16.3 |
Name | Description | Details |
---|---|---|
onValueChange |
Callback which returns value, index |
required |
function | ||
items |
The items for the component to render |
{label: 'Orange', value: 'orange', key: 'orange', color: 'orange', displayValue: true}
label
and value
are requiredkey
, color
, and displayValue
are optionalkey
will be set to equal label
if not includedvalue
can be any data typedisplayValue
is truthy, the TextInput will display the value
instead of the label
| requiredplaceholder
| - An override for the default placeholder object with a label of Select an item...
and a value of null
disabled
| Disables interaction with the component | boolean |value
| Will attempt to locate a matching item from the items
array by checking each item’s value
property. If found, it will update the component to show that item as selected. If the value is not found, it will default to the first item. | any |itemKey
| Will attempt to locate a matching item from the items
array by checking each item’s key
property. If found, it will update the component to show that item as selected. If the key is not found, it will attempt to find a matching item by value
as above. | string, number |style
| Style overrides for most parts of the component.pickerProps
| Additional props to pass to the Picker (some props are used in core functionality so use this carefully) | object |Icon
| Custom icon component to be rendered.textInputProps
| Additional props to pass to the TextInput (some props are used in core functionality so use this carefully). This is iOS only unless useNativeAndroidPickerStyle={false}
. | object |touchableWrapperProps
| Additional props to pass to the touchable wrapping the TextInput (some props are used in core functionality so use this carefully) | object |onOpen
useNativeAndroidPickerStyle={true}
| function |useNativeAndroidPickerStyle
false
will mimic the default iOS presentation where a tappable TextInput is displayed.InputAccessoryView
null
here to hide completely. While this bar is typical on select
elements on the web, the interface guidelines does not include it. View the snack to see examples on how this can be customized. | Component |doneText
onUpArrow / onDownArrow
onDonePress
onClose
modalProps
touchableDoneProps
All properties mentioned below must be nested under the style
prop. Examples of different styling options can be found on the example snack.
inputIOS
.inputIOSContainer
, placeholder
, viewContainer
, chevronContainer
, chevron
, chevronUp
, chevronDown
, chevronActive
, done
, modalViewTop
, modalViewMiddle
, and modalViewBottom
inputAndroid
.useNativeAndroidPickerStyle
to false, the component will allow a few other style objects: inputAndroidContainer
, placeholder
, and inputAndroid
headlessAndroidContainer
and viewContainer
Icon
prop - it will be rendered with { position: 'absolute', right: 0 }
applied to its wrapping container. You can modify these values and add additional spacing to position the icon as needed by modifying iconContainer
. You’ll probably also want to add some paddingRight
to your input styling to avoid any longer text appearing behind the icon.This component has been tested on React Native v0.51 - v0.61
Author: lawnstarter
GitHub: https://github.com/lawnstarter/react-native-picker-select
#react-native #react #mobile-apps