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

Widget Use

Renders the 'Filter By' options on the product list page. Customers can filter their search or browsing results by metadata values such as Brand, Size, Colour, and so forth.

 

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

 

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
Allow Combinations?

Determines whether the user is permitted to filter by more than one variable at a time. When enabled, the user can select multiple filter options and click the button to apply them all.

Note that when combinations are enabled, the entire list of filter options will be presented, not just those options which contain products.

Default is: unticked

Tick to enable

All
Show Clear All?Determines whether the 'Clear All' option is presented to allow the user to remove all filters at once.

Default is: unticked

Tick to enable

All
Default Expanded Filters

A comma-separated list of filters that you would like automatically expanded on page load.

 

Note - Filter names are case-sensitive and should not include spaces.

Example: Brand,Colour,Size
All
Show Price Filter?Determines whether a price filter option is presented, allowing filtering based on the integrated price for a product (NOT the calculated price).

Default is: unticked

Tick to enable

All
Default Price Filter Expanded?Determines whether the price filter is automatically expanded on page load, so that the price slider is always visible.

Default is: unticked

Tick to enable

All
Show Default Minimum and Maximum Price FiltersDetermines whether the min/max values specified here in the widget will be used when there are no min/max values associated with the category.

Default is: unticked

Tick to enable

3.94
Default Price Filter MinThe minimum price value to be used if there is no min on the category itself. 3.94
Default Price Filter MaxThe maximum price value to be used if there is no max on the category itself. 3.94
Show Product Feature Count?

Determines whether a product count is displayed next to the feature name in the Filter list on selection.

For example - filtering by brand would display as "Apple (18)" if there are 18 product results when 'Apple' is selected.

Default is: unticked

Tick to enable

3.92
Add Filtered Attribute Prefix?

Determines whether the metadata type is prefixed to the selected filter.

For example - "Currently Filtered By: (Brand) Reflex" rather than "Currently Filtered By: Reflex".

Default is: unticked

Tick to enable

3.90
Include Please Select Option In Mobile View? 

Default is: unticked

Tick to enable

 
Preview Top 5 Values

Displays the Top 5 (by number of results) filter values only, with a 'see more' indicator for the user to display all. This keeps filter options with many values from obstructing other filters on the page.

Default is: unticked

Tick to enable

3.95
Notifications
No Filters Message The text displayed when no metadata is present to filter by.Default is: There are no filter options availableAll
Buttons
Combination Button LocationDetermines the location of the 'Apply' button (top or bottom).

Default is: Bottom

Select via drop-down

All
Prompts
Filter By PromptThe heading text displayed at the top of the widget.Default is: Filter ByAll
Current Filter PromptThe heading text displayed above the filters that are currently in use.Default is: Currently Filtered By...All
Clear All PromptThe label for the Clear All option.Default is: Clear All FiltersAll
Price Filter PromptThe label for the price slider.Default is: Price RangeAll

 

 

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.