Page tree
Skip to end of metadata
Go to start of metadata

Widget Use

Gives the user various layout options to choose from when viewing a list of products.

 

Example of Widget Use

Following is an example of the widget in use:

 

Where can the Widget be placed?

The widget can be used in the following templates:

  • Product List Template
  • Cluster Item Zoned Template

 

Widget Options

OptionUseCommentsAvailable from Version
DescriptionA short description of the widget's use.We recommended this field be updated so the widget's purpose is clear at a glance from the template page.All
LayerThe layer the widget is valid for.

The 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. 

All
List Types

The layout options offered to the user, in comma-separated format. You can feature up to 3 different types. Choose from:

  • Grid
  • List
  • DetailList
Default is: Grid,DetailedListAll
List Prompts

The labels for the layout options offered to the user, in comma-separated format. The order should correspond to the List Types offered. Common labels:

  • Grid
  • List
  • Detailed List
Default is: Grid,ListAll
List IconsThe icons displayed to the left of each list prompt, in comma-separated format. The order should correspond to the List Types offered.Default is: cv-ico-general-layout,cv-ico-general-listAll
List ClassesThe class applied to the wrapping container for each list type, in comma-separated format. The order should correspond to the List Types offered.Default is: grid,detailed-listAll
Use Default List Types?Determines whether the default list types specified for B2B vs B2C are used for those audiences.If there is more than 1 of this widget on the page, please only set this for one of them.All
B2B Default ListThe default list layout for B2B users who have not already selected or changed their list type.Default is: DetailedListAll
B2C Default ListThe default list layout for B2C users who have not already selected or changed their list type.Default is: GridAll
Container Class / IDThe element class or ID which wraps the list.

Default is: #product-grid

Refer to your site's style guide for options.

All
Auto Scroll To Top?Determines whether the user is automatically scrolled to the top of the page after changing the list type.

Default is: unticked

Tick to enable

All
Scroll Container Class / IDThe element class or ID to scroll to during auto-scroll.Default is: #product_display_containerAll
Scroll SpeedThe speed at which the page scrolls to the top of the list. It can be represented with words like slow or fast, or in milliseconds (600).Default is: fastAll
Show On Mobile?Determines whether the widget is displayed on a mobile device. If unticked, the layout switch will be hidden on mobile devices.

Default is: ticked

Untick to disable

All

 

 

Other Widgets

  • Page:
    Account Payment Detail Widget Renders the payment detail information in the body of the various Account Payment confirmation emails. Information includes (but is not limited to) the order number, account number, invoice, and amount paid.
  • Page:
    Dashboard Recent Invoices Widget — Displays the logged in user's 5 most recent invoices, with a link to each invoice in detail, as well as a 'View All' option.
  • Page:
    Dashboard Account Status Widget — Displays a list of the user's customer account status, including balance owing and payment terms, as well as links to statements and the account payment page.
  • Page:
    Dashboard Articles Widget — Displays a list of the site's news articles, with an image, title, a 'read more' link, and the article expiry date.
  • Page:
    Dashboard Product Favourites Widget — Displays a list of the user's top 5 favourite products, with links to each product page, as well as an add to cart button.
  • Page:
    Dashboard Back Orders Widget — Displays a list of the user's backorders with links to the order detail page.
  • Page:
    Social Sharing Plugin Widget — Acts as a placeholder to output customised javascript based on content from Add This (social network Share buttons, for example).
  • Page:
    Return Lines Widget Where product Returns functionality is in use, renders the return order lines (product, quantity, price, etc.) on the return entry page.
  • Page:
    Return Information Widget — Where product Returns functionality is in use, renders the details input section (reason, number of parcels) on the returns entry page.
  • Page:
    Return Confirmation Summary and Lines Static Widget Where product Returns functionality is in use, renders the return order lines (product, quantity, price, etc.) on the confirmation page after the user submits their return request.
  • Page:
    Return Confirmation Return Info Widget Where product Returns functionality is in use, renders the return details (reason, number of parcels) on the confirmation page after the user submits their return request.
  • Page:
    Return Confirmation Address Widget Where product Returns functionality is in use, renders the pickup address details on the confirmation page after the user submits their return request.
  • Page:
    Return Confirmation Message Widget Where product Returns functionality is in use, renders messages to the user on the confirmation page to advise that their return is in progress + next steps.
  • Page:
    APR Verification Required Widget Where Auto Part (B2B) Registration + automatic approval functionality is in use, renders the message content to the new user, advising that they must verify their email address in order to be approved.
  • Page:
    APR Auto Approval Notification Widget Where Auto Part (B2B) Registration + automatic approval functionality is in use, renders the message content to the admin to advise that a new user is in the process of being automatically approved.