A picker (dropdown) component for react native

React native dropdown picker

A picker (dropdown) component for react native which supports both Android & iOS.

Installation

via NPM

npm install react-native-dropdown-picker --save

via Yarn

yarn add react-native-dropdown-picker

Basic Usage

First of all import the package.

import DropDownPicker from 'react-native-dropdown-picker';

Render the component.

<DropDownPicker
    items={[
        {label: 'Item 1', value: 'item1'},
        {label: 'Item 2', value: 'item2'},
    ]}
    defaultIndex={0}
    containerStyle={{height: 40}}
    onChangeItem={item => console.log(item.label, item.value)}
/>

Default item

You may want to select one of the items as default.

Use one of these ways:

1. Add selected: true to the object.

   items={[
       {label: 'Item 1', value: 'item1'},
       {label: 'Item 2', value: 'item2', selected: true},
   ]}
   

2. The defaultIndex property.

   defaultIndex={1}
   

3. The defaultValue property.

   defaultValue="item2"
   

Placeholder

You may want to have a placeholder while the default value is null.

Add the following properties to the component.

...
defaultNull
placeholder="Select an item"
...

Dynamic placeholder

In some cases you're going to create two or more pickers which are linked together.

Think of a country picker and city picker, whenever you're changing the country, the city picker should be reset and show the placeholder.

import React from 'react';
export default class MyComponent extends React.Component {
    constructor(props) {
        super(props);

        this.state = {
            country: null,
            city: null,
            cities: []
        };
    }

    changeCountry(item) {
        let city = null;
        let cities;
        switch (item.value) {
            case 'fr':
                cities = [
                    {label: 'Paris', value: 'paris'}
                ];
            break;
            case 'es':
                cities = [
                    {label: 'Madrid', value: 'madrid'}
                ];
            break;
        }

        this.setState({
            city,
            cities
        });
    }

    changeCity(item) {
        this.setState({
            city: item.value
        });
    }

    render() {
        return (
            <>
                <DropDownPicker
                    items={[
                        {label: 'France', value: 'fr'},
                        {label: 'Spain', value: 'es'},
                    ]}
                    defaultNull
                    placeholder="Select your country"
                    containerStyle={{height: 40}}
                    onChangeItem={item => this.changeCountry(item)}
                />
                <DropDownPicker
                    items={this.state.cities}
                    defaultNull={this.state.city === null}
                    placeholder="Select your city"
                    containerStyle={{height: 40}}
                    onChangeItem={item => this.changeCity(item)}
                />
            </>
        );
    }
}

Dropdown Overflow

Adding borders to the component will separate or overflow elements. to solve this issue you just need to add marginTop to the dropDownStyle and specify the value which fits your component well.

dropDownStyle={{marginTop: 2}}

Styling the component

You have 9 options to style the component.

1. The style property.

   Use this to adjust the inner part of the picker.

   style={{paddingVertical: 10}}
   

2. The dropDownStyle property.

   Additional styles for the dropdown box.

   dropDownStyle={{backgroundColor: '#fafafa}}
   

3. The containerStyle property.

   Use this to adjust the outer part of the picker such as margin, width, height.

   containerStyle={{width: 150, height: 70}}
   

4. The itemStyle property.

   If you want the labels on the left and right side or to centerize them:

   itemStyle={{alignItems: 'flex-start|flex-end|center'}}
   

5. The labelStyle property.

   This property gives full control over the label.

   labelStyle={{fontSize: 14, color: '#000'}}
   

6. The placeholderStyle property.

   It is possible to style the placeholder text with this property.

   placeholderStyle={{fontWeight: 'bold'}}
   

7. The activeItemStyle property.

   This property allows you to style the active item.

   activeItemStyle={{alignItems: 'center'}}
   

8. The activeLabelStyle property.

   This property allows you to style the active label.

   activeLabelStyle={{color: 'red'}}
   

9. The arrowStyle property.

   Adds your additional styles to the View element of the arrow.

   arrowStyle={{marginRight: 10}}
   

Props

GitHub