Skip to content

Nosto/nosto-autocomplete

Repository files navigation

Nosto Autocomplete

Docs typedoc npm coverage semantic-release

The library is designed to simplify the implementation of Search Autocomplete functionality by providing:

      🌟 Autocomplete products, keywords and history visualization.
      🔄 Automatic bindings to Nosto Search API.
      🧩 Autocomplete component state management.
      📊 Nosto Analytics out of the box, Google Analytics support.
      🏗️ Default Autocomplete components and templates.
      🎮 Keyboard navigation.

💾 Installation

You can install the Nosto Autocomplete library via npm:

npm install @nosto/autocomplete

The Nosto Autocomplete library can be imported and used in various ways, depending on your preferred framework or template language.

Framework Import Statement
Base import { autocomplete } from "@nosto/autocomplete"
Mustache import { autocomplete, fromMustacheTemplate, defaultMustacheTemplate } from "@nosto/autocomplete/mustache"
Liquid import { autocomplete, fromLiquidTemplate, defaultLiquidTemplate } from "@nosto/autocomplete/liquid"
Preact import { autocomplete, Autocomplete } from "@nosto/autocomplete/preact"
React import { autocomplete, Autocomplete } from "@nosto/autocomplete/react"

Choose the import method that aligns with your project's requirements and technology stack.

❗Do not combine multiple imports as it will fetch multiple bundles.❗

📚 Documentation

Read Nosto Techdocs for more information on how to use the library.

Library TypeDoc page includes detailed library helpers documentation and examples.