StoreFront structure

StoreFront structural components, building blocks for high-level components

Getting Started

This module requires @storefront/core for the components to render.

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/structure
# or
yarn add @storefront/structure

Usage

This module provides a number of structural components for use with StoreFront.

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

Components

• <gb-badge>
• <gb-button>
• <gb-container>
• <gb-custom-select>
• <gb-icon>
• <gb-link>
• <gb-list>
• <gb-list-item>
• <gb-native-select>
• <gb-raw>
• <gb-select>
• <gb-select-option>
• <gb-toggle>

Contributing

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

License

StoreFront and its related packages are MIT licensed.