Widget Use
Renders filter options for Contract items at the top of a product list (e.g. search results, favourites, category display). B2B users can elect to view only their contract products, non-contract products, or all products.
Example of Widget Use
Following is an example of the widget in use:
Where can the Widget be placed?
The widget can be used in the following templates:
- Product List Template
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 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 |
| Buttons | |||
| Display All Items Button Text | The label on the button displayed when the user is viewing only contract or non-contract items. | Default is: Display All Items | 3.88 |
| Display Contract Items Button Text | The label on the button to view only contract items. | Default is: Display Contract Items | 3.88 |
| Display Non Contract Items Button Text | The label on the button to view only non-contract items. | Default is: Display Non Contract Items | 3.88 |
| Prompts | |||
| Currently Displaying All Items Prompt | The message text to indicate all products are being displayed. | Default is: <p>Currently displaying all items.</p><p>To display contract items only, <a href="ItemFilter=Contract">Click Here</a><br/>To display non contract items only, <a href="ItemFilter=Noncontract">Click Here</a></p> | 3.88 |
| Currently Displaying Contract Items Prompt | Default is: <p>Currently displaying contract items only.</p><p>To display all items, <a href="#">Click Here</a><br/>To display non contract items only, <a href="?ItemFilter=Noncontract">Click Here</a></p> | 3.88 | |
| Currently Displaying Non Contract Items Prompt | Default is: <p>Currently displaying non contract items only.</p><p>To display all items, <a href="#">Click Here</a><br/>To display contract items only, <a href="?ItemFilter=Contract">Click Here</a></p> | 3.88 | |
Implementation note - this widget will not render for Roles that do not have the following flags enabled:
- Filter Contract Items
- Filter Non Contract Items
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.
