Configure the Common Options tab in custom widgets.


Common Options Tab for Custom Widgets


Enable your custom widgets to include the Common Options tab, ensuring consistency in widget configuration. The Common Options tab allows you to control the devices on which your widget displays, set alignment and print parameters, and add additional style classes.


Step-by-step guide

  1. In the CMS, navigate to Advanced Content → Custom Widgets.

  2. Click Edit next to a widget that is in use (depicted by Used n time indicator in the In Use? column).


  3. If we look at the DashboardBackOrders custom widget, then we see that the Include Common Options parameter is OFF.



  4. You can check where that widget is used by clicking Options → Where is it used?



  5. Click the Template directly from the Where is this widget used? pop-up, or navigate to the page location: Content → Pages & Templates → Accounts → Dashboard Page

  6. Find the widget in the Page Template and click Edit.



  7. You can see that there are only two tabs: General Options and Personalisation.



  8. View the HTML code (Chrome: Inspect; Firefox: Inspect Element). Take note of the lines between the  highlighted line:<div class="content-box dashboard-module dashboard-back-orders"...> and the <header class="box-title"... "Back Orders" </header>.



  9. Exit out of the widget and head back to the DashboardBackOrders custom widget by clicking Options and selecting <>View Source Code or navigating to Advanced Content → Custom Widgets.



  10. Click Edit on the DashboardBackOrders widget, and this time, toggle Include 'Common Options' to ON.

  11. Save your changes and return to Content → Pages & Templates → Accounts → Dashboard Page.
  12. Edit the DashboardBackOrders widget and click on the Common Options tab.



  13. You will see all the options available on the Common Options tab that is available on all non-Custom widgets.

  14. View the HTML code (Chrome: Inspect; Firefox: Inspect Element).

    Note the addition of the '<div>' tag for the Dashboard Back Order Custom Widget surrounding the <div class="content-box dashboard-module dashboard-back-orders"...> and the <header class="box-title"... "Back Orders" </header> highlighted in the pre-enabled view.



  15. To test it, edit the CUSTOM:DashboardBackOrders widget again and toggle Show On Mobile? to OFF.



  16. Save your changes and notice the difference to the widget.


You can read more about the device icon display in the Widget Device Display Indication: Mobile, Tablet, and Desktop help page.


Additional Information

Contact CV Support if you have any questions or issues enabling this option.



Minimum Version Requirements


4.15.00


Prerequisites


--


Self Configurable


Yes


Business Function


Behaviour & Personalisation


BPD Only?


Yes


B2B/B2C/Both


Both


Third Party Costs


n/a or Fees apply



Related help

Related articles appear here based on the labels you select. Click to edit the macro and add or change labels.


Macro Instructions for carrying Article Information through to Feature List

Minimum

Version

Requirements

BPD

ONLY


Business Function

CMS Category

B2B
B2C

BOTH

Feature

Feature Description

(Written for our customers and can be pasted into comms sent to them)

Additional info

Pre-Reqs/
Gotchas

Self Configurable

Ballpark Hours
From CV

(if opting for CV to complete self config component)

Ballpark Hours
From CV

(in addition to any self config required)

Third Party Costs

Instructions for carrying Excerpts through from this page to the Feature List

Article Page:

Add macro  / Multiexcerpt (or copy and existing excerpt and edit) or (Copy existing page and place content into existing excerpt macros)

On Features List page:

Click in the Cell to be populated  / add macro /  Multiexcerpt Include / Select the Article page and the excerpt (or copy another feature line and edit the 'Article page' source.