Widgets

Widget templates 

In the widgets module, you can choose and customise template formats to showcase your metrics, actuals and equivalencies in. This widget is what ultimately gets configured on your website. 

Adding a widget template: 

• To add a widget, click on ‘add new’

• You can then choose from two types of templates - impact and eco contributions. 

Note: Eco contribution templates are only visible for offset clients.

• You can also choose the category of templates which includes - product, company summary, cart, customer summary, order summary, calculator templates. 

• Once you have selected the widget template the custom style, default configurations, query parameters and allowable configurations are pre filled for you. However you can modify these specifications based on your preferences. 

Note: You can also refer to the widget integration documentation attached to configure each element by clicking on the icon.  

• The preview section on the right allows you to preview your final template after modifications. 

  • To preview actual/equivalence values for another product, you can use the product dropdown to select the product of your choice. 

  • To preview the template for another language, you can use the language dropdown to select another language configured for your store. 

  • To preview your template across different devices, use the select screen size option bar to choose across desktop, laptop, tablet, smartphone

• Once you have modified all the parameters, you can save or publish. Saving will save this template as a draft and publishing will publish the template which you can then integrate with a store. 

• You can integrate a published template with a store from the widget list screen by clicking on ‘integrate with store’ and choosing the store name and publishable key 
  

  • 

  • Store name: The list of available stores you have configured in the stores module appears here. Choosing a store implies that you wish to integrate this widget template with the chosen store. The widget will then begin to appear on the store. 

  • Publishable key: You can create your publishable key in Settings - Integrations - API keys. 

  • Enable/disable toggle: Allows you to enable or disable the template integration with the particular store. If it is disabled, the template will stop appearing on the store. 

Store integration 

You can modify store integrations in the store integration section. Only once a widget is integrated to a  store it will begin to render on your website. Here, each store is organised into different tabs. 

Actions:

• Preview: Preview the particular template for each store. Here, you can change the product in the product dropdown to view values across different products in that store. You can also change the language to preview the template across different languages the store is configured in. 

• Edit: You can only edit the publishable key for the store. You can also enable/disable the integration

• View embed code: With the embed code, you can integrate the widget into your website. 

• Remove integration: This removes the integration of the template with the store. Once this is done, the template can be reintegrated from the widget list screen with the ‘integrate with store’ option.