@storefront/query

2.9.0 • Public • Published

StoreFront query

StoreFront <gb-query> component

npm (scoped with tag) license API Reference

Getting Started

This module requires @storefront/core for the component to render and receive data from GroupBy microservices.

Prerequisites

This module is meant to be used in a node environment which is bundled for use in the browser.

Installing

Use npm or yarn to install in a node project that uses webpack, browserify or similar.

npm install --save @storefront/query
# or
yarn add @storefront/query

Usage

This module provides the <gb-query> component for use with StoreFront.

Mount tag

<!-- index.html -->
<body>
  <gb-query></gb-query>
</body>
// index.js
storefront.mount('gb-query');

Building the package

To build an individual package, run the following command:

yarn build

To build an individual package in response to changes within the src directory, run the following command:

yarn dev

Running tests

To test an individual packages, run the following command:

yarn test

To test an individual package in response to changes within the src and test directories, run the following command:

yarn tdd

Linting

To lint a package, run the following command:

yarn lint

To programmatically fix lint errors within a package, run the following command:

yarn lint:fix

Contributing

Read the contributing file to learn about how to contribute to the StoreFront project.

License

StoreFront and its related packages are MIT licensed.

Package Sidebar

Install

npm i @storefront/query

Weekly Downloads

3

Version

2.9.0

License

MIT

Unpacked Size

33 kB

Total Files

32

Last publish

Collaborators

  • effervescentia
  • groupby-ci
  • groupbyops