@storefront/breadcrumbs
v2.10.0
Published
StoreFront breadcrumbs component
Downloads
129
Readme
StoreFront breadcrumbs
StoreFront <gb-breadcrumbs>
component
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/breadcrumbs
# or
yarn add @storefront/breadcrumbs
Usage
This module provides the <gb-breadcrumbs>
component for use with StoreFront.
Mount tag
<!-- index.html -->
<body>
<gb-breadcrumbs></gb-breadcrumbs>
</body>
// index.js
storefront.mount('gb-breadcrumbs');
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.