Giter Site home page Giter Site logo

taurgis / plugin_filternavigation Goto Github PK

View Code? Open in Web Editor NEW
7.0 4.0 0.0 130 KB

This plugin enhances the app_storefront_base cartridge by keeping track of search navigation through asynchronous actions.

License: MIT License

JavaScript 100.00%

plugin_filternavigation's Introduction

plugin_filternavigation: Storefront Reference Architecture (SFRA)

This is the repository for the plugin_filternavigation plugin. This plugin enhances the app_storefront_base cartridge by keeping track of search navigation through asynchronous actions, including the following capabilities:

  • Moving back and forth between filter changes
  • Go back to the PLP from a PDP without losing your location

Demo

Demonstration

Cartridge Path Considerations

The plugin_filternavigation plugin requires the app_storefront_base cartridge. In your cartridge path, include the cartridges in the following order:

plugin_filternavigation:app_storefront_base

Getting Started

  1. Clone this repository. (The name of the top-level folder is plugin_filternavigation.)
  2. In the top-level plugin_filternavigation folder, enter the following command: npm install. (This command installs all of the package dependencies required for this plugin.)
  3. In the top-level plugin_filternavigation folder, edit the paths.base property in the package.json file. This property should contain a relative path to the local directory containing the Storefront Reference Architecture repository. For example:
"paths": {
    "base": "../storefront-reference-architecture/cartridges/app_storefront_base/"
}
  1. In the top-level plugin_filternavigation folder, enter the following command: npm run compile:js && npm run compile:scss
  2. In the top-level plugin_filternavigation folder, enter the following command: npm run uploadCartridge

For information on Getting Started with SFRA, see Get Started with SFRA.

NPM scripts

Use the provided NPM scripts to compile and upload changes to your sandbox.

Compiling your application

  • npm run compile:js - Compiles all js files and aggregates them.

Note: The plugin cartridge must be compiled after compiling storefront-reference-architecture (SFRA base) cartridge.

Linting your code

npm run lint - Execute linting for all JavaScript and SCSS files in the project.

Watching for changes and uploading

npm run watch - Watches everything and recompiles (if necessary) and uploads to the sandbox. Requires a valid dw.json file at the root that is configured for the sandbox to upload.

plugin_filternavigation's People

Contributors

taurgis avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

plugin_filternavigation's Issues

Predictive Sort

Hi there

Sorry this is more a question than issue.
Are you able to let us know how this works with Predictive Sort?
Predictive Sort means product listings (PLP) sort order can change from request to request. And no caching is done on PLP.
In terms of "Go back to the PLP from a PDP without losing your location" - is Predictive Sort supported?

Zamil

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.