{"id":13450646,"url":"https://github.com/lowewenzel/use-autocomplete","last_synced_at":"2025-04-11T17:43:35.802Z","repository":{"id":42365495,"uuid":"261553460","full_name":"lowewenzel/use-autocomplete","owner":"lowewenzel","description":"React use-autocomplete hook for autocomplete components","archived":false,"fork":false,"pushed_at":"2023-01-05T19:58:29.000Z","size":7878,"stargazers_count":7,"open_issues_count":18,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-10-30T01:04:46.479Z","etag":null,"topics":["autocompletion","hook","react"],"latest_commit_sha":null,"homepage":"https://autocomplete.wnzl.dev/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/lowewenzel.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-05-05T18:34:29.000Z","updated_at":"2022-08-02T04:37:50.000Z","dependencies_parsed_at":"2023-02-04T13:45:48.528Z","dependency_job_id":null,"html_url":"https://github.com/lowewenzel/use-autocomplete","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lowewenzel%2Fuse-autocomplete","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lowewenzel%2Fuse-autocomplete/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lowewenzel%2Fuse-autocomplete/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lowewenzel%2Fuse-autocomplete/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lowewenzel","download_url":"https://codeload.github.com/lowewenzel/use-autocomplete/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248452018,"owners_count":21105992,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["autocompletion","hook","react"],"created_at":"2024-07-31T07:00:36.938Z","updated_at":"2025-04-11T17:43:35.779Z","avatar_url":"https://github.com/lowewenzel.png","language":"TypeScript","funding_links":[],"categories":["Packages"],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\n## React use-autocomplete\n\n[![npm version](https://badge.fury.io/js/use-autocomplete.svg)](https://badge.fury.io/js/use-autocomplete)\n\n\u003c/div\u003e\n\n## About\n\nThis is a hook, `useAutocomplete`, that returns autocomplete values using a prefix tree. This is for front-end autocompletion rather than remote autocompletion, which is more commonly used.\n\nUse it in any input component, see [examples](./examples) for more.\n\n## How to install\n\nRun the following to install the hook\n\n```bash\nyarn install react-autocomplete\n```\n\n## How to use\n\nImport from `use-autocomplete` and pass in the search term and list of values. Small example:\n\n#### With fake data\n\n```js\nimport React, { useState } from 'react';\nimport useAutocomplete from 'use-autocomplete';\n\nimport testWords from './data/testWords.json';\n\nconst Example = () =\u003e {\n  const [textState, setTextState] = useState('');\n  const [completions] = useAutocomplete(textState, testWords);\n\n  return (\n    \u003cdiv\u003e\n      \u003cinput\n        type='text'\n        value={textState}\n        onChange={(e) =\u003e setTextState(e.target.value)}\n      /\u003e\n      \u003cdiv\u003e\n        {completions.map((val, index) =\u003e (\n          \u003cp key={index}\u003e{val}\u003c/p\u003e\n        ))}\n      \u003c/div\u003e\n    \u003c/div\u003e\n  );\n};\n```\n\n#### Data conversion\n\n```js\nimport React, { useState } from 'react';\nimport useAutocomplete from 'use-autocomplete';\n\nconst Example = ({ someSampleObject }) =\u003e {\n  const [textState, setTextState] = useState('');\n  const [completions] = useAutocomplete(\n    textState,\n    Object.keys(someSampleObject)\n  );\n\n  return (\n    \u003cdiv\u003e\n      \u003cinput\n        type='text'\n        value={textState}\n        onChange={(e) =\u003e setTextState(e.target.value)}\n      /\u003e\n      \u003cdiv\u003e\n        {completions.map((val, index) =\u003e (\n          \u003cp key={index}\u003e{val}\u003c/p\u003e\n        ))}\n      \u003c/div\u003e\n    \u003c/div\u003e\n  );\n};\n```\n\n\u003ca name=\"contributing\"\u003e\u003c/a\u003e\n\n## Contributing\n\nPull requests welcome!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flowewenzel%2Fuse-autocomplete","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flowewenzel%2Fuse-autocomplete","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flowewenzel%2Fuse-autocomplete/lists"}