1.0.2 • Published 1 year ago

react-native-select-dropdown-edit v1.0.2

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

react-native-select-dropdown

react-native-select-dropdown is a highly customized dropdown | select | picker | menu for react native that works for android and iOS platforms.

Installation

# Using npm

npm install react-native-select-dropdown

# Using yarn

yarn add react-native-select-dropdown

Demo

Code provided in Examples folder.

Search Functionality (Code provided in Examples folder).

Usage

import SelectDropdown from 'react-native-select-dropdown'
...
const countries = ["Egypt", "Canada", "Australia", "Ireland"]
...
<SelectDropdown
	data={countries}
	onSelect={(selectedItem, index) => {
		console.log(selectedItem, index)
	}}
	buttonTextAfterSelection={(selectedItem, index) => {
		// text represented after item is selected
		// if data array is an array of objects then return selectedItem.property to render after item is selected
		return selectedItem
	}}
	rowTextForSelection={(item, index) => {
		// text represented for each item in dropdown
		// if data array is an array of objects then return item.property to represent item in dropdown
		return item
	}}
/>

Props

Methods


data

array of data that will be represented in dropdown 'can be array of objects

TypeRequired
arrayYes

onSelect

function recieves selected item and its index in data array

TypeRequired
functionYes

defaultButtonText

default button text when no item is selected

TypeRequired
StringNo

buttonTextAfterSelection

function recieves selected item and its index, this function should return a string that will be represented in button after item is selected

TypeRequired
functionYes "unless you customized button using renderCustomizedButtonChild"

rowTextForSelection

function recieves item and index for each row in dropdown, this function shoud return a string that will be represented in each row in dropdown

TypeRequired
functionYes "unless you customized button using renderCustomizedRowChild"

defaultValue

default selected item in dropdown ( check examples in Demo1)

TypeRequired
anyNo

defaultValueByIndex

default selected item index

TypeRequired
integerNo

disabled

disable dropdown

TypeRequired
booleanNo

disableAutoScroll

disable auto scroll to selected value

TypeRequired
booleanNo

disabledIndexs

disable choose all Rows index in the list

TypeRequired
arrayNo

onFocus

function fires when dropdown is opened

TypeRequired
functionNo

onBlur

function fires when dropdown is closed

TypeRequired
functionNo

onScrollEndReached

function fires when dropdown scrolls to the end (for paginations)

TypeRequired
functionNo

buttonStyle

style object for button

TypeRequired
objectYes

buttonTextStyle

style object for button text

TypeRequired
objectNo

renderCustomizedButtonChild

function recieves selected item and its index, this function should return a React component as a child for dropdown button buttonStyle should be used for parent button view style.

# check examples folder to make things clear

TypeRequired
functionNo

renderDropdownIcon

function that should return a React component for dropdown icon

TypeRequired
functionNo

dropdownIconPosition

dropdown icon position "left" || "right"

TypeRequired
stringNo

statusBarTranslucent

required to set true when statusbar is translucent (android only)

TypeRequired
booleanNo

dropdownStyle

style object for dropdown view

TypeRequired
objectNo

dropdownOverlayColor

backdrop color when dropdown is opened

TypeRequired
stringNo

dropdownBackgroundColor

background color behind list items when dropdown is opened

TypeRequired
stringNo

rowStyle

style object for row

TypeRequired
objectYes

rowTextStyle

style object for row text

TypeRequired
objectNo

selectedRowStyle

style object for selected row

TypeRequired
objectYes

selectedRowTextStyle

style object for selected row text

TypeRequired
objectNo

renderCustomizedRowChild

function recieves item and its index, this function should return React component as a child for customized row rowStyle should be used for parent row view style.

# check examples folder to make things clear

TypeRequired
functionNo

search

enable search functionality

TypeRequired
booleanNo

searchInputStyle

style object for search input

TypeRequired
objectYes

searchInputTxtColor

text color for search input

TypeRequired
stringNo

searchPlaceHolder

placeholder text for search input

TypeRequired
stringNo

searchPlaceHolderColor

text color for search input placeholder

TypeRequired
stringNo

renderSearchInputLeftIcon

function returns React component for search input icon

TypeRequired
functionNo

renderSearchInputRightIcon

function returns React component for search input icon

TypeRequired
functionNo

onChangeSearchInputText

function callback when the search input text changes, this will automatically disable the dropdown's internal search to be implemented manually outside the component

TypeRequired
functionNo

MethodDescription
reset()Remove selection & reset it to display defaultButtonText check https://github.com/AdelRedaa97/react-native-select-dropdown/pull/1#issuecomment-818307624.
openDropdown()Open the dropdown.
closeDropdown()Close the dropdown.
selectIndex(index)Select a specific item by index.

License

MIT