Widget Use
Displays an input box and search button, allowing the user to conduct product searches.
Example of Widget Use
Where can the Widget be placed?
The widget can be used in the following templates:
- All Templates
Widget Options
| Option | Use | Comments | Available 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 |
| Use Suggestions? | 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 | All |
| Use Product and Search Suggestions? | 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 | All |
| 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: unticked Tick 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. Note: Changing this widget option is not recommended | Default is: /search | All |
| Show Product Image? | Determines whether the image is included in the product search suggestions drop-down. | Default is: unticked Tick to enable | 3.89 |
| Show Product Code? | Determines whether the product code is included in the product search suggestions drop-down. | Default is: unticked Tick to enable | 3.89 |
| Show APN Instead Of Product Code | Determines whether the Australian Product Number is displayed in lieu of the product code. | Default is: unticked Tick to enable | 3.89 |
| Prompts | |||
| Search Place Holder | This is the text that will appear in the search bar as free text, and will disappear after the user has clicked in the field. | Default is: Product Search | All |
| Search Only Prior Purchases | The prompt text that appears next to the prior purchase search option (where Prior Purchase is enabled). | Default is: Prior Purchase Search | 3.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
-
Order Payment Links Form Widget — Renders an order details stepper with an order form that can be automatically populated with query strings, and/or manually entered by the user. The form doesn't validate the order details are accurate in order to stay both secure and accessible to unauthenticated users.
-
Magic Link Authentication Message Widget — Renders the Magic Link authentication message.
-
CUSTOM_Side by Side Content Tiles Widget — Renders two side by side content tiles in a zone with widget options for selecting or adding background colour, image, text and link/button positioning.
-
Stock Dialog Widget — Displays the Stock to Receive Detail dialog window.
-
Stock to Receive Widget — Displays the Stock to Receive page.
-
Stock Levels Widget — Displays Stock Levels page.
-
Order Declined Pending 3rd Party Installment Msg Widget — Renders the message body for the email sent when the user selects to sign up and pay with a Buy Now Pay Later provider but approval is subject to further checks.
-
Order Field Static Widget — Renders an additional order field in email templates.
-
Online Quote Validation Widget — Renders the appropriate message to the user after the current status of an online quote accessed via an email link is validated.
-
Header Level Cost Centre Widget — Renders the cost centre input field on the order header in the shopping cart.
-
Openpay Summary Widget — Renders Openpay marketing information for a product on the product detail page. Use this widget instead of the Product Purchase Details widget if you want to customise tagline placement on the template.
-
Order Line Availability - Click and Collect Widget — Displays product availability and delivery methods at the order line level in dynamic scenarios such as the cart when Click & Collect is enabled.
-
Account Activation Email Content Widget — Renders the message content in the Invitation to Register an Account email.
-
Order Template Cost Centre Widget — Renders the cost centre input field on each product line in an order template.
-
BPAY Account Payment Detail Widget — Renders BPAY payment information in the body of the BPAY Account Payment email. This email is sent to users who pay invoices or pay down their account balance using BPAY.
