README

Super Favourite adds wishlist-style favourites to Craft CMS. Users can save Craft elements into collections, keep personal or global lists, add notes, and manage favourite data from the Control Panel or templates.

Features

• Favourite Craft elements such as entries, assets, categories, users, tags, and Commerce elements.
• Organize saved items into global collections or user-owned collections.
• Restrict a collection to specific element types.
• Add custom fields to collections and favourite items.
• Manage collections and favourites from the Craft Control Panel.
• Use Twig variables, element queries, frontend actions, and PHP services.

Requirements

• Craft CMS 5
• PHP 8.0.2 or newer

Installation

For local development, add the plugin as a path repository in the Craft project's composer.json, then install it:

composer require amici/craft-super-favourite
php craft plugin/install super-favourite

You can also install it from Settings -> Plugins in the Craft Control Panel.

For the full setup flow, see Installation and Setup.

Documentation

Detailed docs are split by task:

• Documentation Home
• Installation and Setup
• Core Concepts
• Backend Guide
• Frontend Collection Forms
• Frontend Favourite Forms
• Twig Usage
• PHP API
• Routes and Actions
• Troubleshooting

Control Panel

The plugin adds a Super Favourite section with:

• Collections for creating global, user, and default collections.
• Favourites for managing saved items.
• Settings for plugin limits and field layouts.

Permissions

The plugin registers permissions for viewing and managing favourites and collections:

• super-favourite:view-favourites
• super-favourite:manage-favourites
• super-favourite:view-collections
• super-favourite:manage-collections
• super-favourite:manage-global-collections

License

Proprietary - Copyright (c) 2024 Amici Infotech