jekyll-store-favourites

Favourite products/wish list plugin for Jekyll-Store Engine

Usage no npm install needed!

<script type="module">
  import jekyllStoreFavourites from 'https://cdn.skypack.dev/jekyll-store-favourites';
</script>

README

Jekyll-Store/Favourites

Build Status

Favourite products/wish list plugin for Jekyll-Store Engine.

Actions

favourite

Adds product to the favourites list.

Args:

  • name - Name of the product.

Example:

JekyllStoreEngine.Actions.favourite({ name: 'bag' });

removeFromFavourites

Remove product from the favourites list.

Args:

  • name - Name of the product.

Example:

JekyllStoreEngine.Actions.removeFromFavourites({ name: 'bag' });

FavouritesStore

The products that have been favourited.

Example output:

{
  favourites: Immutable({
    'Jumper': { name: 'Jumper', price: 24.30 },
    'Cardigan': { name: 'Cardigan', price: 21.45 },
    'Pullover': { name: 'Pullover', price: 13.90 }
  })
}

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request