https://github.com/ejmudi/react-autocomplete-hint

A React component for Autocomplete Hint.
https://github.com/ejmudi/react-autocomplete-hint

autocomplete lookahead react typeahead

Last synced: 7 days ago
JSON representation

A React component for Autocomplete Hint.

• Host: GitHub
• URL: https://github.com/ejmudi/react-autocomplete-hint
• Owner: ejmudi
• License: mit
• Created: 2020-07-25T13:42:22.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-03-02T21:35:48.000Z (over 1 year ago)
• Last Synced: 2024-10-28T12:37:58.007Z (16 days ago)
• Topics: autocomplete, lookahead, react, typeahead
• Language: TypeScript
• Homepage: https://ejmudi.github.io/react-autocomplete-hint/
• Size: 1.52 MB
• Stars: 164
• Watchers: 3
• Forks: 16
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# react-autocomplete-hint

A React component for Autocomplete Hint.

![NPM](https://img.shields.io/npm/l/react-autocomplete-hint)

![npm](https://img.shields.io/npm/v/react-autocomplete-hint)

[![Build Status](https://travis-ci.com/ejmudi/react-autocomplete-hint.svg?branch=master)](https://travis-ci.com/ejmudi/react-autocomplete-hint)

[![codecov](https://codecov.io/gh/ejmudi/react-autocomplete-hint/graph/badge.svg)](https://codecov.io/gh/ejmudi/react-autocomplete-hint)

![](demo/demo.gif)

## Demo

Demo can be found here: [https://ejmudi.github.io/react-autocomplete-hint/](https://ejmudi.github.io/react-autocomplete-hint/)

## Installation

```

npm install --save react-autocomplete-hint

```

or

```

yarn add react-autocomplete-hint

```

## Usage

```jsx

import { Hint } from 'react-autocomplete-hint';

const options = ["orange", "banana", "apple"];

// OR

const options = [

    {id: 1, label: "orange"}, 

    {id: '2', label: "banana"}, 

    {id: 3, label: "apple"}

];

     setText(e.target.value)} />

```

Click on the hint or use your keyboard **Right** key, **Tab** key (if `allowTabFill` is set to true), or **Enter** key (if `allowEnterFill` is set to true) to fill your input with the suggested hint.

## Props

#### options (required): `Array | Array`

#### disableHint (optional): `Boolean`

#### allowTabFill (optional): `Boolean`

#### allowEnterFill (optional): `Boolean`

#### onFill (optional): `(value: string | object)=> void`

#### onHint (optional): `(value: string | object | undefined)=> void`

#### valueModifier (optional): `(value: string)=> string`

## object option

If you're using objects for your options. object schema is as follows:

#### id: `string | number`

#### label: `string`

## onFill

Returns the option selected immediately the input is filled with the suggested hint. 

Note that it won't return the selected option with the casing the user typed, rather it returns the option with the casing specified in your options prop. For example, if the options are specified like this:...

```jsx

const options = ["orange", "banana", "apple"];

```

...and the input gets filled with *"ORange"*, onFill will still return *"orange"*.

## onHint

Returns the current hint.

## valueModifier

This prop accepts a function that modifies your input value before it is saved in state.

It is typically useful when you are not setting `e.target.value` directly in state and need to modify the target value to 

some other value first before setting it in state.

Example: A case where you need to set the input value to uppercase irrespective of the casing the user types in:

```jsx

const options = ["orange", "banana", "apple"];

const modifyValue = (value: string) => value.toUpperCase();

     setText(modifyValue(e.target.value))} />

```

Note: Not setting the `valueModifier` prop in cases like this might result to a malformed hint.

## Duplicate data

If you are using objects for your options, You may have unexpected results if your data options contain objects with duplicate labels. For this reason, it is highly recommended that you pass in objects with unique labels if possible.

For example, if you pass in `optionsWithDuplicateLabels` as seen below and you then fill the input with the *orange* hint, the orange will be the first orange object found in the array as can be seen in the `onFill` prop:

```jsx

const optionsWithDuplicateLabels = [

    {id: "1", label: "orange"},

    {id: "2", label: "orange"},

    {id: "3", label: "banana"}

];

 {

    // will always log {id: "1", label: "orange"} when orange is selected

    // {id: "2", label: "orange"} will never be logged.

    console.log(value);

}}>

     setText(e.target.value)} />

```

## License

[MIT](LICENSE)

Inspired by [React Bootstrap Typeahead](https://github.com/ericgio/react-bootstrap-typeahead).