Options
All
  • Public
  • Public/Protected
  • All
Menu

Package @storefront/products

StoreFront products

StoreFront <gb-products> 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/products
# or
yarn add @storefront/products

Usage

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

Mount tag

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

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.

Index

Type aliases

Transformer

Transformer: function

Type declaration

    • Parameters

      Returns object

      • data: object
      • meta: any
      • variants: object[]

Generated using TypeDoc