MCPcopy
hub / github.com/algolia/instantsearch

github.com/algolia/instantsearch @1.8.13 sqlite

repository ↗ · DeepWiki ↗ · release 1.8.13 ↗
3,616 symbols 13,655 edges 1,859 files 105 documented · 3%
README

InstantSearch.js

InstantSearch is a JavaScript library for building performant and instant search experiences in vanilla JS, React and Vue with <a href="https://www.algolia.com/?utm_source=instantsearch.js&utm_campaign=repository">Algolia</a>.

License Build Status

InstantSearch is a JavaScript library that lets you create an instant-search result experience using Algolia’s search API.

There are multiple wrappers for popular frameworks, such as React InstantSearch and Vue InstantSearch.

It is part of the InstantSearch family which is designed for different platforms:

InstantSearch | InstantSearch Android | InstantSearch iOS

Table of contents

Packages

Package Version Description
algoliasearch-helper algoliasearch-helper npm version Helper for implementing advanced search features with Algolia
create-instantsearch-app create-instantsearch-app npm version Command-line utility to quickly bootstrap a project with InstantSearch
instantsearch.css instantsearch.css npm version Default CSS themes for InstantSearch
instantsearch.js instantsearch.js npm version InstantSearch.js
react-instantsearch react-instantsearch npm version React InstantSearch bundled library
react-instantsearch-core react-instantsearch-core npm version Runtime-independent React InstantSearch version
vue-instantsearch vue-instantsearch npm version Vue InstantSearch

Contributing

We welcome all contributors, from casual to regular 💙

  • Bug report. Is something not working as expected? Send a bug report.
  • Feature request. Would you like to add something to the library? Send a feature request.
  • Documentation. Did you find a typo in the doc? Open an issue and we'll take care of it.
  • Development. If you don't know where to start, you can check the open issues that are tagged easy, the bugs or chores.

To start contributing to code, you need to:

  1. Fork the project
  2. Clone the repository
  3. Install the dependencies: yarn
  4. Pick a package to work on and cd into it (e.g. cd packages/react-instantsearch)

Please read our contribution process to learn more.

License

InstantSearch is MIT licensed.

Extension points exported contracts — how you extend this code

PlainSearchParameters (Interface)
(no doc) [1 implementers]
packages/algoliasearch-helper/index.d.ts
ProcessEnv (Interface)
(no doc)
global.d.ts
Window (Interface)
(no doc)
packages/algolia-experiences/src/setup-instantsearch.ts
DevtoolsOptions (Interface)
(no doc)
packages/instantsearch.css/devtools/index.d.ts
Window (Interface)
(no doc)
packages/react-instantsearch-nextjs/src/InstantSearchNext.tsx
PendingPromise (Interface)
(no doc)
packages/react-instantsearch-core/src/lib/wrapPromiseWithState.ts
Element (Interface)
(no doc)
packages/instantsearch-ui-components/global.d.ts
TemplateWithBindEventParams (Interface)
(no doc)
packages/instantsearch.js/src/types/templates.ts

Core symbols most depended-on inside this repo

wait
called by 1336
tests/utils/wait.ts
createSearchClient
called by 1051
tests/mocks/createSearchClient.ts
addWidgets
called by 885
packages/instantsearch.js/src/lib/InstantSearch.ts
createSingleSearchResponse
called by 702
tests/mocks/createAPIResponse.ts
cx
called by 606
packages/instantsearch-ui-components/src/lib/cx.ts
createInitOptions
called by 517
packages/instantsearch.js/test/createWidget.ts
createRenderOptions
called by 482
packages/instantsearch.js/test/createWidget.ts
algoliasearchHelper
called by 478
packages/algoliasearch-helper/index.js

Shape

Function 3,331
Method 121
Interface 90
Class 74

Languages

TypeScript100%
Java1%

Modules by API surface

examples/js/e-commerce/polyfills.js121 symbols
examples/js/e-commerce-umd/polyfills.js121 symbols
packages/react-instantsearch/src/__tests__/common-widgets.test.tsx33 symbols
packages/vue-instantsearch/src/__tests__/common-widgets.test.js32 symbols
packages/instantsearch.js/src/__tests__/common-widgets.test.tsx30 symbols
tests/e2e/playwright/fixtures.ts29 symbols
packages/instantsearch.js/src/widgets/index/index.ts29 symbols
packages/react-instantsearch/src/__tests__/common-connectors.test.tsx27 symbols
scripts/lint/instantsearch-oxlint-plugin.mjs25 symbols
packages/algoliasearch-helper/index.d.ts24 symbols
packages/instantsearch.js/src/connectors/chat/connectChat.ts22 symbols
packages/instantsearch.js/src/widgets/chat/chat.tsx21 symbols

Dependencies from manifests, versioned

@akryum/vue-cli-plugin-ssr0.5.0 · 1×
@algolia/autocomplete-js{{libraryVersion}} · 1×
@algolia/autocomplete-theme-classic{{libraryVersion}} · 1×
@algolia/client-common5.1.1 · 1×
@algolia/client-search5.1.1 · 1×
@algolia/events4.0.1 · 1×
@babel/core7.29.0 · 1×
@babel/eslint-parser7.17.0 · 1×
@babel/plugin-proposal-class-properties7.14.5 · 1×
@babel/preset-env7.15.6 · 1×
@babel/preset-react7.14.5 · 1×
@babel/preset-typescript7.15.0 · 1×

For agents

$ claude mcp add instantsearch \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact