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

Widget Use

Renders a list on the product detail page, with the option to add hyperlinks to other content.

 

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 Detail Template

 

Widget Options

OptionUseCommentsAvailable from Version
Description

A 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
Layer

The 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
Product FieldThe product field from which to draw data. This would often be a custom field created solely for this list information.

Please note - values in this product field should be entered in a semicolon-separated list. If there are links, a pipe symbol should separate the display value from the link value, e.g. 'Display text|Link value;Display text|Link value;'

For example: Technical Specifications|Specs102134.pdf;Safety Data Sheets|SDS102134.pdf;Warranty Info|Warranty102134.pdf

All
Show Heading?Determines whether a heading will be displayed.

Default is: ticked

Untick to disable

All
Heading TextThe heading text (where heading is enabled). All
List DirectoryIf your list contains links to items like PDFs, use this field to specify the folder in which they live.For example: /documents/All
Show Toggle?Determines whether the section can be expanded and collapsed by the user. The content is collapsed by default and expanded when the user clicks the toggle arrows.

Default is: ticked

Untick to disable

All
Show As List?

Determines whether the items are displayed in unordered list format (e.g. bullet points).

When enabled, our example data would display as shown here, with links to the relevant PDF files:

  • Technical Specifications
  • Safety Data Sheets
  • Warranty Info

When disabled, the data would display as follows:

Technical Specifications Safety Data Sheets Warranty Info

Default is: ticked

Untick to disable

All

 

Show On Mobile?Determines whether the widget is displayed on a mobile device. If unticked, the list field 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.