1
0
Fork 0
docsearch/README.md
2020-09-01 12:01:48 +02:00

29 lines
1.3 KiB
Markdown

# Autocomplete
Suite of Autocomplete libraries to build fast and fully-featured autocomplete experiences.
---
[![Version](https://img.shields.io/npm/v/autocomplete.js.svg?style=flat-square)](https://www.npmjs.com/package/autocomplete.js) [![jsDelivr Hits](https://data.jsdelivr.com/v1/package/npm/autocomplete.js/badge?style=flat-square)](https://www.jsdelivr.com/package/npm/autocomplete.js) [![MIT License](https://img.shields.io/badge/License-MIT-green.svg?style=flat-square)](LICENSE)
## Why
You should be using Autocomplete if you want to:
- Display suggestions as you type
- Support input completion
- Support custom templates for UI flexibility
- Create custom interactions and behaviors based on your sources
- Plug the Algolia realtime search engine
## Packages
| Package | Description | Documentation |
| --- | --- | --- |
| [`docsearch-js`](packages/docsearch-js) | JavaScript package for DocSearch | [Documentation](https://autocomplete-experimental.netlify.app/docs/docsearch-js) |
| [`docsearch-react`](packages/docsearch-react) | React package for DocSearch | [Documentation](https://autocomplete-experimental.netlify.app/docs/DocSearch) |
| [`docsearch-css`](packages/docsearch-css) | Styles for DocSearch | [Documentation](https://autocomplete-experimental.netlify.app/docs/docsearch-css) |
## License
[MIT](LICENSE)