The Events SDK provides methods for interacting with widget events, including registering listeners, triggering events, and querying emitted or registered events.
Use this SDK to add event listeners, trigger custom or built-in events, and inspect the event lifecycle for a widget placement.
Allows the addition of event listeners to the widget
Example
// Listen for the 'loadMore' event on all .load-more buttons sdk.addEventListener('loadMore', (event) =>console.log(event), document.querySelectorAll('.load-more')); // Listen for a custom event globally sdk.addEventListener('customEvent', (event) =>alert(event));
getEmittedEvents
getEmittedEvents:()=>string[]
Type declaration
():string[]
Returns string[]
returns ['moreLoad', 'lessLoad']
Remarks
Returns the list of events that have been emitted
Example
// Get all emitted events for this widget constevents = sdk.getEmittedEvents(); events.forEach(e=>console.log(e));
getRegisteredEvents
getRegisteredEvents:()=>string[]
Remarks
Returns the list of events that have been registered
Example
// List all registered event types constregistered = sdk.getRegisteredEvents(); registered.forEach(e=>console.log(e));
loadMore
loadMore:()=>Promise<void>
Type declaration
():Promise<void>
Returns Promise<void>
void
Remarks
Loads more tiles
Example
// Programmatically load more tiles awaitsdk.loadMore();
Allows particular events to be triggered to operate when a listener is called
Example
// Trigger the 'loadMore' event with custom data sdk.triggerEvent('loadMore', { page:2 }); // Trigger a custom event with a scope sdk.triggerEvent('customEvent', { foo:'bar' }, 'myScope');
Remarks
The Events SDK provides methods for interacting with widget events, including registering listeners, triggering events, and querying emitted or registered events. Use this SDK to add event listeners, trigger custom or built-in events, and inspect the event lifecycle for a widget placement.