Documentation
Feedback
Guides
VTEX IO Apps

VTEX IO Apps
Glossary
vtex.search-result
Version: 3.147.0
Latest version: 3.147.0

Domain vocabulary used in vtex.search-result.

TermDefinition
PLP (Product Listing Page)The shopper-facing search/category page. This app provides the bulk of its blocks.
BlockA composable Store Framework unit declared in store/interfaces.json and instantiated via store/blocks.json. Each block maps to a React component exported by react/index.js.
InterfaceThe block declaration: { component, allowed, required, composition, content }. Lives in store/interfaces.json.
Content SchemaJSON Schema describing the props a block can be configured with via Site Editor. Lives in store/contentSchemas.json.
GalleryThe block (gallery) that renders the product grid. Components: Gallery.tsx, GalleryLegacy.tsx, GalleryLayout.tsx, GalleryLayoutOption.tsx, GalleryLayoutSwitcher.tsx.
Filter NavigatorFaceted filtering blocks. Three implementations coexist:
FilterNavigatorLegacyfilter-navigator.v1 and the unversioned filter-navigator alias
FilterNavigatorfilter-navigator.v2, allows shop-review-summary and sidebar-close-button
FilterNavigatorFlexible — flexible-layout-aware variant
Layout SwitcherThe block (gallery-layout-switcher) that lets shoppers toggle layout modes. Composed via children.
Search Result LayoutContainer block (search-result-layout) for the new flexible layout. Allows search-result-layout.desktop, .mobile, and search-not-found-layout. Companion search-result-layout.customQuery accepts the same children.
Search ContentBlock (search-content) requiring gallery + not-found. Wraps the SSR/CSR boundary.
vtex-test-toolsVTEX's Jest wrapper used by react/package.json's test script. Provides preconfigured Jest + Babel + jsdom setup. There is no separate jest.config.js.
vtex.search-page-contextDependency providing SearchPageContext — exposes search state (query, total, results) to descendant blocks via React context.
vtex.product-summary / vtex.shelfDependencies providing the product card / shelf renderers that this app's gallery uses.
vtex.store-graphqlDependency providing the GraphQL schema for store-side queries (productSearch, facets, etc. — wraps vtex.search-graphql).
Pixel Managervtex.pixel-manager — fires storefront analytics events (productClick, productImpression, etc.) when shoppers interact with gallery items.
Pickup-in-point PreferencelocalStorage['vtex.search.pickupInPoint'] — shared key with vtex.delivery-promise-components. Persisted pickup-point selection that adjusts PLP filtering.
See also
Vtex.search Result
VTEX IO Apps
VTEX App Store
VTEX IO Apps
Was this helpful?