npm i @dpdfe/rc-pinyin-select


React Select

by react-component

0.0.8 (see all)License:MITTypeScript:Built-In
npm i @dpdfe/rc-pinyin-select


React Select

NPM version npm download build status Test coverage Dependencies DevDependencies bundle size



  • support IE11+,Chrome,Firefox,Safari


  • Open select (focus input || focus and click)
  • KeyDown/KeyUp/Enter to navigate menu




basic use

import Select, { Option } from 'rc-select';

export default () => (
    <Option value="jack">jack</Option>
    <Option value="lucy">lucy</Option>
    <Option value="yiminghe">yiminghe</Option>


Select props

idhtml id to set on the component wrapperString''
classNameadditional css class of root dom nodeString''
data-*html data attributes to set on the component wrapperString''
prefixClsprefix classString''
animationdropdown animation name. only support slide-up nowString''
transitionNamedropdown css animation nameString''
choiceTransitionNamecss animation name for selected items at multiple modeString''
dropdownMatchSelectWidthwhether dropdown's with is same with selectbooltrue
dropdownClassNameadditional className applied to dropdownString-
dropdownStyleadditional style applied to dropdownObject{}
dropdownAlignadditional align applied to dropdownObject{}
dropdownMenuStyleadditional style applied to dropdown menuObject{}
notFoundContentspecify content to show when no result matches.ReactNode'Not Found'
tokenSeparatorsseparator used to tokenize on tag/multiple modestring[]?
opencontrol select openbool
defaultOpencontrol select default openbool
placeholderselect placeholderReact Node
showSearchwhether show search input in single modebooltrue
showArrowwhether show arrowbooltrue (single mode), false (multiple mode)
allowClearwhether allowClearboolfalse
tagswhen tagging is enabled the user can select from pre-existing options or create a new tag by picking the first choice, which is what the user has typed into the search box so far.boolfalse
tagRenderrender custom tags.(props: CustomTagProps) => ReactNode-
maxTagTextLengthmax tag text length to shownumber-
maxTagCountmax tag count to shownumber-
maxTagPlaceholderplaceholder for omitted valuesReactNode/function(omittedValues)-
comboboxenable combobox mode(can not set multiple at the same time)boolfalse
multiplewhether multiple selectboolfalse
disabledwhether disabled selectboolfalse
filterOptionwhether filter options by input value. default filter by option's optionFilterProp prop's valuebooltrue/Function(inputValue:string, option:Option)
optionFilterPropwhich prop value of option will be used for filter if filterOption is trueString'value'
filterSortSort function for search options sorting, see Array.sort's compareFunction.Function(optionA:Option, optionB: Option)-
optionLabelProprender option value or option children as content of selectString: 'value'/'children''value'
defaultValueinitial selected option(s)String | String[]-
valuecurrent selected option(s)String | String[] | {key:String, label:React.Node} | {key:String, label:React.Node}[]-
labelInValuewhether to embed label in value, see above value type. Not support combobox modeBoolfalse
backfillwhether backfill select option to search input (Only works in single and combobox mode)Boolfalse
onChangecalled when select an option or input value change(combobox)function(value, option:Option | Option[])-
onSearchcalled when input changedfunction-
onBlurcalled when blurfunction-
onFocuscalled when focusfunction-
onPopupScrollcalled when menu is scrolledfunction-
onSelectcalled when a option is selected. param is option's value and option instanceFunction(value, option:Option)-
onDeselectcalled when a option is deselected. param is option's value. only called for multiple or tagsFunction(value, option:Option)-
onInputKeyDowncalled when key down on inputFunction(event)-
defaultActiveFirstOptionwhether active first option by defaultbooltrue
getPopupContainercontainer which popup select menu rendered intofunction(trigger:Node):Nodefunction(){return document.body;}
getInputElementcustomize input elementfunction(): Element-
showActionactions trigger the dropdown to showString[]?-
autoFocusfocus select after mountBool-
autoClearSearchValueauto clear search input value when multiple select is selected/deselectedbooleantrue
inputIconspecify the select arrow iconReactNode-
clearIconspecify the clear iconReactNode-
removeIconspecify the remove iconReactNode-
menuItemSelectedIconspecify the item selected iconReactNode | (props: MenuItemProps) => ReactNode-
dropdownRenderrender custom dropdown menu(menu: React.Node, props: MenuProps) => ReactNode-
loadingshow loading icon in arrowBooleanfalse
virtualDisable virtual scrollBooleantrue
directiondirection of dropdown'ltr' | 'rtl''ltr'


focusfocus select programmably--
blurblur select programmably--

Option props

classNameadditional class to optionString''
disabledno effect for click or keydown for this itemboolfalse
keyif react want you to set key, then key is same as value, you can omit valueString/number-
valuedefault filter by this attribute. if react want you to set key, then key is same as value, you can omit valueString/number-
titleif you are not satisfied with auto-generated title which is show while hovering on selected value, you can customize it with this propertyString-

OptGroup props

labelgroup labelString/React.Element-
valuedefault filter by this attribute. if react want you to set key, then key is same as value, you can omit valueString-


npm install
npm start


local example: http://localhost:9001/

online example: http://select.react-component.now.sh/

Test Case

npm test


npm run coverage


rc-select is released under the MIT license.

No alternatives found
No tutorials found
Add a tutorial
No dependencies found

Rate & Review

No reviews found
Be the first to rate