# @dhruv-m-patel/react-autocomplete

> An autocomplete component built with react

Latest version **1.0.6** (published 2019-11-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install @dhruv-m-patel/react-autocomplete
pnpm add @dhruv-m-patel/react-autocomplete
yarn add @dhruv-m-patel/react-autocomplete
bun add @dhruv-m-patel/react-autocomplete
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.6 |
| Published | 2019-11-06 |
| First published | 2019-11-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 22 |
| Unpacked size | 19.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Dhruv Patel |
| Maintainers | dhruv-m-patel |
| Keywords | React, Autocomplete |

## Links

- npm: https://www.npmjs.com/package/@dhruv-m-patel/react-autocomplete
- Repository: https://github.com/dhruv-m-patel/react-autocomplete
- Issues: https://github.com/dhruv-m-patel/react-autocomplete/issues
- npm.io page: https://npm.io/package/@dhruv-m-patel/react-autocomplete

## Dependencies (22)

- [jest](https://npm.io/package/jest.md) 24.9.0
- [jsdom](https://npm.io/package/jsdom.md) ^15.1.1
- [enzyme](https://npm.io/package/enzyme.md) ^3.10.0
- [minify](https://npm.io/package/minify.md) ^4.1.3
- [rimraf](https://npm.io/package/rimraf.md) ^3.0.0
- [@babel/cli](https://npm.io/package/@babel/cli.md) ^7.6.4
- [babel-jest](https://npm.io/package/babel-jest.md) ^24.9.0
- [prop-types](https://npm.io/package/prop-types.md) 15.7.2
- [@babel/core](https://npm.io/package/@babel/core.md) ^7.6.4
- [@babel/node](https://npm.io/package/@babel/node.md) ^7.6.3
- [jest-enzyme](https://npm.io/package/jest-enzyme.md) ^7.1.1
- [@babel/runtime](https://npm.io/package/@babel/runtime.md) ^7.5.5
- [react-router-dom](https://npm.io/package/react-router-dom.md) ^5.0.1
- [@babel/preset-env](https://npm.io/package/@babel/preset-env.md) ^7.6.3
- [@babel/preset-react](https://npm.io/package/@babel/preset-react.md) ^7.6.3
- [babel-plugin-macros](https://npm.io/package/babel-plugin-macros.md) ^2.6.1
- [babel-preset-minify](https://npm.io/package/babel-preset-minify.md) ^0.5.1
- [react-test-renderer](https://npm.io/package/react-test-renderer.md) ^16.11.0
- [enzyme-adapter-react-16](https://npm.io/package/enzyme-adapter-react-16.md) ^1.15.1
- [@babel/plugin-transform-runtime](https://npm.io/package/@babel/plugin-transform-runtime.md) ^7.6.2
- [babel-plugin-css-modules-transform](https://npm.io/package/babel-plugin-css-modules-transform.md) ^1.6.2
- [@babel/plugin-transform-react-inline-elements](https://npm.io/package/@babel/plugin-transform-react-inline-elements.md) ^7.2.0

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 1.0.6 (latest) — 2019-11-06
- 1.0.5 — 2019-11-05
- 1.0.4 — 2019-11-05
- 1.0.3 — 2019-11-03
- 1.0.2 — 2019-11-03
- 1.0.1 — 2019-11-03
- 1.0.0 — 2019-11-03

## README

# react-autocomplete

React Autocomplete made with hooks

## Setup

```
$ npm i @dhruv-m-patel/react-autocomplete -S
```

## Simple Usage

Import the package using `import Autocomplete from '@dhruv-m-patel/react-autocomplete';`.
Import css using `import '/node_mobules/@dhruv-m-patel/react-autocomplete/dist/ReactAutocomplete.css';`

```jsx
<ReactAutocomplete
  options={[{ text: "option 1", value: 1 }, { text: "option 2", value: 2 }]}
  className="additionalClassYouWantToApply"
  value={1}
  onChange={handleChange} // Provides user types string back to consumer
  onSelectOption={handleSelectOption} // Provides user selected option object back to consumer
  onClearOptions={handleClearOptions} // Indicates no selection made, input needs to be cleared
/>
```

## With JSX options

```jsx
<ReactAutocomplete
  options={[
    { text: "option 1", value: "option 1", render: jsxFn },
    { text: "option 2", value: "option 2", render: jsxFn }
  ]}
  value="option 2"
  onChange={handleChange}
  onSelectOption={handleSelectOption}
  onClearOptions={handleClearOptions}
/>
```

### References:

- Creating a basic react-autocomplete: https://alligator.io/react/react-autocomplete
- Making autocomplete accessible: https://www.w3.org/TR/wai-aria-practices/examples/combobox/aria1.1pattern/listbox-combo.html

---
_Source: https://npm.io/package/@dhruv-m-patel/react-autocomplete · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._