@storefront/navigation

StoreFront <gb-navigation> component

Getting Started

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

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

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

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

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

<!-- index.html -->
<body>
  <gb-navigation></gb-navigation>
</body>

// index.js
storefront.mount('gb-navigation');

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

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

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.