@groupby/elements-dom-events-plugin

GroupBy Elements DOM Events Plugin

This package contains the GB Elements DomEventsPlugin class.

Usage

To use the DomEventsPlugin, first instantiate it and then register it with the Core entity:

const domEventsPlugin = new DomEventsPlugin(/* options */);
core.register(domEventsPlugin);

The plugin's constructor takes an optional options object. Please refer to the DomEventsPluginOptions interface in src/dom-events-plugin.ts for more details on available options.

Methods

registerListener()

Use the registerListener method to register event listeners. The method takes an eventName and a callback function.

registerListener(eventName, callback);

unregisterListener()

Use the unregisterListener method to unregister event listeners. The method takes an eventName and a callback function.

unregisterListener(eventName, callback);

dispatchEvent()

Use the dispatchEvent method to dispatch events. The method takes an eventName and an option payload which can be used to send information with the dispatched event.

dispatchEvent(eventName, payload);

Changelog

[0.1.0] - 2019-11-28

Package versions:

• @groupby/elements-cache-driver-plugin: 0.1.0
• @groupby/elements-cache-plugin: 0.1.0
• @groupby/elements-core: 0.1.0
• @groupby/elements-dom-events-plugin: 0.1.0
• @groupby/elements-sayt-driver-plugin: 0.1.0
• @groupby/elements-sayt-plugin: 0.1.0
• @groupby/elements-search-driver-plugin: 0.1.0
• @groupby/elements-search-plugin: 0.1.0

Added

cache-driver-plugin

• SFX-158: Added the CacheDriverPlugin module.

cache-plugin

• SFX-158: Added the CachePlugin module.

core

• SFX-99: Added the Core module and related plugin interfaces.
  • The Core module manages the registration and unregistration of plugins.

dom-events-plugin

• SFX-157: Added the DomEventsPlugin module.

sayt-driver-plugin

• SFX-160: Added the SaytDriverPlugin module.
  • The SaytDriverPlugin module acts as a mediator between the Logic and View layers for prebuilt modules.
  • SFX-248: The @groupby/elements-events package is used for event names and payload interfaces.
  • SFX-333: Added retrieval and event emission of products.
  • SFX-385: Added the option to supply a custom product transformer.

sayt-plugin

• SFX-156: Added the SaytPlugin module.
  • It exposes an instance of the Sayt client library to Core.

search-driver-plugin

• SFX-159: Added the SearchDriverPlugin module.
  • This plugin listens for a SEARCH_REQUEST_EVENT event, makes a search request using the GroupBy API, then dispatches a SEARCH_RESPONSE_EVENT event containing the response.
  • SFX-248: The @groupby/elements-events package is used for event names and payload interfaces.

search-plugin

• SFX-155: Added the SearchDataSourcePlugin module.
  • It exposes an instance of the BrowserBridge from the Search api client library to Core.