Versions Compared

Key

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

...

Excerpt

Renders an input field and search button, allowing the user to conduct product and content searches.  You You can customise the widget to offer search term or keyword, product and suggestions.


Example of Widget Use

...

Product Search with placeholder textProduct Search with product suggestions

Image RemovedImage Added

Image RemovedImage Added


Where can the Widget be placed?

The widget can be used in the following templates:

  • All Templates
  • Required: Theme Layout Template


Implementation guides

...

OptionUseCommentsAvailable from Version
DescriptionA short description of the widget's use.We recommended 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 configurations are 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
Static Content Search

Select whether the system should include products or static content, such as Articles, or both in the keyword search results.

Image Removed

Default: disabled

The default is to search only products to match keywords. Change to include content pages such as articles and blogs.

Include Static Content Search:

Search results will display

Searches both products and static content that

matches

match the keyword(s).

Static Content Search Only:

Do not show products that match the keyword search.This parameter will display

Searches products only. 

NOTE - Including static content options are shown only when Content Search is enabled.

Refer to the Implementation Guide for more details.
Default: disabled


4.14.00
Use Suggestions?

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

Default is: enabled

Untick Toggle to disable

All
Use Product Suggestions?

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

These suggestions are based on Lucene index data.

Default is: enabled

Untick Toggle to disable

All
Use Prior Purchase?Determines whether an option is displayed to the user can choose to search within from only their prior purchases (rather than searching the entire siteall available products).

Default is: disabled

Tick Toggle to enable

3.88
Search Page URL

Determines the The URL that for the text entered in the search field will be entered into to conduct the search.NB: search function.

NOTE - Changing this widget option is not recommended

Default is: /searchAll
Show Product Image?Determines whether a thumbnail image is included in the product search suggestions drop-downdropdown.

Default is: disabled

Tick Toggle to enable

3.89
Show Product Code?

Determines whether the product code is appended to the description in the suggestions drop-downdropdown.

Note NOTE - this 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 Toggle to enable

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

Default is: disabled

Tick Toggle to enable

3.89
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.png4.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 Toggle 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 Toggle 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 Place HolderThis is the text that will appear Text displayed in the search bar as free text, and will disappear after the user has clicked in the fieldto prompt the user to enter search terms.Default is: Product SearchAll
Search Prior PurchasesThe prompt text that appears Text displayed next to the prior purchase search option (where Prior Purchase is enabled).Default is: Prior Purchase Search3.88
Search User Favourites Text  The prompt text that appears Text displayed next to the user favourites search option (where Search Favourites is enabled).Default is: User Favourites Search4.03

...



Related help

Content by Label
showLabelsfalse
spacesKB
showSpacefalse
sortcreation
excerpttrue
reversetrue
excerptTypeexcludeCurrentsimpletrue
operatorAND
cqllabel = "cms" and label = "widgetproduct-search" and space = "KB"
labelswidget cms

...