CLAUDE.md # InstantSearch monorepo Search UI libraries for Algolia across three flavors (vanilla JS, React, Vue), sharing one connector + UI-component core. Yarn 4 workspaces + Lerna (independent versioning). ## Repo map | Package | What it is | | --- | --- | | `packages/instantsearch.js` | **Core.** Vanilla JS library. **All connectors live here** (`src/connectors/`) and are shared by every flavor. | | `packages/react-instantsearch-core` | Headless React: hooks (`useSearchBox`, …) that wrap connectors. Framework-agnostic (web/RN). | | `packages/react-instantsearch` | React DOM widgets = hooks + UI from `instantsearch-ui-components`. | | `packages/vue-instantsearch` | Vue 2/3 components wrapping connectors. | | `packages/instantsearch-ui-components` | **Shared UI layer.** Framework-agnostic widget markup + `ais-*` classes via factory components (`createComponent({ createElement, Fragment })`); reused by React directly, Vue via `renderCompat`, JS via the Preact renderer. Newer widgets get their layout here; older ones still define it in `instantsearch.js/src/components/`. | | `packages/algoliasearch-helper` | Low-level search-parameter/state manager underneath connectors. Mature, separately-versioned; **rarely the place for a change** — fix the connector instead. See its `CLAUDE.md`. | | `packages/instantsearch.css` | Default themes. | | `packages/react-instantsearch-nextjs` / `-router-nextjs` | Next.js App Router / Pages Router integrations. | | `packages/create-instantsearch-app`, `instantsearch-cli`, `instantsearch-codemods` | Scaffolding / CLI / migration tooling. | Architecture in one line: **connector (logic, in instantsearch.js) → flavor wrapper (JS widget / React hook+component / Vue component) → shared UI components**. Change behavior in the connector; change markup in the UI layer. ## Where work goes (per layer) Because behavior lives in the connector and the flavors only wrap it, most changes have a natural home — and the per-package `CLAUDE.md` files carry each layer's conventions: | Work in… | Package | | --- | --- | | Connectors, JS widgets, runtime (`src/lib`), legacy Preact components (`src/components`), types | `packages/instantsearch.js` | | Shared framework-agnostic markup / `ais-*` classes | `packages/instantsearch-ui-components` | | React widgets/hooks + Next.js integrations | `react-instantsearch` / `react-instantsearch-core` / `*-nextjs` | | Vue components (Vue 2 **and** 3) | `vue-instantsearch` | For a **cross-flavor change**, settle the contract in the connector first, then update the React and Vue wrappers, then the common tests. If the change is to **shared markup/layout** (not behavior), it lives in `instantsearch-ui-components` and the flavors consume the result — a class/structure change there ripples to all flavors and `instantsearch.css` at once. **Adding or surfacing a connector option is always cross-flavor work** — settle the contract in the connector first, then thread it through React **and** Vue, then add/extend common tests. Don't wire one flavor and stop. The **`/expose-option

Name	Type	Description
advancedSyntax	boolean	Enable the advanced syntax. advancedSyntax on Algolia.com
allowTyposOnNumericTokens	boolean	Should the engine allow typos on numerics. allowTyposOnNumericTokens on Algolia.com
analytics	boolean	Enable the analytics analytics on Algolia.com
analyticsTags	string	Tag of the query in the analytics. analyticsTags on Algolia.com
aroundLatLng	string	Center of the geo search. aroundLatLng on Algolia.com
aroundLatLngViaIP	boolean	Center of the search, retrieve from the user IP. aroundLatLngViaIP on Algolia.com
aroundPrecision	number	Precision of the geo search. aroundPrecision on Algolia.com
aroundRadius	number	Radius of the geo search. aroundRadius on Algolia.com
minimumAroundRadius	number	Minimum radius of the geo search. minimumAroundRadius on Algolia.com
attributesToHighlight	string	List of attributes to highlight attributesToHighlight on Algolia.com
attributesToRetrieve	string	List of attributes to retrieve attributesToRetrieve on Algolia.com
attributesToSnippet	string	List of attributes to snippet attributesToSnippet on Algolia.com
disjunctiveFacets	Array.<string>	All the declared disjunctive facets
distinct	boolean\|number	Remove duplicates based on the index setting attributeForDistinct distinct on Algolia.com
facets	Array.<string>	All the facets that will be requested to the server
filters	string	Add filters to the query (similar to WHERE clauses) filters on Algolia.com
getRankingInfo	integer	Enable the ranking informations in the response getRankingInfo on Algolia.com
hitsPerPage	number	Number of hits to be returned by the search API hitsPerPage on Algolia.com
ignorePlurals	boolean	Should the plurals be ignored ignorePlurals on Algolia.com
insideBoundingBox	string	Geo search inside a box. insideBoundingBox on Algolia.com
insidePolygon	string	Geo search inside a polygon. insidePolygon on Algolia.com
maxValuesPerFacet	number	Number of values for each facetted attribute maxValuesPerFacet on Algolia.com
minWordSizefor1Typo	number	Number of characters to wait before doing one character replacement. minWordSizefor1Typo on Algolia.com
minWordSizefor2Typos	number	Number of characters to wait before doing a second character replacement. minWordSizefor2Typos on Algolia.com
optionalWords	string	Add some optional words to those defined in the dashboard optionalWords on Algolia.com
page	number	The current page number page on Algolia.com
query	string	Query string of the instant search. The empty string is a valid query. query on Algolia.com
queryType	string	How the query should be treated by the search engine. Possible values: prefixAll, prefixLast, prefixNone queryType on Algolia.com
removeWordsIfNoResults	string	Possible values are "lastWords" "firstWords" "allOptional" "none" (default) removeWordsIfNoResults on Algolia.com
replaceSynonymsInHighlight	boolean	Should the engine replace the synonyms in the highlighted results. replaceSynonymsInHighlight on Algolia.com
restrictSearchableAttributes	string	Restrict which attribute is searched. restrictSearchableAttributes on Algolia.com
synonyms	boolean	Enable the synonyms synonyms on Algolia.com
tagFilters	string	Contains the tag filters in the raw format of the Algolia API. Setting this parameter is not compatible with the of the add/remove/toggle methods of the tag api. tagFilters on Algolia.com
typoTolerance	string	How the typo tolerance behave in the search engine. Possible values: true, false, min, strict typoTolerance on Algolia.com

.template.js

Application generation lifeycle

`config` object

App.js.hbs

config.json

.template.js

Application generation lifeycle

config object

App.js.hbs

config.json

`config` object

AI Agent Protocol & Instructions

Explore Related Technologies & Topics