react-combo-box
Version:
A React combo box component to handle primary and alternate field values.
91 lines (50 loc) • 1.56 kB
Markdown
A React combobox component to handle primary and alternate field values.
```
$ npm i react-combo-box
```
```
<ReactCombobox
name='email'
primary='john@example.com'
alternates={['john.doe@example.com', 'john_doe@example.com']}
onPrimaryUpdated={this.onPrimaryUpdated}
/>
```
**name** *Required*
Name of the field.
**primary** *Required*
Primary value to be displayed and edited.
**alternates**
Alternate values to be displayed.
**onPrimaryUpdated**
Callback when the primary value is altered.
**collapsed**
Initial collapsed status. Defaults to true.
**enableAnimation**
Enable "Make Primary" animation. Defaults to true.
**animationDuration**
Animation duration in ms. Defaults to 300.
**primaryInputClass**
Class to be applied to the primary input element.
**primaryInputHtmlOptions**
Object of Html options for the primary input element.
**toggleButtonClass**
Class to be applied to the toggle button class.
**alternateItemWrapperClass**
Class to be applied to the alternate values wrapping element.
**alternateValueClass**
Class to be applied to each alternate value entry.
**makePrimaryButtonClass**
Class to be applied to the "Make Primary" button.
**makePrimaryButtonText**
"Make Primary" button text. Defaults to "Make primary".
**showMoreButtonText**
"Show More" button text. Defaults to "Show N more" where N is the number of alternate values.
**showLessButtonText**
"Show less" button text. Defaults to "Show less".
MIT