StoreFront <gb-sayt> component
<gb-sayt>
This module requires @storefront/core for the component to render and receive data from GroupBy microservices.
@storefront/core
This module is meant to be used in a node environment which is bundled for use in the browser.
node
Use npm or yarn to install in a node project that uses webpack, browserify or similar.
npm
yarn
webpack
browserify
npm install --save @storefront/sayt # or yarn add @storefront/sayt
This module provides the <gb-sayt> component for use with StoreFront.
<!-- index.html --> <body> <gb-sayt></gb-sayt> </body>
// index.js storefront.mount('gb-sayt');
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:
src
yarn dev
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:
test
yarn tdd
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
Read the contributing file to learn about how to contribute to the StoreFront project.
StoreFront and its related packages are MIT licensed.
Generated using TypeDoc
StoreFront sayt
StoreFront
<gb-sayt>
componentGetting 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
oryarn
to install in anode
project that useswebpack
,browserify
or similar.npm install --save @storefront/sayt # or yarn add @storefront/sayt
Usage
This module provides the
<gb-sayt>
component for use with StoreFront.Mount tag
<!-- index.html --> <body> <gb-sayt></gb-sayt> </body>
// index.js storefront.mount('gb-sayt');
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
andtest
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.