Versions Compared

Old Version 7

changes.mady.by.user user-b683f

Saved on

compared with

New Version Current

changes.mady.by.user Documenter

Saved on

Key

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

Widget Use

Excerpt

Displays an input box and search button, allowing Renders the standard search tool that allows the user to conduct product searchessearch products and/or content. Displaying product suggestions is optional.

 


Example of Widget Use

...

Product Search with placeholder textProduct Search with product suggestions

Image Added

Image Added


Where can the Widget be placed?

The widget can be used in the following templates:

  • All Templates
  • Required: Theme Layout Template


Implementation guides

Widget Options

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

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

Include Static Content Search: Searches both products and static content that match the keyword(s).

Static Content Search Only: Searches products only. 

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

Default: disabled


4.14.00
Use Suggestions?
When this option is enabled, suggested search terms will be

Determines whether suggested searches are offered to the user

,

. These are based on previously entered (successful) search terms over a defined period.

Image Added

Default

is

:

ticked

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

, based on their search terms

. They can

highlight and select any of the suggestions,

click a suggested product to be redirected to

the

its detail page

for the selected product

.

These suggestions are based on Lucene index data.

Image Added

Default

is

:

ticked

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 site
all available products).

Default

is

:

unticked

disabled

Tick Note:

Toggle to enable

3.88
Search Page URL

Determines the URL that the text entered in the search field will be entered into to conduct the search.

The URL for the search function.

NOTE - Changing this widget option is not recommended

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

Default

is

:

unticked

disabled

Tick

Toggle to enable

3.89
Show Product Code?

Determines whether the product code is

included

appended to the description in the suggestions dropdown.

NOTE - This option is only compatible with product

search suggestions drop-down

suggestions ('Use Product Suggestions?' option). Product codes do not show against search suggestions ('Use Suggestions?' option).

Default

is

:

unticked

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

:

unticked

disabled

Tick

Toggle to enable

3.89
Place Holder ImageThe file path for the fallback image used for products with no image found.Default: /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.

Default: enabled

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: enabled

Toggle to disable

4.03
Titles
Product Suggestions Heading TextThe heading displayed above suggested products (when "Show Product Suggestions Heading" option is enabled).Default: Product Suggestions4.03
Search Suggestions Heading TextThe heading displayed above suggested search terms (when "Show Search Suggestions Heading" option is enabled).Default: Search Suggestions4.03
Buttons
Search Button TextThe text displayed on the search button.Default: Search4.03
Prompts
Search Place Holder
This 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 field
to prompt the user to enter search terms.Default
is
: Product SearchAll
Search
Only
Prior Purchases
The prompt text that appears
Text displayed next to the prior purchase search option (where Prior Purchase is enabled).Default
is
: Prior Purchase Search3.88
Show On Mobile?Determines whether the widget is displayed on a mobile device. If unticked, page totals will be hidden on mobile devices.

Default is: ticked

Untick to disable

All

 

 

Other Widgets

Search User Favourites Text  Text displayed next to the user favourites search option (where Search Favourites is enabled).Default: 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

...