react-native-modal-dropdown

A react-native dropdown/picker/selector component for both Android & iOS.

This is the most up to date fork of https://github.com/sohobloo/react-native-modal-dropdown and will be maintained. A discussion about that can be found here: https://github.com/sohobloo/react-native-modal-dropdown/issues/251

Features

• Pure JS.
• Compatible with both iOS and Android.
• Auto position. (Won't be covered or clipped by the edge of screen.)
• Zero configuration. (Options are needed of course or a loading indicator will show.)
• Highly customizable.
• Controllable with API by code. (Show/Hide/Select)
• Change everything into a dropdown list trigger.

Demo

You can find them in the example.

Update History

v1.0.2

• Fixed Issue when initialScrollIndex failed. Added missing props: ref, getItemLayout, onScrollToIndexFailed
• Added keySearchObject option for search objects of array option

v1.0.1

• small fixes and more styling custimizations allowed

v1.0.0

• took over the package and merged user's PRs

v0.7.0

• Quick fix for react native 0.60. (Thanks to @ibtesamlatif2997)

Full update history list

Installation

npm i --save react-native-modal-dropdown

or

yarn add react-native-modal-dropdown

Usage

Basic

Import this module:

import ModalDropdown from 'react-native-modal-dropdown';

Use as a component:

<ModalDropdown options={['option 1', 'option 2']}/>

Use as a wrapper / container:

<ModalDropdown options={['option 1', 'option 2']}>
  ...
</ModalDropdown>

Customization

Give the style props as your choice:

• style: Change the style of the button (basic mode) / container (wrapper mode).
• textStyle: Change the style of text of the button. Invalid in wrapper mode.
• dropdownStyle: Change the style of dropdown container.

You can also render your option row and row separator by implement renderRow and renderSeparator function.

API

Props

Prop | Type | Optional | Default | Description ------------------- | -------- | -------- | --------- | ----------- disabled | bool | Yes | false | disable / enable the component. defaultIndex | number | Yes | -1 | Init selected index. -1: None is selected. This only change the highlight of the dropdown row, you have to give a defaultValue to change the init text. defaultValue | string | Yes | Please select... | Init text of the button. Invalid in wrapper mode. options | array | Yes | | Options. The dropdown will show a loading indicator if options is null/undefined. animated | bool | Yes | true | Disable / enable fade animation. isFullWidth | bool | Yes | false | Disable / enable is dropdown render as full width. showsVerticalScrollIndicator | bool | Yes | true | Show / hide vertical scroll indicator. saveScrollPosition | bool | Yes | true | Sets the scroll position to selected index. style | object | Yes | | Style of the button. textStyle | object | Yes | | Style of the button text. Invalid in wrapper mode. defaultTextStyle | object | Yes | | Overried Style of the button text for default value. Invalid in wrapper mode. dropdownStyle | object | Yes | | Style of the dropdown list. dropdownTextStyle | object | Yes | | Style of the dropdown option text. dropdownTextHighlightStyle | object | Yes | | Style of the dropdown selected option text. dropdownTextProps | object | Yes | | Add custom props to the dropdown option text adjustFrame | func | Yes | | This is a callback after the frame of the dropdown have been calculated and before showing. You will receive a style object as argument with some of the props like width height top left and right. Change them to appropriate values that accord with your requirement and make the new style as the return value of this function. renderRow | func | Yes | | Customize render option rows: function(option,index,isSelected) Will render a default row if null/undefined. renderRowComponent| Component | Yes | TouchableOpacity for iOS and TouchableHighlight for Android | Customize the touchable component of the rows renderRowProps | object | Yes | | Add custom props to the touchable component of the rows renderSeparator | func | Yes | | Customize render dropdown list separators. Will render a default thin gray line if null/undefined. renderButtonText | func | Yes | | Use this to extract and return text from option object. This text will show on button after option selected. Invalid in wrapper mode. renderRowText | func | Yes | | Use this to extract and return text from option object. This text will show on row Invalid in wrapper mode. renderButtonComponent| Component | Yes | TouchableOpacity | Customize the touchable component of the button renderRightComponent| Component | Yes | View | Custom component/Image to display on right side as dropdown icon renderButtonProps | object | Yes | | Add custom props to the touchable component of the button onDropdownWillShow| func | Yes | | Trigger when dropdown will show by touching the button. Return false can cancel the event. onDropdownWillHide| func | Yes | | Trigger when dropdown will hide by touching the button. Return false can cancel the event. onSelect | func | Yes | | Trigger when option row touched with selected index and value. Return false can cancel the event. accessible | bool | Yes | true | Set accessibility of dropdown modal and dropdown rows keyboardShouldPersistTaps | enum('always', 'never', 'handled') | Yes | 'never' | See react-native ScrollView props multipleSelect | bool | Yes | false | Remove event closing modal when calling onSelect. dropdownListProps | object | Yes | null | FlatList props showSearch | bool | Yes | false | Setting showSearch to true will render the list header with a search renderSearch | Component | Yes | null | Allows to pass search component (required showSearch props ) keySearchObject | string | Yes | 'label' | If your option is an array containing objects, option will find element via keySearchObject buttonAndRightComponentContainerStyle | object | Yes | | Prop to style the container View of the <Text> and the <RightComponent />

Methods

Method | Description ----------------- | ----------- show() | Show the dropdown. Won't trigger onDropdownWillShow. hide() | Hide the dropdown. Won't trigger onDropdownWillHide. select(idx) | Select the specified option of the idx. Select -1 will reset it to display defaultValue. Won't trigger onSelect.

Next version

Any suggestion is welcome.