Documentation
Feedback
Guides
VTEX IO Apps

VTEX IO Apps
Glossary
vtex.search
Version: 2.18.9
Latest version: 2.18.9

Repo-local terms used in vtex.search. For cross-repo terminology (segment, trade policy, facets wire format, reserved facet keys, etc.), see is-io-specs/docs/glossary.md.

TermMeaning
AutocompleteThe suggestion dropdown rendered while the shopper is typing in a search input. Implemented by the autocomplete-result-list.v2 block (react/Autocomplete.js).
autocomplete-result-list.v2The active autocomplete block exported by this app. Requires product-summary as a child. There is no .v1 exported here.
did-you-meanA search-correction prompt rendered on the search results page when the IS backend suggests a spell-corrected query. Component: react/DidYouMean.js.
search-suggestionsText-side suggestions list (separate from product suggestions). Component: react/Suggestions.js.
search-bannerA banner slot driven by IS results metadata. Component: react/Banner.js.
BiggyClientThe Apollo-client wrapper exported from react/index.ts for host apps. Source: react/utils/biggy-client.ts. Exposes topSearches, suggestionSearches, suggestionProducts, plus searchHistory / prependSearchHistory cookie helpers.
biggy-search-history cookieLocal search history rendered by Autocomplete. Format: comma-joined list capped at 5 entries. Owned by this repo.
sp-variant cookieA/B variant identifier read by BiggyClient.suggestionProducts and passed to IS as the variant GraphQL variable. Read-only here; written elsewhere by the IS A/B routing system.
vtex.store-resourcesPlatform app providing the GraphQL queries this repo issues (QueryAutocompleteSearchSuggestions, QuerySuggestionProducts, QueryTopSearches). All search queries this app makes go through here.
react/models/search-product.tsTypeScript interface for the product shape returned by IS for autocomplete previews.
prereleasyThe manifest.json:scripts.prereleasy hook (bash pre.sh). Runs as part of vtex release.
Legacy node/ foldernode/package.json and node/yarn.lock exist but no node builder is declared in manifest.json. Treat as dead — Toolbelt does not package it.
See also
Vtex.search
VTEX IO Apps
VTEX App Store
VTEX IO Apps
Was this helpful?