kuriousagency/lists

Allow users to add elements to a list: Product Favourites, Wishlists, Bookmarks, etc.

Lists plugin for Craft CMS 3.x

Allow users to add elements to a list: Product Favourites, Wishlists, Bookmarks, etc., _(*1)

Requirements

This plugin requires Craft CMS 3.0.0-beta.23 or later., _(*2)

Installation

To install the plugin, follow these instructions., _(*3)

1. Open your terminal and go to your Craft project:, _(*4)

   cd /path/to/project

2. Then tell Composer to load the plugin:, _(*5)

   composer require kuriousagency/lists

3. In the Control Panel, go to Settings → Plugins and click the “Install” button for Lists., _(*6)

Lists Overview

This is a plugin that allows you to create lists of elements. Lists can contain a mixture of element types., _(*7)

Using Lists

Lists come with 2 predefined list types: Favourites & Wishlists., _(*8)

Favourites is a single list that contains products., _(*9)

Example Form

Variables

get an element criteria model of favourites:, _(*10)

craft.lists.getFavourites(userId)

if no user id is passed in then the current user will be used., _(*11)

get an array of wishlists:, _(*12)

craft.lists.getWishlists(userId)

get lists:, _(*13)

craft.lists.getLists(type, userId)

type is a string of whatever you want the list type to be?, _(*14)

check to see if a product is in the favourites list:, _(*15)

craft.lists.isFavourite(productId, userId)

check to see if an element is in a list:, _(*16)

craft.lists.isInList(type, elementId, userId)

if no user id is passed in then the current user will be used., _(*17)

Lists Roadmap

Some things to do, and ideas for potential features:, _(*18)

• Might have a cp interface to see the lists?

Brought to you by Kurious Agency, _(*19)