Skip to content

Latest commit

 

History

History
50 lines (40 loc) · 1.25 KB

README.md

File metadata and controls

50 lines (40 loc) · 1.25 KB

AbbreviationAutocompleteReact

An autocomplete for abbreviations/acronyms searching by description rather than the abbreviation text.

autocomplete_screenshot

Install

npm i abbreviation-autocomplete-react

Props

data

The autocomplete search data

The options are an array of objects in the form

{
  a: "Abbreviation or Acronym",
  d: "Definition or Description"
}

e.g.

[
  {
    "a":"ICY",
    "d":"Icy Bay Airport"
  },
  {
    "a":"HGZ",
    "d":"Hog River Airport"
  }
]
limit(Optional)

The autocomplete results limit
Infinity by default

min-search-text-length(Optional)

The minimum number of characters typed before autocomplete results are displayed
1 by default

placeholder(Optional)

Placeholder text for the search text input

Functions

onSearchTextChange

Triggered whenever the search text changes
Emits the text of the autocomplete search

onSelect

Triggered after selecting an option in the dropdown
Emits the object representing the option selected