React Autocomplete Input Component

1  import { AutoComplete } from 'react-autocomplete-input-component';
2
3  <AutoComplete
4      list={[1, 'one', 2, 'two', 3, 'three']}
5      handleHighlight={(highlightedItem) => {
6        console.log(highlightedItem)
7      }}
8      onSelect={(selectedItem) => {
9        console.log(selectedItem)
10      }}
11  />

Demo

Check out more examples

Install

npm

1npm install --save react-autocomplete-input-component

Props

list: array

• array of the values to be searched for a match to the user input
• getDisplayValue is needed if list array contains objects
• can be passed in as an empty array and can always be changed dynamically

getDisplayValue: function (Optional)

• only needed if list contains objects
• function used to filter out the property value to be displayed in the dropdown

1<AutoComplete
2    list={[
3      { name: 'Tom', id: 3233 },
4      { name: 'Tommy', id: 3445 },
5      { name: 'Thomas', id: 3663 }
6    ]}
7    getDisplayValue={(list) => {
8      return list.map((listItem) => listItem.name)
9    }}
10  />

handleHighlight: function (Optional)

• callback function invoked when the highlighted item changes
• its only argument is the highlighted item's value from the original list
• if the highlighted item is a property value from an object, the whole object is passed in

onSelect: function (Optional)

• callback function invoked when an item is selected
• its only argument is the selected item's value from the original list
• if the selected item is a property value from an object, the whole object is passed in

handleNewValue: function (Optional)

• callback function invoked in place of onSelect when there is no matching value for the text input
• the input value is its only Argument
• if it is not passed in, the onSelect function will run with the text input being its only argument

1  import { AutoComplete } from 'react-autocomplete-input-component';
2
3  <AutoComplete
4      list={[1, 'one', 2, 'two', 3, 'three']}
5      onSelect={(selectedItem) => {
6        console.log(selectedItem)
7      }}
8      handleNewValue={(inputValue) => {
9        console.log(inputValue)
10      }}
11  />

onSelectError: function (Optional)

• used if new values are not permitted
• callback function invoked if onSelect fires when there is no match for the input value and the handleNewValue function is not passed in
• the input value is its only argument

noMatchMessage: string (Optional)

• message displayed in the dropdown when there is no match for the current input value
• default - will show no message
• if a string is passed in - it will be the message shown

1<AutoComplete
2    onSelectError={() => window.alert("TRY AGAIN")}
3    noMatchMessage={"No matches found"}
4  />

open : boolean (Optional)

• can be used to control the position of the dropdown
• true opens the dropdown and false closes the dropdown

onDropDownChange: function (Optional)

• callback function invoked whenever dropdown is opened or closed
• its only argument is the current position of the dropdown

1  const [openDropDown, setOpenDropDown] = useState()
2
3  const toggleDropDown = () => {
4    setOpenDropDown(openDropDown ? false : true)
5  }
6
7  return(
8    <>
9      <button className='ignore' onClick={toggleDropDown} />
10      <AutoComplete
11          onDropDownChange={(isOpen) => setOpenDropDown(isOpen)}
12          open={openDropDown}
13      />
14    </>
15  )

disableOutsideClick : boolean (Optional)

• false (default) the dropdown closes when mouse is clicked outside of the auto-complete wrapper div
• setting to true will disable the feature
• to ignore a specific element give the element a className of ignore

inputProps: Object (Optional)

• Sets HTMLInputElement properties with some exceptions
• autocomplete, onChange, onKeyDown, onFocus cannot be overridden

1  <AutoComplete
2      inputProps={{
3        placeholder: "search...",
4        onMouseOver: () => setOpenDropDown(true)
5      }}
6      showAll={true}
7      highlightFirstItem={false}
8  />

showAll: boolean (Optional)

• false (default) dropdown doesn't appear until input value matches an item's prefix
• true - If the input is focused and empty the dropdown displays all list items

highlightFirstItem: boolean (Optional)

• true (default) - automatically highlights first item in dropdown
• false - highlight is hidden until arrow key is pressed or hover with mouse

submit : boolean (Optional)

• can be used with controlSubmit to only fire onSelect or handleNewValue when passed in as true

controlSubmit: boolean (Optional)

• when set to true, onSelect and handleNewValue will only fire when submit is passed in as true

1  const [submit, setSubmit] = useState(false);
2
3  const toggleSubmit = (() => {
4    setSubmit(true)
5  })
6
7  return(
8    <>
9      <button className='ignore' onClick={toggleSubmit}>SUBMIT</button>
10      <AutoComplete
11          controlSubmit={true}
12          submit={submit}
13          onSelect={(selectedItem) => {
14            console.log(selectedItem)
15            setSubmit(false)
16          }}
17      />
18    </>
19  )

wrapperStyle: Object (Optional)

• Style Object for the div wrapping the whole component
• CSS can also be used with the class name autocomplete-wrapper

inputStyle: Object (Optional)

• Style Object for the input element
• CSS can also be used with the class name autocomplete-input

dropDownStyle: Object (Optional)

• Style Object for the dropdown container div
• CSS can also be used with the class name dropdown-container

listItemStyle: Object (Optional)

• Style Object for each item div in the dropdown
• CSS can also be used with the class name dropdown-item

highlightedItemStyle: Object (Optional)

• Style Object for the highlighted item
• CSS can also be used with the class name highlighted-item

1  <AutoComplete
2      highlightedItemStyle={{
3        backgroundColor: "dodgerBlue"
4      }}
5      listItemStyle={{
6        cursor: "pointer",
7        padding: "5px"
8      }}
9      dropDownStyle={{
10        backgroundColor: "antiquewhite",
11        width: "215px"
12      }}
13  />

Tests

Add to the tests: src/AutoComplete.test.js
Run the tests: npm test

Available Scripts

In the project directory, you can run:

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode.