react-dropdown-select

react-dropdown-select

Customisable dropdown select for react

Installation

npm install --save react-dropdown-select

Usage

import:

import Select from "react-dropdown-select";

and use as:

<Select
	placeholder="Select"
	addPlaceholder="+"
	multi={true}
	values={[options[0]]}
	options={options}
	onChange={(values) => this.setValues(values)}
	/>

Demo

Preview

https://sanusart.github.io/react-dropdown-select

Props	Type	Default	Description
Component props
values	array	[]	Selected values
options	array	[]	Available options
keepOpen	bool	false	If true, dropdown will always stay open (good for debugging)
dropdownGap	number	5	Gap between select element and dropdown
multi	bool	false	If true - will act as multi-select, if false - only one option will be selected at the time
placeholder	string	"Select..."	Placeholder shown where there are no selected values
addPlaceholder	string	"+"	Secondary placeholder on search field if any value selected
disabled	bool	false	Disable select and all interactions
style	object	{}	style object to pass to sselect
className	string		CSS class attribute to pass to sselect
loading	bool	false	loading indicator
clearable	bool	true	Clear all indicator
separator	bool	true	Separator line between close all and dropdown handle
dropdownHandle	bool	true	dropdown handle to open/close dropdown
searchBy	string	label	search by object property in values
labelField	string	"label"	field in data to use for label
valueField	string	"value"	field in data to use for value
closeOnScroll	bool	false	If true, scrolling the page will close the dropdown
Callback props
onChange	func		On values change callback, returns array of values objects
onDropdownClose	func		fires upon dropdown close
onDropdownOpen	func		fires upon dropdown open
onClearAll	func		fires upon clearing all values (via custom renderers)
onSelectAll	func		fires upon selecting all values (via custom renderers)
contentRenderer	func		Overrides internal content component (the contents of the select component)
itemRenderer	func		Overrides internal item in a dropdown
noDataRenderer	func		Overrides internal "no data" (shown where search has no results)
optionRenderer	func		Overrides internal option (the pillow with an "x") on the select content
inputRenderer	func		Overrides internal input text
loadingRenderer	func		Overrides internal loading
clearRenderer	func		Overrides internal clear button
separatorRenderer	func		Overrides internal separator
dropdownRenderer	func		Overrides internal dropdown component
dropdownHandleRenderer	func		Overrides internal dropdown handle