VTEX IO Store Framework app (vtex.search-result) that exports the PLP (Product Listing Page) blocks for VTEX storefronts: galleries, filter navigators, sort controls, layout switchers, pagination, and "not found" states.
It is the storefront consumer of the GraphQL surface published by vtex.search-graphql and implemented by vtex.search-resolver. It also coordinates with vtex.delivery-promise-components for pickup-point shipping facets on PLP.
See
AGENTS.mdfor the full architectural walkthrough.
- Node.js 12 (managed via
.nvmrc— usenvm use). Note: Node 12 is the legacy CI target while this app's dependency tree is migrated. Use a project-local Node manager to avoid affecting other repos. - Yarn (v1)
- VTEX Toolbelt:
npm i -g vtex - An active VTEX account and development workspace:
vtex login <account>
Install dependencies and refresh VTEX IO typings:
make devLink the app to your development workspace:
make link
# or equivalently: make runLinking publishes the React blocks to the active workspace. Confirm with vtex whoami before linking.
Run the React unit test suite (via vtex-test-tools):
make testRun all quality checks (lint + test) before opening a PR:
make checkRun with coverage report:
make coverage
⚠️ These commands affect production. Always confirm the target account/workspace first.
vtex publish # publishes a new app package to the registry
vtex deploy # promotes a release candidate to stableVersion bumps use vtex release <patch|minor|major> stable. The current default branch for releases is master.
- Architecture and block contracts:
AGENTS.md - Domain glossary:
docs/glossary.md - Data model:
docs/data-model.md - SDD model guide:
docs/sdd/model-guide.md - Specs (multi-repo aggregator):
is-io-specs/.specify/— constitution, plans, tasks live in the parent - Block reference, props, content schemas:
docs/,store/interfaces.json,store/contentSchemas.json - Changelog:
CHANGELOG.md