Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Widget Use

Excerpt

Describe what the purpose of the widget is.

...

Renders the product comparison grid for Product search results.


Example of Widget Use

Following is an example of the widget in use:


 Image Added


Where can the Widget be placed?

The widget can be used in the following templates: 

  • Theme Layout Template


Widget Options

OptionUseCommentsAvailable from Version
Description
The
A short description of the widget
It is recommended to use this so the reason for use of the widget is seem from the template page
's use.This description is added to the widget title. It makes the widget's use clear on the template page.All
Layer

The layer

that

the widget

will be shown onThe layering technology allows for the content to be shown to specific audiences. This is handy
if the content is only valid for a certain type of user, or if the same widget is required for more than
one audience, but different configuration is needed. The widget can be added to the zone more
than once and the layer feature can determine which audience can see each widget 

is valid for.

Use layering to limit widget content to certain groups of users. 

To use the same widget for more than one user group but with different options set, add the widget as many times as needed in the same zone. Then add layering to define the user group each time

All
Title
  
The heading text displayed at the top of the widget.Default: Products to compare:3.78
Display Image?
   Image Prompt   
Whether the product image is displayed.

Default: enabled

Toggle to disable

3.78
Show Ribbons?Whether ribbons are displayed over the product image (where applicable).

Default: enabled

Toggle to disable

3.88
Display Title?
   Title Prompt    
Whether the product title is displayed.

Default: enabled

Toggle to disable

3.78
Display Product Code?
   Product Code Prompt  Display Availability?   
Determines whether the product code is displayed.

Default: enabled

Toggle to disable

3.78
Display APN?
   APN Prompt   Display Add To Cart?   
Whether the Australian Product Number is displayed.

Default: disabled

Toggle to enable

3.78
Display Availability?Whether stock availability is displayed.

Default: disabled

Toggle to enable

3.78
Use Role Flag To Hide Availability?
   In Stock Prompt   Out Of Stock Prompt   Show Quantities?   Display Price?   Price Prompt   Display RRP?   RRP Prompt   Show Unit Description?   Unit Description Prompt   Display Description?   Description Prompt   
Whether the role flag is obeyed in regard to stock availability display.

Default: disabled

Toggle to enable

3.78
Custom Availability Widget NameName of custom widget to display product availability in the Compare window.

Setting this field overrides the 'Display Availability' and 'Use Role Flag To Hide Availability' settings. Availability will instead be displayed based on the logic defined in the custom widget.

NOTE - Assistance from Commerce Vision may be required when creating this custom widget.t

3.88
Show Quantities?Whether available quantity is displayed.

Default: disabled

Toggle to enable

3.78
Display Price?Whether product price is displayed.

Default: enabled

Toggle to disable

3.78
Display RRP?Determines whether product RRP is displayed.

Default: disabled

Toggle to enable

3.78
Show Unit Description?Determines whether unit of issue is displayed.

Default: disabled

Toggle to enable

3.78
Display Description?Determines whether the product description is displayed.

Default: enabled

Toggle to disable

3.78
Display Add To Cart?Determines whether an Add To Cart button is displayed.

Default: enabled

Toggle to disable

3.78
Increase Quantities In Pack Qty?
 This will make the values
Forces the value in the quantity
box go up and down by pack quantity values when clicking on the plus and minus icons 
field to increase/decrease in pack quantities instead of the default quantity of 1 when the plus/minus icons are used.

Default: disabled

Toggle to enable

3.78
Add Minimum Quantity to Cart?If a minimum quantity has been set for the product, add this quantity to cart.

Default: disabled

Toggle to enable


Hide When No Products?Hide Product Compare when there are no products to compare?

Default: enabled

Toggle to disable


Buttons
Add To Cart Button TextText on Add To Cart button.Default: Add To Cart3.78
Prompts
Image PromptLabel for the product image.
3.88
Title PromptLabel for the product title field.Default: Title3.88
Product Code PromptLabel for the product code field.
   

 

 

...

Default: Product Code3.88
APN PromptLabel for the Australian Part Number field.

Default: Product Code

3.88
Price PromptLabel for the price field.Default: Price3.78
RRP PromptLabel for the RRP field.Default: RRP3.78
Unit Description PromptLabel for the unit of issue field.Default: Unit3.78
Description PromptLabel for the description field.Default: Description3.78
Show / Hide Toggle LabelLabel on the show / hide toggle. 

Default: Comparing {0} Products

{0} - placeholder for the product count to display.

3.88
Availability Text
In Stock PromptText displayed for available products.Default: In Stock3.78
Low Stock PromptText displayed for low stock products.Default: Low Stock
Out Of Stock PromptText displayed for unavailable products.Default: Out Of Stock3.78

Implementation Guide

 Product Compare Functionality

Related Widgets

Content by Label
AND
showLabelsfalse
spacesKB
showSpacefalse
sortcreation
showSpaceexcerptfalsetrue
reversetrue
excerptoperatortrueANDoperator
cqllabel = "widget" and space = "KB" and title ~ "'product list compare'"
labelswidget cms