https://github.com/firelemons/abbreviationautocompletereact

An autocomplete for abbreviations/acronyms searching by description rather than the abbreviation text.
https://github.com/firelemons/abbreviationautocompletereact

autocomplete component component-library react

Last synced: 22 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/firelemons/abbreviationautocompletereact
• Owner: FireLemons
• License: mit
• Created: 2021-01-16T18:08:22.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2022-04-07T14:26:52.000Z (over 2 years ago)
• Last Synced: 2024-04-24T00:44:07.312Z (8 months ago)
• Topics: autocomplete, component, component-library, react
• Language: JavaScript
• Homepage:
• Size: 129 KB
• Stars: 5
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# AbbreviationAutocompleteReact

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

![autocomplete_screenshot](https://raw.githubusercontent.com/FireLemons/DocumentationMaterials/main/img/abbreviation-autocomplete-react.png)

### [Live Example](https://firelemons.github.io/AutocompleteExample/react/)

## 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