Widget Use
| Excerpt |
|---|
Inserts a product search widget and Renders the standard search tool that allows the user to conduct product searches. |
...
search products and/or content. Displaying product suggestions is optional. |
Example of Widget Use
...
| Product Search with placeholder text | Product Search with product suggestions |
|---|---|
|
|
Where can the Widget be placed?
The widget can be used in the following templates:
- All Templates
- Required: Theme Layout Template
- All other Templates
Implementation guides
Widget Options
| Option | Use | Comments | Available from Version |
|---|---|---|---|
| Description | A 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 | |
| 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 |
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 |
When this option is marked true, the search bar will act normally and return result when the user presses enter or clicks on the search button.
Note: Turning off this option is not recommended as it will break the styling and functionality of the widget
Default is: ticked
Untick to disable
When this option is marked true, entering text into the search field will cause suggested products to appear as a drop down from the text field.
Note: Enabling this option will automatically set 'Use Search Suggestions' to true
Default is: ticked
Untick to disable
Determines the URL that the text entered in the search field will be entered into to conduct the search.
| 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? | Determines whether suggested searches are offered to the user. These are based on previously entered (successful) search terms over a defined period.
| Default: enabled Toggle to disable | All |
| Use Product Suggestions? | Determines whether the user is offered suggested products in a dropdown. They can click a suggested product to be redirected to its detail page. These suggestions are based on Lucene index data. | Default: enabled Toggle to disable | All |
| Use Prior Purchase? | Determines whether the user can choose to search from only their prior purchases (rather than all available products). | Default: disabled Toggle to enable | 3.88 |
| Search Page URL | The URL for the search function. NOTE - Changing this widget option is not recommended | Default |
| : /search |
Default is: ticked
Untick to disable
...
| All | |||
| Show Product Image? | Determines whether a thumbnail image is included in the product search suggestions dropdown. | Default: disabled Toggle to enable | 3.89 |
| 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: disabled Toggle to enable | 3.89 |
| Show APN Instead Of Product Code | Determines whether the Australian Product Number is displayed instead of the product code. | Default: disabled Toggle to enable | 3.89 |
| Place Holder Image | The file path for the fallback image used for products with no image found. | Default: /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. | 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 Text | The heading displayed above suggested products (when "Show Product Suggestions Heading" option is enabled). | Default: Product Suggestions | 4.03 |
| Search Suggestions Heading Text | The heading displayed above suggested search terms (when "Show Search Suggestions Heading" option is enabled). | Default: Search Suggestions | 4.03 |
| Buttons | |||
| Search Button Text | The text displayed on the search button. | Default: Search | 4.03 |
| Prompts | |||
| Search Place Holder | Text displayed in the search bar to prompt the user to enter search terms. | Default: Product Search | All |
| Search Prior Purchases | Text displayed next to the prior purchase search option (where Prior Purchase is enabled). | Default: Prior Purchase Search | 3.88 |
| Search User Favourites Text | Text displayed next to the user favourites search option (where Search Favourites is enabled). | Default: User Favourites Search | 4.03 |
Related help
| Content by Label | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|