UI libraries / Autocomplete / API reference

The autocomplete-js package is an agnostic virtual DOM renderer. You can use it in JavaScript, Preact, React, or Vue projects. Renderers provide a UI to headless autocomplete experiences built with autocomplete-core.

Custom renderers are an advanced pattern that you should only use when hitting the limits of autocomplete-js. For instance, you might need your own renderer when working with a JavaScript library that doesn’t use a virtual DOM or when the layout structure of autocomplete-js is too constraining for your use case.

autocomplete This function creates an autocomplete experience and attaches it to an element of the DOM.
getAlgoliaResults Retrieve Algolia results from one or several indices with autocomplete-js.
getAlgoliaFacets Retrieve Algolia facet hits from one or several indices with autocomplete-js.
Did you find this page helpful?