Extensibility options through custom scripts

Custom event hooks use the browser-native CustomEvent API. Events are dispatched on the window object and can be received with standard window.addEventListener calls.

Events use this naming convention: {widgetPrefix}:{category}:{action}

Custom events are disabled by default. To enable events, define the RhythmExtensibilityConfig object on the window before the widget initializes.

No events fire unless explicitly enabled. When no configuration is defined, widget behavior is identical to a standard installation.

For the steps on adding a custom script to a page, see Infor Rhythm Portal Administration Library (Cloud) Administrator > Site Editor Guide > Sites > Configuring Sites > Site Settings > Specifying custom scripts to a page.

window.RhythmExtensibilityConfig = {
 enabledEvents: ['miniCart:panel:beforeOpen', 'shoppingCart:orderline:*']
};

You can use wildcard patterns to enable multiple events.

To listen to a custom event, use window.addEventListener with the event name.

All event data is available in event.detail.data.

window.addEventListener('miniCart:cart:afterUpdate', function(event) {
var data = event.detail.data;
 // data.totalQuantity
 // data.totalPrice
 // data.orderLines
 });

To cancel a blocking event, call event.preventDefault() in the listener.

When a blocking event is cancelled: - The underlying action does not execute. - The widget resets to its previous visual state. Buttons are re-enabled and spinners are hidden.

window.addEventListener('shoppingCart:orderline:beforeDelete', function(event) {
  var itemNumber = event.detail.data.itemNumber;
  if (isCriticalItem(itemNumber)) {
    event.preventDefault();
  }
});

If multiple listeners are registered for the same blocking event, any single listener calling event.preventDefault() cancels the action.

For blocking events, you can modify properties of event.detail.data to change the values used by the subsequent action.

window.addEventListener('shoppingCart:template:beforeSave', function(event) {
  var timestamp = new Date().toISOString().slice(0, 10);
  event.detail.data.templateName = event.detail.data.templateName + ' (' + timestamp + ')';
});

In this example, the listener appends the current date to the template name before it is saved. The modified value is used in the save request.

The extensibility framework guarantees fault isolation. If a listener throws an error, the error is caught and logged as a console warning. The widget action proceeds normally.

A faulty listener cannot crash the widget or prevent the user from completing their task.

This table shows the custom events available on the Mini Cart widget: