Versions Compared

Key

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

Widget Use

Excerpt

This widget allows the user to perform Displays a product search while giving with the option of specifying the results to be within a certain category. Failure to use the category option will return standard search results.

 

to specify results from a particular category. 

If the user does not select a category, the standard search results (from all categories) will apply.


Example of Widget Use

Following is an example of the widget in use:

Image RemovedImage Added


Where can the Widget be placed?

The widget can be used in the following templates:

  • Available on all templatesAll Templates
    • Recommended
    use on Theme Layout
    • placement: Theme Layout Template, in place of standard Product Search
    Bar

...


Widget Options

All
OptionUseCommentsAvailable from Version
DescriptionA short description of the widget's use.We recommend 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
Placeholder TextThe placeholder text is the free text that auto populates the search field while there is no focus on the search field. This free text disappears once the user clicks within the field.

Default is "Search products..."

Enter new text to change placeholder text

AllAll Categories TextDetermines the text that is displayed when the user is searching within the "All Categories" range

Default is "All Categories"

Enter new text to change All Categories text

AllSearch Button TextDetermines the text that is displayed within the button that is clicked by the user to initiate the search function.

Default is "Search"

Enter new text to change Search button text

Use Suggestions?When this option is enabled, suggested searches will be offered to the user. These are based on previously entered (successful) search terms over a defined period.

Default is: enabled

Untick to disable

3.90
Use Product Suggestions?

When this option is enabled, the user will be offered suggested products in a dropdown. They can highlight and select any suggested product to be redirected to its detail page.

These suggestions are based on Lucene index data.

Default is: enabled

Untick to disable

3.90
Use Prior Purchase?Determines whether an option is displayed to the user to search within their prior purchases (rather than searching the entire site).

Default is: disabled

Tick to enable

3.90
Use User Favourites?Determines whether Favourites appears as an option in the category selector. If so, the user can choose to search within their favourite products instead of a product category.

Default is: enabled

Untick to disable

3.90
Search Page URLDetermines the URL that is used to search.

Default is

"/search"

Enter new text to change URL text

AllUse SuggestionsDetermines if product suggestions are used

Ticked by Default

Untick to Disable

AllInclude User FavouritesDetermines if user favourites appear as an option in the categories drop down menu

Ticked by Default

Untick to Disable

AllUser Favourites TextDetermines the text of the Favourites option in the categories dropdown down menu

Default is "User Favourites"

Enter new text to change User Favourites text

All

 

...

: /search


3.90
Show Product Image?Determines whether a thumbnail image is included in the product search suggestions drop-down.

Default is: disabled

Tick to enable

4.03
Show Product Code?

Determines whether the product code is appended to the description in the suggestions dropdown.

Note - this option is only compatible with product suggestions ('Use Product Suggestions?' option). Product codes do not show against search suggestions ('Use Suggestions?' option).

Default is: disabled

Tick to enable

4.03
Show APN Instead Of Product CodeDetermines whether the Australian Product Number is displayed in lieu of the product code.

Default is: disabled

Tick to enable

4.03
Place Holder ImageThe file path for the fallback image used for products with no image found.Default is: /Themes/BPDTHEME01/theme-client-updates/img/placeholder/product-image.png 4.03
Show Product Suggestions Heading?If the "Use Product Suggestions" option is enabled, you can display a heading above the suggested products with this option.

Default is: enabled

Tick to disable

4.03
Show Search Suggestions Heading?If the "Use Suggestions" option is enabled, you can display a heading above the suggested search terms with this option.

Default is: enabled

Tick to disable

4.03
Titles
Product Suggestions Heading TextThe heading displayed above suggested products (when "Show Product Suggestions Heading" option is enabled).Default is: Product Suggestions4.03
Search Suggestions Heading TextThe heading displayed above suggested search terms (when "Show Search Suggestions Heading" option is enabled).Default is: Search Suggestions4.03
Buttons
Search Button TextThe text displayed on the search button.Default is: Search4.03
Prompts
Search User Favourites TextThe prompt text that appears next to the user favourites search option (where Search Favourites is enabled). 

Default is: User Favourites


3.90
Search Prior Purchases TextThe prompt text that appears next to the prior purchase search option (where Prior Purchase is enabled). Default is: Prior Purchases4.03
Search Place HolderThe background text displayed in the search field while there is no focus on the field. This text disappears once the user clicks within the field.

Default is: Product Search


3.90
All Categories TextDetermines the text that is displayed when the user is searching within the "All Categories" range.

Default is: All Categories


3.90 - 4.02 only



Other Widgets

Content by Label
showLabelsfalse
spacesKB
showSpacefalse
sortcreation
excerpttrue
reversetrue
excerptTypesimple
operatorAND
cqllabel = "cms" and label = "widget" and space = "KB"
labelswidget cms