2.0.0 • Published 3 years ago

@super-effective/react-dropdown-input v2.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
3 years ago

react-dropdown-input

A React Dropdown Input (Select)

Install

NPM:

npm install @super-effective/react-dropdown-input

Yarn:

yarn add @super-effective/react-dropdown-input

Usage

Import the component:

import ReactDropdownInput from '@super-effective/react-dropdown-input';

Render the component in your code:

const options = [
  { id: 'test1', content: <span>test1</span> },
  { id: 'test2', content: <span>test2</span> },
];
<ReactDropdownInput options={options} onItemSelected={onItemSelected} selectedItemId="test1" />

Props

PropTypeDetails
borderColor?stringThe border colorDefault: #cdcdcf
borderWidth?number\|stringThe border widthDefault: 1
borderRadius?number\|stringThe border radiusDefault: 4
borderStyle?stringThe border style (e.g. solid, dashed, etc.)Default: solid
dropDownClassName?stringThe className to apply to the dropdown
dropDownStyle?React.CSSPropertiesThe styles to apply to the dropdown
excludeSelectedOption?booleanExclude the selected option from the listDefault: false
fluid?booleanDisplay the dropdown as a fluid item (no division between the value and the dropdown)Default: false
optionsDropdownInputOption[]The array options { id: string; content: ReactNode; }
padding?numberPadding - applies to the drop down itself and its items
paddingHorizontal?numberHorizontal padding - applies to the drop down itself and its items (overrides padding)Default: 12
paddingVertical?numberVertical padding - applies to the drop down itself and its items (overrides padding)Default: 8
placeholder?ReactNodeThe content to display when no option is selectedDefault: " "
selectedOptionClassNamestringThe className to apply to the selected option
toggleIconReactNodeThe element to display as the toggle icon
valuestringThe id of the selected option
onChange(id: string) => voidThe callback function to be called when the selected option changes
2.0.0

3 years ago

1.0.1

3 years ago

1.0.0

3 years ago