Nosto / nosto-autocomplete

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

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.

About

License:BSD 3-Clause "New" or "Revised" License


Languages

Language:TypeScript 92.0%Language:Liquid 2.5%Language:CSS 2.2%Language:Mustache 2.2%Language:JavaScript 1.1%