Overview:

svelte-algolia-instantsearch is a community-developed wrapper around instantsearch.js for Svelte. It is not officially affiliated or backed by Algolia. It aims to provide a similar API to react-instantsearch-hooks-web for Svelte. This library is specifically designed to work with SvelteKit, which is now the default when bootstrapping a Svelte project.

Features:

Installation: Provides a guide on how to install the theme.
Basic usage: Offers basic usage instructions for the theme.
Compatibility with SvelteKit SSR: Provides information on the compatibility of the theme with SvelteKit SSR.
Components: Offers pre-made components that can be used to build a search UI, including Breadcrumb, Configure, ClearRefinements, CurrentRefinements, DynamicWidgets, HierarchicalMenu, Highlight, Hits, HitsPerPage, Index, InfiniteHits, Menu, Pagination, PoweredBy, RangeInput, RefinementList, SearchBox, Snippet, SortBy, Stats, and ToggleRefinement.
API: Includes the connect function, which creates and adds a widget to the InstantSearch instance and returns a Svelte readable store.
getInstantSearchContext: Returns the instance of InstantSearch that was instantiated by the <InstantSearch> component. This can be useful when using the instantsearch.js API directly, such as adding a custom middleware.

Summary:

svelte-algolia-instantsearch is a wrapper library for instantsearch.js, designed specifically for Svelte and SvelteKit. It provides a similar API to react-instantsearch-hooks-web and offers a variety of pre-made components to build a search UI. With its connect function and getInstantSearchContext function, developers have flexible options for creating custom search experiences in Svelte projects.

Aymeric Giraudet

Svelte Algolia Instantsearch