Essentials for VirtueMart User Guide

The following documentation explains the installation and configuration steps of the Essentials for VirtueMart component. The component adds Wishlist, Product Comparison and Quick View features to VirtueMart shops.

Installation

You can download the latest installation packages from our site's download page for Essentials for VirtueMart. If you have an older version of Joomla! or VirtueMart or PHP please check the compatibility section to find the version of Essentials for VirtueMart compatible with your Joomla!, VirtueMart and PHP versions.

All Essentials for VirtueMart installation packages contain the component and all of its associated extensions. Installing it will install all of these items automatically. It can also be used to upgrade Essentials for VirtueMart; just install it without uninstalling the previous release.

Uninstallation

You can uninstall the component just like any other Joomla! component. In your site's back-end, just go to Extensions Manager, click on Uninstall, select Essentials for VirtueMart - Package and click on Uninstall. This will completely remove Essentials for VirtueMart Package including all plugins, modules and database information.

Configuration

General

Essentials for VirtueMart General Configuration

General/global settings for Essentials for VirtueMart System.

Enable Wishlist System

If yes, wishlist system is enabled.

Enable Compare System

If yes, product comparison system is enabled.

Enable Quick View System

If yes, quick view feature is enabled.

Button Placement

Place Add to Wishlist, Add to Compare and Quick View buttons to products.

Automatic Placement

If yes, add to compare, add to wishlist and quick view buttons are added to each products automatically. Automatic button placement is designed considering default VirtueMart layout. If you are using a 3rd party template or overriding VirtueMart layouts then this feature may not properly.

Buttons Position

Select where the buttons to be placed in the product layouts. Available options are -

  1. Before Add to Cart Form
  2. After Add to Cart Form
  3. Before Price
  4. After Price
Manual Button Placement

The component allows you to manually place Add to Compare, Add to Wishlist and Quick View buttons in your product layouts. You need to use the following JHtml functions to display the buttons at your desired locations.

Add to Wishlist Button:

<?php echo JHtml::_('vmessentials.addtowishlist', $product, $iconOnly); ?>

Add to Compare Button:

<?php echo JHtml::_('vmessentials.addtocompare', $product, $iconOnly); ?>

Quick View Button:

<?php echo JHtml::_('vmessentials.quickview', $product, $iconOnly); ?>

As you can see, the above three functions require two variables -

  1. $product (object): This is the standard VirtueMart product object.
  2. $iconOnly (boolean): If true only icon is displayed else text is also included after the icon.

If you decide to manually place the buttons then you should disable Automatic Placement option.

Wishlist

Essentials for VirtueMart Wishlist Configuration

Global settings for Wishlist System.

Maximum Items

Maximum number of items that can be added to individual's wishlist.

Enable Guest Wishlist

If yes, guest users will be allowed add items to wishlist.

Use Cookies

If yes, guest wishlist is saved in browser cookie.

Allow Not Orderable Products

If yes, not orderable products are allowed to be added to wishlist.

Add to Wishlist Button
Use Ajax

If yes, products are added to wishlist over Ajax.

Add Button CSS Class

CSS class of Add to Wishlist button.

Added Button CSS Class

CSS class of Add to Wishlist button after the product is added to wishlist.

Add Icon CSS Class

CSS class of Add to Wishlist icon.

Added Icon CSS Class

CSS class of Add to Wishlist icon after the product is added to wishlist.

Wishlist Page
Add to Cart

If show, add to cart option is displayed in wishlist.

Compare

Global settings for Product Comparison System.

Essentials for VirtueMart Compare Configuration
Maximum Items

Maximum number of items that can be compared at a time.

Allow Not Orderable Products

If yes, not orderable products are allowed to be added to compare.

Add to Compare Button
Use Ajax

If yes, products are added to compare over Ajax.

Add Button CSS Class

CSS class of Add to Compare button.

Added Button CSS Class

CSS class of Add to Compare button after the product is added to comparison.

Add Icon CSS Class

CSS class of Add to Compare icon.

Added Icon CSS Clas

CSS class of Add to Compare icon after the product is added to comparison.

Comparison Page
Essentials for VirtueMart Compare Configuration
Product Image

If show, product image is displayed in product comparison.

SKU

If show, product SKU is displayed in product comparison.

Product Rating

If show, product rating is displayed in product comparison.

Price

If show, product price is displayed in product comparison.

Product Category

If show, product category is displayed in product comparison.

Manufacturer

If show, manufacturer is displayed in product comparison.

Short Description

If show, short description is displayed in product comparison.

Description

If show, product description is displayed in product comparison.

Add to Cart

If show, add to cart is displayed in product comparison.

Quick View

If show, quick view option is displayed in product comparison.

Add to Wishlist

If show, add to wishlist is displayed in product comparison.

Product Length

If show, product length is displayed in product comparison.

Product Width

If show, product width is displayed in product comparison.

Product Height

If show, product height is displayed in product comparison.

Product Weight

If show, product weight is displayed in product comparison.

Product Packaging

If show, product packaging is displayed in product comparison.

Units in Box

If show, units in box is displayed in product comparison.

Availability

If show, product availability is displayed in product comparison.

Stock Status

If show, product stock status is displayed in product comparison.

Custom Fields

If show, selected custom fields are displayed in product comparison.

Custom Fields to Show

Select the custom fields to show in product comparsion.

Ordering

Drag and drop the product variables to change the display ordering.

Essentials for VirtueMart Compare Configuration

Quick View

Global settings for Quick View System.

Quick View Button
Button CSS Class

CSS class of Quick View button.

Icon CSS Class

CSS class of Quick View icon.

Quick View Page
Add to Cart Button

If show, add to cart option is displayed in quick view.

Add to Compate Button

If show, add to compare option is displayed in quick view.

Add to Wishlist Button

If show, add to wishlist option is displayed in quick view.

Advanced

Advanced settings of Essentials for VirtueMart System.

Essentials for VirtueMart Advanced Configuration
Load Font Awesome

If yes, Font Awesome iconic font and CSS toolkit is loaded.

Load Style Sheet

If yes, Essentials for VirtueMart Style Sheet (CSS) is loaded.

Live Updates

Essentials for VirtueMart Live Updates Configuration
Download Key

Add to your VirtuePlanet Membership Download Key to receive live updates.